Contributing to Ouroboros¶
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
$ git clone email@example.com:pybee/ouroboros.git $ cd ouroboros $ mkvirtualenv -p `which python3` ouroboros
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!
Tests can be run using the following command from the project root:
$ python setup.py test