CONTRIBUTING.rst

How to Contribute

Always happy to get issues identified and pull requests!

Getting your pull request merged in

1. Keep it small. The smaller the pull request the more likely I'll pull it in.
2. Pull requests that fix a current issue get priority for review.
3. If you're not already in the CONTRIBUTORS.rst file, add yourself!

Testing

Installation

Please install tox, which is a generic virtualenv management and test command line tool.

tox is available for download from PyPI via pip:

$ pip install tox

It will automatically create a fresh virtual environment and install our test dependencies, such as pytest-cookies and flake8.

Run the Tests

Tox uses py.test under the hood, hence it supports the same syntax for selecting tests.

For further information please consult the pytest usage docs.

To run all tests using various versions of python in virtualenvs defined in tox.ini, just run tox.:

$ tox

It is possible to test with a specific version of python. To do this, the command is:

$ tox -e py36

This will run py.test with the python3.6 interpreter, for example.

To run a particular test with tox for against your current Python version:

$ tox -e py -- -k test_default_configuration