Pull requests are welcome!
You can also help by opening an issue if you find any bug.
This package uses the following for development:
| Package | Purpose |
|---|---|
| pytest | Testing |
| vulture | Dead code detection |
| mypy | Static type checking |
| pylint & flake8 | Linting |
| coverage | Test coverage |
| tox | Test automation |
Use the following command to install them.
pip install -r requirements-dev.txt
Make sure to add tests for any new piece of code using pytest.
pytest
Vulture to check for dead code.
tox -e vulture
Use type annotations for every function definition and apply mypy for static type checking.
tox -e mypy
Use both pylint and flake8 for linting.
tox -e pylint,flake8
Ensure proper test coverage with coverage.py
tox -e coverage
Run all checks with
tox