CONTRIBUTING.md

Run tests

pip install -r requirements.txt
pytest # run tests
tox # run test matrix

Run tests with pyenv with specific python and pypy

pyenv install 3.10-dev pypy3.7-7.3.5
pyenv local 3.10-dev pypy3.7-7.3.5
pip install -r requirements.txt
tox -e py310,pypy3

Type checks

tox -e type

Lint code

tox -e qa

Before commit

Install git hook

pip install -r requirements.txt

pre-commit install

For pycharm needs install tox to global

Docs

pip install -r requirements.txt
cd docs
make html