Django pin authentication

Django pin based authentication

Documentation

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

Quickstart

Install Django pin authentication:

pip install django-pin-auth

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'django_pin_auth.apps.DjangoPinAuthConfig',
    ...
)

Add Django pin authentication's URL patterns:

from django_pin_auth import urls as django_pin_auth_urls


urlpatterns = [
    ...
    url(r'^pinauth', include(django_pin_auth_urls, namespace='django_pin_auth')),
    ...
]

Requirements

You must have sessions enabled.

Development

You can get an environment with a dev project set up very quickly with Docker:

export COMPOSE_FILE=dev.yml
docker-compose up

If need be, you can modify the environment variables as declared in the .env file

Features

• TODO

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Credits

Tools used in rendering this package:

• Cookiecutter
• cookiecutter-djangopackage