Support for keybase proofs in Django
Project description
# django-keybase-proofs
[![PyPI version](https://badge.fury.io/py/keybase-proofs.svg?maxAge=2592000)](https://badge.fury.io/py/keybase-proofs)
[![PyPI](https://img.shields.io/pypi/pyversions/keybase-proofs.svg)](https://pypi.python.org/pypi/keybase-proofs)
[![Travis CI](https://travis-ci.org/macropin/django-registration.svg?branch=master)](https://travis-ci.org/macropin/django-registration)
`keybase-proofs` is a Django application and reference implementation for
keybase proofs, as described here (TODO add url to public spec doc). 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](##exploring-the-example-service) or checkout the code to see how to
build your own integration.
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](https://github.com/keybase/keybase-proofs/issues) or [pull
request](https://github.com/keybase/keybase-proofs/pulls).
## Integrate with an existing django application
To install:
```
pip install keybase-proofs
```
Add `keybase_proofs` to settings.py's `INSTALLED_APPS`:
```python
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.
TODO add instructions or link for submitting app to keybase and generating a config.
## 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.
## Development tips
You can run tests by running:
```
make test
```
To release to pypi:
```
TAG_NAME="XXX"
make release TAG_NAME=$TAG_NAME
```
[![PyPI version](https://badge.fury.io/py/keybase-proofs.svg?maxAge=2592000)](https://badge.fury.io/py/keybase-proofs)
[![PyPI](https://img.shields.io/pypi/pyversions/keybase-proofs.svg)](https://pypi.python.org/pypi/keybase-proofs)
[![Travis CI](https://travis-ci.org/macropin/django-registration.svg?branch=master)](https://travis-ci.org/macropin/django-registration)
`keybase-proofs` is a Django application and reference implementation for
keybase proofs, as described here (TODO add url to public spec doc). 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](##exploring-the-example-service) or checkout the code to see how to
build your own integration.
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](https://github.com/keybase/keybase-proofs/issues) or [pull
request](https://github.com/keybase/keybase-proofs/pulls).
## Integrate with an existing django application
To install:
```
pip install keybase-proofs
```
Add `keybase_proofs` to settings.py's `INSTALLED_APPS`:
```python
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.
TODO add instructions or link for submitting app to keybase and generating a config.
## 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.
## 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
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for django_keybase_proofs-0.0.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 63ec226048c6f7886e0f590c5c553f7e10fc017eddfc5a70f527003c3724bfcf |
|
MD5 | b50b8c2a859f702dc027b02c6a2b3d66 |
|
BLAKE2b-256 | 621a824d3bd403de089c94d29600c56f559d78bbf8b8171e9d90e1c66c2cadff |