Developing Hieroglyph

Hieroglyph uses Buildout to manage dependencies and development.

  1. Check out the repository:

    $ git clone
  2. Bootstrap and run buildout:

    $ python
    $ ./bin/buildout

After running Buildout, you can run ./bin/python to execute an interpreter with Hieroglyph and its dependencies installed.

Running Tests

The unit tests can be run via

$ ./bin/python test

Tox can be used to run the tests with both Python 2.7 and 3.3. The Tox configuration will run the tests with Sphinx 1.1.3, Sphinx 1.2, and the development branch.