README.rst

FD Django Accounts

Reusable Django app to replace the default Django user (account) model.

Documentation

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

Status

Quickstart

Install FD Django Accounts:

pip install fyndata-django-accounts

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'django.contrib.auth',  # Required by 'fd_dj_accounts'.
    'django.contrib.contenttypes',  # Required by 'django.contrib.auth'.
    ...
    'fd_dj_accounts',
    ...
)

Set the following Django standard settings:

AUTHENTICATION_BACKENDS = [
    'fd_dj_accounts.auth_backends.AuthUserModelAuthBackend',
]
AUTH_USER_MODEL = 'fd_dj_accounts.User'

and the following settings created by this app:

APP_ACCOUNTS_SYSTEM_USERNAME = 'accounts-system-user@localhost'  # arbitrary value

Features

• TODO

Developers

See 'CONTRIBUTING.rst'.

Tests

Requirements:

make install-dev

Run test suite for all supported Python versions and run tools for code style analysis, static type check, etc:

make test-all
make lint

(same as above, but with Docker Compose):

make docker-compose-run-test

Check code coverage of tests:

make test-coverage
make test-coverage-report-console

Credits

Tools used in rendering this package:

• Cookiecutter
• cookiecutter-djangopackage