Skip to content

Contributing

Contributions are welcome; just open an issue or send us a pull request.

Testing

Executing the test in your environment:

pip install -r requirements.txt
pip install -e .
flake8
pytest

or with tox installed:

tox

Documenting

Docs published using mkdocs:

pip install -r requirements-docs.txt
pip install -e .
mkdocs serve

Open http://127.0.0.1:8000/ to view the documentation locally.