Support for keybase proofs in Django
Project description
django-keybase-proofs
keybase-proofs
is a Django application and reference implementation for
integrating Keybase proofs into a web app.. If you are looking to integrate
Keybase proofs into your application and you use Django, you can use this as a
drop-in library. Otherwise, you can run the server
locally or checkout the code to see how to
build your own integration. You can read the full integration
documentation for all of the required
steps to integrate with Keybase.
The library supports Django 1.11 to Django 2.1 across Python versions 2.7 to 3.7. If you would like to see a feature or find a bug, please let us know by opening an issue or pull request.
Integrate with an existing django application
To install:
pip install keybase-proofs
Add keybase_proofs
to settings.py's INSTALLED_APPS
:
INSTALLED_APPS = (
# ...other installed applications...
'keybase_proofs',
)
Add url(r'^keybase_proofs/', include('keybase_proofs.urls')),
to your main
urls.py
You can copy the example templates in keybase_proofs/templates/
to customize
and style as necessary. Checkout the remaining
steps to integrate
and submit your configuration to Keybase.
Exploring the example service
If you are building a Keybase proof integration but don't use Django, you can still use this package as an reference implementation. Using the instructions below you can run the server locally to see expected behavior/responses you should implement.
First install the required python packages with:
# install basic python requirements, a virtualenv is recommended.
make installdeps
# Run the example `test_app` server
make run
When running the test server you can play around with posting proofs/reading the API. The test server does not have any authentication mechanism. Any username you submit on the login form will be authenticated and can post a proof.
Verifying the integration
While integrating you can use the verification script to help manually verify the correctness your integration.
Development tips
You can run tests by running:
make test
To release to pypi:
TAG_NAME="XXX"
make release TAG_NAME=$TAG_NAME
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for django_keybase_proofs-0.0.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cdf3d29efab8555396c5ba4ed1e7e08eb3af2279dcc10455ebb79194a82832de |
|
MD5 | d69f2862366e37bc3ef38b6dc8042e33 |
|
BLAKE2b-256 | 322e885a2d1cde15dcf1e9e581c1605f240fe9283ceaa1ec84d2b152a6543c74 |