Contributing Guide

Development

Set up Development Environment

To start developing, install tox and let it configure the development environment:

$ pip install tox
$ tox -e dev
$ . .tox/dev/bin/activate

Or, if you have set up your own environment, you can install all development dependencies by running:

$ pip install -r requirements-dev.txt

Run Tests

To run lint, run:

$ tox -e lint

To run tests, run:

$ tox -e py37  # or py38, py39, whichever you are using

To generate documentation to .tox/docs/_build/html, run:

$ tox -e docs

Submit Your Contributions

To submit your contributions, open a merge request on our gitlab repository.