CONTRIBUTING.md

Setting up for development

• Ensure that python3 points to a version of python >= 3.8 (python3 --version will tell you). If it does not, use pyenv to both install a recent python version and make it your current python.

• There are two wrappers (poetryw and toxw) that install and run the correct versions of poetry and tox for you.

• Run poetry to install dependencies:

./poetryw install

• Run the development version of hunter using poetry:

./poetryw run hunter ...

See the poetry docs for more.

Running tests

./poetryw run pytest

...or using tox:

./toxw

Linting and formatting

Code-style is enforced using black and flake8; import optimisation is handled by isort and autoflake. Linting is automatically applied when tox runs tests; if linting fails, you can fix trivial problems with:

./toxw -e format

Build a docker image

./toxw -e docker-build