Installing

You can install machinerry using pip:

pip install machinerry

Or you can clone the machinerry repository, and in an activated virtualenv, run this command:

pip install .

Developing

If you want to work on the project, then clone the repository, and after creating a virtualenv, and run:

pip install -r requirements-dev.txt

Testing

You can just tox to run the test suite:

tox

Documentation

You can generate documentation using Sphinx:

sphinx-build docs/ build/docs/