Thank you for investing your time in contributing to our project!
Read our Code of Conduct to keep our community approachable and respectable.
The fastest way to start with development is to use nox. If you don't have nox,
you can use pipx run nox to run it without installing, or pipx install nox.
If you don't have pipx (pip for applications), then you can install with
pip install pipx (the only case were installing an application with regular
pip is reasonable). If you use macOS, then pipx and nox are both in brew, use
brew install pipx nox.
To use, run nox. This will lint and test using every installed version of
Python on your system, skipping ones that are not installed. You can also run
specific jobs:
nox -s lint # Lint only
nox -s tests # Python tests
nox -s build # Make an SDist and wheelNox handles everything for you, including setting up an temporary virtual environment for each run.
This way of developing assumes that you're using conda as your environment and package management.
We recommend using the libmamba solver instead of the classic solver,
since the conda create and conda install step could take very long or fail.
See instructions here
for installation and usage.
-
Create conda environment
conda create --yes -n gnatss python=3.10 # use python 3.10 -
Activate and install dependencies
conda activate gnatss pip install -e ".[docs,lint,test]"
You should prepare pre-commit, which will help you by checking that commits pass required checks:
pip install pre-commit # or brew install pre-commit on macOS
pre-commit install # Will install a pre-commit hook into the git repoYou can also/alternatively run pre-commit run (changes only) or
pre-commit run --all-files to check even without installing the hook.
Use pytest to run the unit checks:
pytest -vvv testsUse pytest-cov to generate coverage reports:
pytest --cov=gnatss