- Python 3.6
- Review and follow the README in the sibling ansible repo.
- Read the contributing guidelines found in CONTRIBUTING.md
- Use flake8 (found in requirements/dev.txt) to lint code.
- Use isort (found in requirements/dev.txt) to automatically sort your imports before commiting. (
isort **/*.py) - Use black (found in requirements/dev.txt) to automatically format your code before comitting. (
black .)
Tests are written and run using pytest. All tests can be found
under the tests directory at the root of the repository.
With the exception of changes to the Django Admin, all code must be accompanied by tests.
- Unit test - Any test that can be performed without touching the database or any network resources.
- Integration test - Any test that does require the use of the database or a network resource.
- Functional test - Currently not in use.
For the full details on all of the available options when running tests refer to the pytest documentation.
Run all the tests
py.test
Run all the tests in a specific file.
py.test tests/path/to/file.py
Run tests whose class name and/or function name match a string
py.test -k some_string
Reuse the database structure between tests (speeds things up)
py.test --reuse-db
All changes to the Django API must be reflected in the API documentation.
The API documentation is built using middleman and is located under the apidocs directory. All documentation is written in asciidoctor format.
See apidocs/README.md for more info.
Examples
./manage.py generate_uml
./manage.py generate_uml --library pydot --format pdf
./manage.py generate_uml --library pydot --apps users --format svg
./manage.py generate_uml --library pydot --apps users --models User --format png
./manage.py generate_uml --library pydot --apps users --models User UserReferral --format dot
To see available options run
./manage.py generate_uml --help
Recommend using GraphvizOnline with output of .dot file for editing