cook-build 0.5.1

Getting Started

Tasks are declared in a recipe.py file using the ~cook.manager.create_task function. Each task must have a unique name, may depend on files or other tasks, and can execute an action, typically a shell command. The simple example below creates a C source file, compiles it, and executes the binary.

>>> from cook import create_task

>>> create_task("src", targets=["hello.c"],
...             action="echo 'int main() { return 0; }' > hello.c")  # doctest: +IGNORE_RESULT
>>> create_task("cc", dependencies=["hello.c"], targets=["hello"],
...             action="cc -o hello hello.c")  # doctest: +IGNORE_RESULT
>>> create_task("hello", dependencies=["hello"], action="./hello")  # doctest: +IGNORE_RESULT

Running cook ls from the command line lists all known tasks, e.g.,

:cwd: examples/getting_started

$ cook ls
<task `src` @ /.../recipe.py:3>
<task `cc` @ /.../recipe.py:4>
<task `hello` @ /.../recipe.py:5>

Running cook exec hello creates the source file, compiles it, and executes the binary (using --log-level=debug can provide additional information).

:cwd: examples/getting_started
:stderr:

$ cook exec hello
INFO: executing <task `src` @ /.../recipe.py:3> ...
INFO: completed <task `src` @ /.../recipe.py:3> in 0:00:...
INFO: executing <task `cc` @ /.../recipe.py:4> ...
INFO: completed <task `cc` @ /.../recipe.py:4> in 0:00:...
INFO: executing <task `hello` @ /.../recipe.py:5> ...
INFO: completed <task `hello` @ /.../recipe.py:5> in 0:00:...

To rerun a task, tell Cook to reset it.

:cwd: examples/getting_started
:stderr:

$ cook reset cc
INFO: reset 1 task

The full set of available commands can be explored using cook --help as shown below.

Tasks Are Dumb; Contexts Are Smart

~cook.task.Tasks do not provide any functionality beyond storing metadata, including

• targets, the files generated by the task,

• dependencies, the files the task depends on,

• action, the ~cook.actions.Action to execute when the task is run,

• task_dependencies, other tasks that should be executed first,

• location, filename and line number where the task was defined.

All logic is handled by ~cook.contexts.Contexts which are applied to each task when it is created. For example, ~cook.contexts.create_group adds all tasks created within the context to a group. This group can be executed to execute all child tasks.