Python
Clone or download

README.rst

README

https://travis-ci.org/pydoit/doit.png?branch=master https://ci.appveyor.com/api/projects/status/f7f97iywo8y7fe4d/branch/master?svg=true https://coveralls.io/repos/pydoit/doit/badge.png?branch=master Join the chat at https://gitter.im/pydoit/doit

doit - automation tool

doit comes from the idea of bringing the power of build-tools to execute any kind of task

Sample Code

Define functions returning python dict with task's meta-data.

Snippet from tutorial:

def task_imports():
    """find imports from a python module"""
    for name, module in PKG_MODULES.by_name.items():
        yield {
            'name': name,
            'file_dep': [module.path],
            'actions': [(get_imports, (PKG_MODULES, module.path))],
        }

def task_dot():
    """generate a graphviz's dot graph from module imports"""
    return {
        'targets': ['requests.dot'],
        'actions': [module_to_dot],
        'getargs': {'imports': ('imports', 'modules')},
        'clean': True,
    }

def task_draw():
    """generate image from a dot file"""
    return {
        'file_dep': ['requests.dot'],
        'targets': ['requests.png'],
        'actions': ['dot -Tpng %(dependencies)s -o %(targets)s'],
        'clean': True,
    }

Run from terminal:

$ doit list
dot       generate a graphviz's dot graph from module imports
draw      generate image from a dot file
imports   find imports from a python module
$ doit
.  imports:requests.models
.  imports:requests.__init__
.  imports:requests.help
(...)
.  dot
.  draw

Project Details

license

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

see LICENSE file

developers / contributors

see AUTHORS file

install

doit is tested on python 3.4 to 3.6.

The last version supporting python 2 is version 0.29.

$ pip install doit

dependencies

  • cloudpickle
  • pyinotify (linux)
  • macfsevents (mac)

Tools required for development:

  • git * VCS
  • py.test * unit-tests
  • coverage * code coverage
  • sphinx * doc tool
  • pyflakes * syntax checker
  • doit-py * helper to run dev tasks

development setup

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

tests

Use py.test - http://pytest.org

$ py.test

documentation

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

spell checking

All documentation is spell checked using the task spell:

$ doit spell

It is a bit annoying that code snippets and names always fails the check, these words must be added into the file doc/dictionary.txt.

The spell checker currently uses hunspell, to install it on debian based systems install the hunspell package: apt-get install hunspell.

profiling

python -m cProfile -o output.pstats `which doit` list

gprof2dot -f pstats output.pstats | dot -Tpng -o output.png

contributing

On github create pull requests using a named feature branch.

backers

Become a backer and show your support to our open source project.

https://opencollective.com/doit/backers.svg?width=890

sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website.

https://opencollective.com/doit/sponsor/0/avatar https://opencollective.com/doit/sponsor/1/avatar https://opencollective.com/doit/sponsor/2/avatar https://opencollective.com/doit/sponsor/3/avatar https://opencollective.com/doit/sponsor/4/avatar https://opencollective.com/doit/sponsor/5/avatar https://opencollective.com/doit/sponsor/6/avatar https://opencollective.com/doit/sponsor/7/avatar https://opencollective.com/doit/sponsor/8/avatar https://opencollective.com/doit/sponsor/9/avatar