...
Install pinned development dependencies using:
pip install -r requirements.txt
If you are using Conda to manage your Python environments:
conda env create -f environment.yml
Alternatively, if you are using an existing environment, you can install the module in editable mode, which includes only minimal dependencies:
pip install -e .
In order to use pre-commit hooks, they need to be registered:
pre-commit install
It is a good practice to manually invoke hooks after installation, just in case:
pre-commit run --all-files
Unit tests (using pytest) are not executed as a pre-commit hook, to keep the overhead to a minimum. Instead, a CI/CD pipeline is configured to run tests after each commit. You can also execute them locally, manually:
pytest
By default, mypy is not executed automatically. You can however run them manually:
mypy src