If you wish to contribute to this project, then you should fork the repository found here:
Once that has been done and you have a checkout, you can follow these instructions to perform various development tasks:
Setting up a virtualenv#
The recommended way to set up a development environment is to create a virtualenv and then install the package in editable form as follows:
$ python3 -m venv ~/virtualenvs/testfixtures $ source ~/virtualenvs/testfixtures/bin/activate $ pip install -U pip setuptools $ pip install -U -e .[test,build]
Running the tests#
Once you’ve set up a virtualenv, the tests can be run in the activated virtualenv and from the root of a source checkout as follows:
Building the documentation#
The Sphinx documentation is built by doing the following from the
$ cd docs $ make html
To check that the description that will be used on PyPI renders properly, do the following:
$ python setup.py --long-description | rst2html.py > desc.html
desc.html should be checked by opening in a browser.
Making a release#
To make a release, just update
version.txt, update the change log
and push to https://github.com/simplistix/testfixtures.
Carthorse should take care of the rest.