Contributing to Ouroboros

If you experience problems with Ouroboros, log them on GitHub. If you want to contribute code, please fork the code and submit a pull request.

Setting up your development environment

The recommended way of setting up your development envrionment for Ouroboros is to install a virtual environment, install the required dependencies and start coding. Assuming that you are using virtualenvwrapper, you only have to run:

$ git clone
$ cd ouroboros
$ mkvirtualenv -p `which python3` ouroboros

Ouroboros uses unittest for its own test suite as well as additional helper modules for testing. To install all the requirements for Ouroboros, you have to run the following commands within your virutal envrionment:

$ pip install -e .
$ pip install -r requirements_dev.txt

A brief reminder that ouroboros is intended to work only on python versions 3.3 and above.

Now you are ready to start hacking! Have fun!

Running tests

Tests can be run using the following command from the project root:

$ python test