Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dethos/django-cryptolock

Authentication using cryptocurrency wallets for Django projects
https://github.com/dethos/django-cryptolock

authentication bitcoin bitid cryptocurrency-tools cryptolock django hacktoberfest monero

Last synced: about 2 months ago
JSON representation

Authentication using cryptocurrency wallets for Django projects

Awesome Lists containing this project

README

        

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

**DISCLAIMER: This project is no longer maintained. Feel free to fork. The
PyPI package will remain available, but any user's should replace it as soon
as possible.**

Authentication using cryptocurrency wallets for Django projects.

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

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

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 = ""
DJCL_MONERO_WALLET_RPC_HOST = ":"
DJCL_MONERO_WALLET_RPC_USER = ""
DJCL_MONERO_WALLET_RPC_PASS = ""

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](#documentation).