noisymime / zookeepr Goto Github PK

====== Zookeepr Readme ======

This document details how running zookeepr, how to run tests, and where to start hacking.

It assumes that you have the necessary dependencies installed and the development environment up and running. Please refer to INSTALL if you do not have your environment set up.

====== Running zookeepr ======

From within zookeepr/
 * Run `paster serve -v --reload development.ini`
 * Point your browser to http://localhost:5000/

====== Where to start hacking ======

 * Refer to the docstrings to familiarise yourself with the code
 * PEP-8 is your new god. PyLint can be used to enforce it. Refer to http://www.python.org/dev/peps/pep-0008/
 * Run `nosetests --stop` from within zookeepr source tree to get an initial starting point on all bugs you should be fixing
 * Add yourself to the AUTHORS file if you think you're contributions are worthy :-)


====== Testing ======

Run `nosetests` to run the test suite.  They must pass all the time or else!

 * `nosetests` - runs all tests
 * `nosetests --stop` - runs all tests and stops at the first error
 * `nosetests -sv` - print output as zookeer installs