Set up nox as the task runner

- base configuration for all nox sessions to come
- add infos about nox in the README file
- ignore [py]cache folders in git
This commit is contained in:
Alexander Hess 2024-09-10 01:21:37 +02:00
commit ceabb00bab
Signed by: alexander
GPG key ID: 344EA5AB10D868E0
3 changed files with 114 additions and 0 deletions

View file

@ -45,6 +45,26 @@ To replicate the project maintainer's develop environment, run:
`poetry install`
### Maintenance Tasks
We use [nox](https://nox.thea.codes/en/stable/) to run
the test suite and other maintenance tasks during development
in isolated environments.
`nox` is similar to the popular [tox](https://tox.readthedocs.io/en/latest/).
It is configured in the
[noxfile.py](https://github.com/webartifex/lalib/blob/main/noxfile.py) file.
`nox` is assumed to be installed as well
and is therefore not a project dependency.
To list all available tasks, called sessions in `nox`, simply run:
`nox --list` or `nox -l` for short
To execute all default tasks, simply invoke:
`nox`
### Branching Strategy
The branches in this repository follow the