django-ontruck

Django extended by Ontruck-ers

Documentation

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

Quickstart

Install django-ontruck:

pip install django-ontruck

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'django_ontruck',
    ...
)

Features

• Use cases
• Events
• Queries
• Models
• Views
• Testing
• Commands

Running Tests

Does the code actually work?

Prepare test env

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install -r requirements_test.txt

Run tests

(myenv) $ make test

Run tests in several python versions using tox

(myenv) $ make test-all

Run tests getting code coverage

(myenv) $ make coverage

Generate documentation

(myenv) $ pip install -r requirements_dev.txt
(myenv) $ make docs