Contributing

Setup Development Environment

Install poetry

$ curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
$ source $HOME/.poetry/env

set python versions

$ pyenv local 3.8.2 3.7.6

Install nox

$ pipx install nox

Install pre-commit hooks

$ pipx install pre-commit
$ pre-commit install

Useful Stuff

• Install dependencies

$ poetry install

• Run the tests

$ nox -rs tests

• Run the tests for a single python version

$ nox -r --session tests-3.8

• Run the linter

$ nox -rs lint

• Run the linter for a single python version,

$ nox -r --sesion lint-3.8

• Build the docs

$ nox -rs docs

• Add standard dependency

$ poetry add <package-name>

• Add development dependency:

$ poetry add --dev <package-name>