doit comes from the idea of bringing the power of build-tools to execute any kind of task
- Project management on github - https://github.com/pydoit/doit
- Website & docs - http://pydoit.org
- Discussion group - https://groups.google.com/forum/#!forum/python-doit
The MIT License Copyright (c) 2008-2013 Eduardo Naufel Schettino
see LICENSE file
see AUTHORS file
doit is tested on python 2.6, 2.7, 3.2, 3.3, 3.4.
$ python setup.py install
- six
- pyinotify (linux)
- macfsevents (mac)
Tools required for development:
- git * VCS
- py.test * unit-tests
- mock * unit-tests
- coverage * code coverage
- epydoc * API doc generator
- sphinx * doc tool
- pyflakes * syntax checker
- doit-py * helper to run dev tasks
The best way to setup an environment to develop doit itself is to create a virtualenv...
doit$ virtualenv dev (dev)doit$ dev/bin/activate
install doit as "editable", and add development dependencies
from dev_requirements.txt:
(dev)doit$ pip install --editable . (dev)doit$ pip install --requirement dev_requirements.txt
You can use the standalone script:
$ python runtests.py
or use py.test - http://pytest.org
$ py.test
doc folder contains ReST documentation based on Sphinx.
doc$ make html
They are the base for creating the website. The only difference is that the website includes analytics tracking. To create it (after installing doit):
$ doit website
The website will also includes epydoc generated API documentation.
On github create pull requests using a named feature branch.