doit logo

Table Of Contents



Launchpad logo

Get doit at SourceForge.net. Fast, secure and Free Open Source software downloads

Reference

Task Dictionary parameters

Tasks are defined by functions starting with the string task_. It must return a dictionary describing the task with the following fields:

action:
  • Required field
  • type: Python-Task -> tuple (callable, *args, **kwargs)
  • type: Cmd-Task -> string or list of strings (each item is a different command). to be executed by shell.
  • type: Group-Task -> None.
name:
  • Required field - Sub-tasks only
  • type: string. sub-task identifier
dependencies:
  • Optional field
  • type: list. items: * file (string) path relative to the dodo file * task (string) “:<task_name>” * run-once (True bool)
targets:
  • Optional field
  • type: list of strings
  • each item is file-path relative to the dodo file (accepts both files and folders)
setup:
  • Optional field
  • type: list of objects with methods ‘setup’ and ‘cleanup’
doc:
  • Optional field
  • type: string -> the description text
clean:
  • Optional field
  • type: (True bool) remove target files
  • type: (list) of actions (see above)