Source

doit /

Filename Size Date modified Message
bin
contrib
doc
lib/doit
tests
251 B
4.8 KB
3.1 KB
1.1 KB
2.2 KB
991 B
1.6 KB
79 B
413 B
162 B
375 B
1.7 KB
612 B

README

doit - automation tool

doit comes from the idea of bringing the power of build-tools to execute any kind of task. It will keep track of dependencies between "tasks" and execute them only when necessary. It was designed to be easy to use and "get out of your way".

In doit, unlike most (all?) build-tools, a task doesn't need to define a target file to use the execute only if not up-to-date feature. This make doit specially suitable for running test suites.

doit like most build tools is used to execute tasks defined in a configuration file. Configuration files are python modules. The tasks can be python functions or an external shell script/command. doit automatically keeps track of declared dependencies executing only tasks that needs to be update (based on which dependencies have changed).

Developers / contributors

(in chronological order) see also https://launchpad.net/~doit-team/+members

Project Details

INSTALL

python setup.py install

DEPENDENCIES

Python 2.6:
There are no external dependencies to install and use doit.

Python 2.4 & 2.5: - simplejson

Tools required for development:

  • py.test * unit tests
  • bazaar * VCS
  • epydoc * API doc generator
  • sphinx * doc tool
  • pyflakes * syntax checker
  • pychecker * syntax checker

TESTS

py.test is required to run the test suite.

py.test

DOCUMENTATION

doc folder contains ReST documentation. They are the base for creating the website. To create it (after installing doit):

doit -f website.py

It includes epydoc generated API documentation.

LICENSE

The MIT License Copyright (c) 2008 Eduardo Naufel Schettino

see LICENSE file