Contributing

All the contributions are welcome! Please open an issue or send us a pull request.

Executing the tests:

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

or with tox installed:

$ tox

Documentation is published with mkdocs:

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

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