Formal Identity Propagation Demo w/ Django integration

This is Formal's Django integration for propagating end-user identities through the time of database access. This ia made possible as the Formal SQL commenter package adds a database instrumentation that adds a SQL comment to each database query.

See the Formal SQL commenter package here.

Don't hesitate to ping us here at Formal with any questions!

---

Running this demo

• Clone
• Add appropriate db credentials with .env file in root of project
• Create a virtualenv
• $ pip3 install -r requirements/base.txt
• $ export DJANGO_READ_DOT_ENV_FILE=True
  • See https://cookiecutter-django.readthedocs.io/en/latest/developing-locally.html
• $ python3 manage.py migrate
• $ python3 manage.py runserver

---

Cookiecutter boilerplate instructions below

Settings

Moved to settings.

Basic Commands

Setting Up Your Users

• To create a normal user account, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.

• To create a superuser account, use this command:

  $ python manage.py createsuperuser
  

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

Type checks

Running type checks with mypy:

$ mypy backoffice_demo_django

Test coverage

To run the tests, check your test coverage, and generate an HTML coverage report:

$ coverage run -m pytest
$ coverage html
$ open htmlcov/index.html

Running tests with pytest

$ pytest

Live reloading and Sass CSS compilation

Moved to Live reloading and SASS compilation.

Deployment

The following details how to deploy this application.