doit documentation

Getting Started

Introduction of doit basic features with a real example.

• Use Cases
• tutorial - python imports graph

Guide

Introduces the concepts of every feature one by one with examples. It was written to be both read in order and also serves as a complete reference.

The total reading time for the whole documentation is about one hour.

• Installing
  • pip
  • Source
  • git repository
  • OS package
  • Anaconda
• Tasks
  • Intro
  • Actions
  • task name
  • listing tasks
  • doc
  • sub-tasks
  • Dependencies & Targets
  • file_dep (file dependency)
  • targets
  • execution order
  • Task selection
  • parameters on actions
  • private/hidden tasks
  • title
  • verbosity
  • meta
  • pathlib
• Non-file dependencies
  • uptodate
  • doit up-to-date definition
  • uptodate API
  • task-dependency
  • setup-task
  • saving computed values
  • getargs
  • calculated-dependencies
• More on Task creation
  • importing tasks
  • delayed task creation
  • custom task definition
• Command line interface - run
  • python -m doit
  • dodo file
  • as an executable file
  • from IPython
  • returned value
  • DB backend
  • DB-file
  • verbosity
  • failure-verbosity
  • output buffering
  • dir (cwd)
  • continue
  • single task execution
  • parallel execution
  • reporter
  • custom reporter
  • check_file_uptodate
  • output-file
  • pdb
  • get_initial_workdir()
  • codec_cls
  • minversion
  • automatic regex for delayed task loaders
• sub-commands for task manipulation
  • help
  • list
  • info
  • forget
  • clean
  • ignore
  • auto (watch)
  • tabcompletion
  • dumpdb
  • strace
  • reset-dep
• Configuration
  • config param names
  • pyproject.toml
  • doit.cfg
  • configuration at dodo.py
• Passing arguments from the command line
  • Task action parameters
  • positional arguments
  • command line variables (doit.get_var)
  • Task creator parameters
• Globals - accessing doit internals
  • dep_manager
• custom up-to-date
  • result-dependency
  • run_once()
  • timeout()
  • config_changed()
  • check_timestamp_unchanged()
• Tools & Integrations
  • create_folder (action)
  • title_with_actions (title)
  • LongRunning (action)
  • Interactive (action)
  • PythonInteractiveAction (action)
  • set_trace
  • IPython integration
• Extending doit
  • task loader customization
  • command customization
  • plugins

Project

• Support
  • Feedback & Ideas
  • Questions
  • Issues/bugs
  • Feature requests
  • Donations
  • Commercial Support
• Changes
  • 0.37.0 (unreleased)
  • 0.36.0 (2022-04-22)
  • 0.35.0 (2022-04-07)
  • 0.34.2 (2022-02-18)
  • 0.34.1 (2022-01-12)
  • 0.34.0 (2021-12-11)
  • 0.33.1 (2020-09-04)
  • 0.33.0 (2020-09-01)
  • 0.32.0 (2019-12-10)
  • 0.31.1 (2018-03-18)
  • 0.31.0 (2018-02-25)
  • 0.30.3 (2017-02-20)
  • 0.30.2 (2017-02-16)
  • 0.30.1 (2017-02-16)
  • 0.30.0 (2016-11-22)
  • 0.29.0 (2015-08-16)
  • 0.28.0 (2015-04-22)
  • 0.27.0 (2015-01-30)
  • 0.26.0 (2014-08-30)
  • 0.25.0 (2014-03-26)
  • 0.24.0 (2013-11-24)
  • 0.23.0 (2013-09-20)
  • 0.22.1 (2013-08-04)
  • 0.22.0 (2013-07-05)
  • 0.21.1 (2013-05-21)
  • 0.21.0 (2013-04-29)
  • 0.20.0 (2013-01-09)
  • 0.19.0 (2012-12-18)
  • 0.18.1 (2012-12-03)
  • 0.18.0 (2012-11-27)
  • 0.17.0 (2012-09-20)
  • 0.16.1 (2012-05-13)
  • 0.16.0 (2012-04-23)
  • 0.15.0 (2012-01-10)
  • 0.14.0 (2011-11-05)
  • 0.13.0 (2011-07-18)
  • 0.12.0 (2011-05-29)
  • 0.11.0 (2011-04-20)
  • 0.10.0 (2011-01-24)
  • 0.9.0 (2010-06-08)
  • 0.8.0 (2010-05-16)
  • 0.7.0 (2010-04-08)
  • 0.6.0 (2010-01-25)
  • 0.5.1 (2009-12-03)
  • 0.5.0 (2009-11-30)
  • 0.4.0 (2009-10-05)
  • 0.3.0 (2009-08-30)
  • 0.2.0 (2009-04-16)
  • 0.1.0 (2008-04-14)
• Success Stories
  • Scientific
  • Build System
  • Content Generation
  • DevOps
• FAQ
  • Why is doit written in all lowercase instead of CamelCase?
  • doit is too verbose, why don’t you use decorators?
  • dodo.py file itself should be a file_dep for all tasks
  • Why file_dep can not depend on a directory/folder?
  • How to make a dependency on all files in a folder?
• Related Projects