================
README
================

doit - automation tool
======================

about: see docs/index.rst

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
 * Daniel Hjelm - doit-d at hjelm dot eu
 * Damiro - https://launchpad.net/~damiro
 * Charlie Guo - https://launchpad.net/~charlie.guo
 * Michael Gliwinski - https://launchpad.net/~tzeentch-gm


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.5, 2.6, 2.7, 3.2.

``python setup.py install``


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

- simplejson [python 2.5]
- multiprocessing [python 2.5]
- pyinotify (linux) [all python versions]
- macfsevents (mac)

Tools required for development:

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



TESTS
=====

You can use a standalone script::

  python runtests.py

or use `py.test <http://codespeak.net/py/dist/test/index.html>`_ ::

  py.test


DOCUMENTATION
=============

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

``doit website``

It includes epydoc generated API documentation.


LICENSE
=======

The MIT License
Copyright (c) 2008-2011 Eduardo Naufel Schettino

see LICENSE file