Development

Guides for local development, testing, tooling, and documentation.

Run the application

python manage.py runserver

Run tests and coverage

coverage run -m pytest
coverage report -m

Linting and code style

flake8

Database and migrations

python manage.py makemigrations
python manage.py migrate

Static files

Static assets are served from static/ in development. In production, files are collected to staticfiles/ and served by WhiteNoise.

Build and view documentation (Sphinx)

# From the repository root
pip install -r docs/requirements.txt
sphinx-build -b html docs docs/_build/html
# Then open docs/_build/html/index.html in your browser

Additional guides