Development¶
To improve code quality, we use nox to run linters, type checkers, unit tests, documentation and more. We recommend installing nox using pipx to have it available globally.
# install
python -m pip install pipx
python -m pipx install nox
# run all sessions
nox
# list all sessions
nox -l
# run individual session
nox -s session_name
# run individual session (reuse install)
nox -Rs session_name
Note that the nox sessions create editable installs. In case there are
issues, try recreating environments by dropping the -R option. If your
project is incompatible with editable installs, adjust the noxfile.py to
disable them.
We also provide a pre-commit config to autoformat code upon commits. It can be set up using the following commands:
Documentation¶
To generate and run the documentation locally