Development

Tools

1. setuptools
2. Paver
3. nose
4. ghp-import
5. pyflakes
6. pychecker
7. paved fork
8. Sphinx
9. sphinxcontrib-programscreenshot
10. sphinxcontrib-paverutils
11. autorun from sphinx-contrib (there is no simple method, you have to download/unpack/setup)

Install on ubuntu

sudo apt-get install python-setuptools
sudo apt-get install python-paver
sudo apt-get install python-nose
sudo easy_install ghp-import
sudo apt-get install pyflakes
sudo apt-get install pychecker
sudo easy_install https://github.com/ponty/paved/zipball/master
sudo apt-get install scrot
sudo apt-get install xvfb
sudo apt-get install xserver-xephyr
sudo apt-get install python-imaging
sudo apt-get install python-sphinx
sudo easy_install sphinxcontrib-programscreenshot
sudo easy_install sphinxcontrib-programoutput
sudo easy_install sphinxcontrib-paverutils

Tasks

Paver is used for task management, settings are saved in pavement.py. Sphinx is used to generate documentation.

print paver settings:

paver printoptions

clean generated files:

paver clean

generate documentation under docs/_build/html:

paver cog pdf html

upload documentation to github:

paver ghpages

run unit tests:

paver nose
#or
nosetests --verbose

check python code:

paver pyflakes
paver pychecker

generate python distribution:

paver sdist

upload python distribution to PyPI:

paver upload