API Reference

API Reference#

Library to support combining jupyter notebooks and pydoit.

pydoit_nb.attrs_helpers

Tools for helping with attrs, particularly validators

pydoit_nb.checklist

Checklist file generation

pydoit_nb.complete

Complete file generation

pydoit_nb.config_handling

Tools for working with configuration

pydoit_nb.config_helpers

Helper functions that can be useful when setting up config

pydoit_nb.config_tools

Re-usable tools that can help when creating configuration

pydoit_nb.display

Utilities for displaying things, typically by printing

pydoit_nb.doit_tools

Tools for compatibility with [doit](pydoit.org)

pydoit_nb.notebook

Notebook defining classes

pydoit_nb.notebook_run

Notebook running

pydoit_nb.notebook_step

Notebook-based step

pydoit_nb.serialization

Serialization tools

pydoit_nb.tasks_copy_source

Generation of tasks for copying source into the outputs

pydoit_nb.tasks_generation

Re-usable tools for generating tasks

pydoit_nb.testing

Tools to help with testing

pydoit_nb.typing

Typing specifications