Developer Guide

Setup Development Environment

1. Install pip and tox:

   sudo apt-get install python-pip
   sudo pip install tox
   

2. Configure git pre-commit hook:

   sudo pip install flake8 pep8-naming
   flake8 --install-hook
   git config flake8.strict true
   

3. Install Other Requirements

   # For inheritance diagram
   sudo apt-get install graphviz
   

Building Documentation

tox -e doc

Output will be available at .tox/doc/tmp/html. It is recommended to install the webdev package:

sudo pip install webdev

So a development web server can serve any location like this:

$ webdev .tox/doc/tmp/html

Running Test Suite

tox -e test