doit

Installation and Setup

Install it from PyPI:

• Windows
• Linux + macOS

(venv) PS> py -m pip install doit

(venv) $ python -m pip install doit

Key Features

• Defines tasks in a dodo.py file using task_*() functions that return or yield task dictionaries.
• Skips up-to-date work by tracking declared dependencies and targets and re-running tasks only when inputs change.
• Runs tasks in parallel using processes by default. Supports thread-based parallelism when requested.
• Provides a rich CLI for listing tasks and managing state, for example, using the list, info, forget, and clean commands.
• Configures defaults via pyproject.toml under [tool.doit] or using the legacy doit.cfg.
• Enables file watching via plugins, such as doit-watch.

Usage

Create a dodo.py file and define tasks that return dictionaries:

def task_run_tests():
    return {"actions": ["pytest -q"]}

def task_compile():
    return {
        "actions": ["pip-compile requirements.in -o requirements.txt"],
        "file_dep": ["requirements.in"],
        "targets": ["requirements.txt"],
    }

Run all default tasks:

$ doit

List available tasks with short descriptions:

$ doit list

Execute a specific task:

$ doit tests compile

Run tasks in parallel using processes or threads:

$ doit -n 4            # Processes
$ doit -n 4 -P thread  # Threads

Force a task to be considered out of date on the next run:

$ doit forget compile

Remove generated targets:

$ doit clean