================
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

 * Eduardo Schettino - https://launchpad.net/~schettino72
 * Javier Collado - https://launchpad.net/~javier.collado
 * Philipp Tölke - https://launchpad.net/~toelke+lp

Project Details
===============

 - Project management on `launchpad <https://launchpad.net/doit>`_
 - Website http://python-doit.sourceforge.net/
 - `Discussion group <http://groups.google.co.in/group/python-doit>`_


INSTALL
=======

doit is tested on python 2.4, 2.5, 2.6.

``python setup.py install``


DEPENDENCIES
============

- pyinotify [all python versions] (requires ctypes - not in python2.4 stdlib)
- simplejson [python 2.4 & 2.5]

Tools required for development:

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


TESTS
=====

`py.test <http://codespeak.net/py/dist/test/index.html>`_ 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-2010 Eduardo Naufel Schettino

see LICENSE file