The project should be installed in a virtualenv in editable mode. The
dev requirements can be installed from requirements/dev.txt
. If you
already have nox and pre-commit installed globally, you can skip
the dev requirements.
$ pip install -e . -r requirements/dev.txt
Install pre-commit hooks to automatically format and lint code when committing. Otherwise any issues will be caught in CI once your PR is submitted.
$ pre-commit install
$ git commit
Run nox to run tests for all Python versions, style checks, and docs build. These all run during CI as well.
$ nox
Run pytest to run the tests for the current Python environment only.
$ pytest