dethos
/
django-cryptolock
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Authentication using cryptocurrency wallets for Django projects
50 Commits 3 Branches 3 Tags 360 KiB
Python 91.5%
HTML 6.1%
Makefile 2.4%
Go to file
Gonçalo Valério 6a2201ca95 bumb version 2020-03-31 18:42:47 +01:00
.github Initial commit. Cookiecutter based project structure 2019-09-24 18:02:54 +01:00
django_cryptolock bumb version 2020-03-31 18:42:47 +01:00
docs update documentation 2020-03-31 18:37:34 +01:00
example first working prototype of bitid 2020-03-10 15:00:11 +00:00
tests fix code format issues 2020-03-31 14:06:23 +01:00
.coveragerc Initial commit. Cookiecutter based project structure 2019-09-24 18:02:54 +01:00
.editorconfig Initial commit. Cookiecutter based project structure 2019-09-24 18:02:54 +01:00
.gitignore add tests for the current address model and validator 2019-10-15 19:13:39 +01:00
.travis.yml Remove allow failures and black exclusions. 2020-01-28 17:24:59 +01:00
AUTHORS.rst update changelog and contributors list 2020-01-28 16:46:52 +00:00
CONTRIBUTING.rst update documentation 2020-03-31 18:37:34 +01:00
HISTORY.rst bumb version 2020-03-31 18:42:47 +01:00
LICENSE Initial commit. Cookiecutter based project structure 2019-09-24 18:02:54 +01:00
MANIFEST.in Add first implementation of the authentication backend 2019-10-15 17:45:18 +01:00
Makefile update quickstart guide 2019-12-01 00:07:03 +00:00
README.rst update documentation 2020-03-31 18:37:34 +01:00
manage.py Initial commit. Cookiecutter based project structure 2019-09-24 18:02:54 +01:00
pytest.ini use pytest for testing 2019-10-15 18:13:56 +01:00
requirements.txt removed unused dependency: python-bitcoinaddress 2020-02-19 18:14:25 +00:00
requirements_dev.txt update quickstart guide 2019-12-01 00:07:03 +00:00
requirements_test.txt update requirements to avoid double dependency problem on the CI 2020-01-06 18:40:32 +00:00
setup.cfg bumb version 2020-03-31 18:42:47 +01:00
setup.py update requirements to avoid double dependency problem on the CI 2020-01-06 18:40:32 +00:00
tox.ini update requirements to avoid double dependency problem on the CI 2020-01-06 18:40:32 +00:00

README.rst 

=============================
Django-Cryptolock
=============================

.. image:: https://badge.fury.io/py/django-cryptolock.svg
    :target: https://badge.fury.io/py/django-cryptolock

.. image:: https://travis-ci.org/dethos/django-cryptolock.svg?branch=master
    :target: https://travis-ci.org/dethos/django-cryptolock

.. image:: https://coveralls.io/repos/github/dethos/django-cryptolock/badge.svg
    :target: https://coveralls.io/github/dethos/django-cryptolock

Authenticatio using cryptocurrency wallets for Django projects

This package provided a django app containing a set of utilities to make easier to
implement the BitId and Monero Cryptolock authentication "protocols".

Future releases might include other cryptocurrencies but for the being
(until we reach some stability) the focus will continue BTC and XMR.

**DISCLAIMER:** This package is still in an early stage of development. It isn't meant to be
used on any production scenario yet (in other words, only test projects for now).

Documentation
-------------

The full documentation is at https://django-cryptolock.readthedocs.io.

Quickstart
----------

1. Install Django-Cryptolock::

    pip install django-cryptolock

2. Add it to your `INSTALLED_APPS`:

.. code-block:: python

    INSTALLED_APPS = (
        ...
        'django_cryptolock.apps.DjangoCryptolockConfig',
        ...
    )

3. Migrate your database::

    python manage.py migrate


4. Add the following settings to your project for the Monero Backend:

.. code-block:: python

    AUTHENTICATION_BACKENDS = [
        "django_cryptolock.backends.MoneroAddressBackend",
        ...
    ]
    DJCL_MONERO_NETWORK = "mainnet"
    DJCL_MONERO_WALLET_RPC_PROTOCOL = "<http_or_https>"
    DJCL_MONERO_WALLET_RPC_HOST = "<wallet_rpc_host>:<port>"
    DJCL_MONERO_WALLET_RPC_USER = "<user>"
    DJCL_MONERO_WALLET_RPC_PASS = "<password>"

5. Add Django-Cryptolock's URL patterns:

.. code-block:: python

    from django.conf.urls import url


    urlpatterns = [
        ...
        url(r"^auth/", include("django_cryptolock.urls", namespace="django_cryptolock")),
        ...
    ]

More detailed information can be found in the documentation.

Credits
-------

Tools used in rendering this package:

*  Cookiecutter_
*  `cookiecutter-djangopackage`_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage