Development

Development

This chapter descibes how to develop on ppci.

Communication

Join the #ppci irc channel on freenode!

Source code

The sourcecode of the project is located at these repositories:

Continuous integration

The compiler is tested for linux:

and for windows:

Running the testsuite

To run the unit tests with the compiler, use pytest:

$ pytest -v test/

Or use the unittest module:

$ python -m unittest discover -s test

In order to test ppci versus different versions of python, tox is used. To run tox, simply run in the root directory:

$ tox

Building the docs

The docs can be build locally by using sphinx. Make sure that ppci is on your PYTHONPATH

$ export PYTHONPATH=your_ppci_root
$ cd docs
$ sphinx-build -b html . build

Alternatively the tox docs environment can be used:

$ tox -e docs