pydoit_nb.notebook_step

Notebook-based step

A notebook-based step is the combination of a notebook and the configuration to run it.

ConfigureNotebooksCallable

class ConfigureNotebooksCallable(*args, **kwargs)

Bases: Protocol[CB_contra]

Callable that can be used for configuring notebooks

UnconfiguredNotebookBasedStep

class UnconfiguredNotebookBasedStep(step_name, unconfigured_notebooks, configure_notebooks)

Bases: Generic[C, CB_contra]

An unconfigured notebook-based step

A step is a step in the overall workflow. A notebook-based step can be made up of one or more notebooks. These are then configured at run-time with the run-time information so they can then be turned into doit task(s).

configure_notebooks: pydoit_nb.notebook_step.ConfigureNotebooksCallable[typing.TypeVar(CB_contra, bound= pydoit_nb.typing.ConfigBundleLike[typing.Any], contravariant=True)]

Function which can configure the notebooks based on run-time information

gen_notebook_tasks(config_bundle, root_dir_raw_notebooks, converter=None, clean=True)

Generate notebook tasks for this step

Parameters:

• config_bundle (typing.TypeVar(CB_contra, bound= pydoit_nb.typing.ConfigBundleLike[typing.Any], contravariant=True)) – Configuration bundle to use when generating the tasks

• root_dir_raw_notebooks (pathlib.Path) – Root directory in which the raw notebooks live

• converter (typing.Optional[pydoit_nb.typing.Converter]) – Instance that can serialise the configuration used by each notebook

• clean (bool) – If we run doit clean, should the targets of each task be removed?

Yields:

Task specifications for use with doit

Return type:

collections.abc.Iterable[dict[str, typing.Any]]

step_name: str

Name of the step

unconfigured_notebooks: list[pydoit_nb.notebook.UnconfiguredNotebook]

Unconfigured notebooks that make up this step