Development¶

Installing requirements¶

$ pip install -r requirements/docs.txt -r requirements/testing.txt

Terrarium will package up and compress a virtualenv for you based on pip requirements and then let you ship that environment around.

$ terrarium install requirements/*.txt

Install the documentation requirements:
```
$ pip install -r requirements/docs.txt
```
Change directory to docs and run make html:
```
$ cd docs
$ make html
```
Load HTML documentation in a web browser of your choice:
```
$ firefox docs/_build/html/index.html
```

Install the development requirements:

$ pip install -r requirements/testing.txt

Run make test lint in the project root. This will run nosetests with coverage and also display any flake8 errors.
```
$ make test lint
```

To run all tests against all supported versions of python, use tox.

tox allows us to use one command to run tests against all versions of python that we support.

Decide how you want to manage multiple python versions.
1. System level using a package manager such as apt-get. This approach will likely require adding additional apt-get sources in order to install alternative versions of python.
2. Use pyenv to manage and install multiple python versions. After installation, see the pyenv command reference.
Install tox.
```
$ pip install tox
```
Configure tox.

Now that you have tox setup, you just need to run the command tox from the project root directory.

$ tox

The PyDocX project welcomes help in any of the following ways:

All python source files must include the following import declaration at the top of the file:

from __future__ import (
    absolute_import,
    print_function,
    unicode_literals,
)

All stream data is assumed to be a UTF-8 bytestream unless specified otherwise. What this means is that when you are writing test cases for a particular function, any input data you define which would have otherwise have come from a file source must be encoded as UTF-8.

make release