Skip to content

ngafar/nbpipe

Repository files navigation

nbpipe

Run sequences of Jupyter notebooks as a workflow from the command line or the JupyterLab sidebar.

Installation

pip install nbpipe

Usage

Create a .nbpipe/ directory at the root of your project and add a workflow YAML file inside it.

# .nbpipe/my_workflow.yaml
# Notebook paths are relative to the project root

name: my_workflow
steps:
  - notebook: prepare_data.ipynb
    output: data/processed.csv
  - notebook: train_model.ipynb

Run it from the CLI:

nbpipe run .nbpipe/my_workflow.yaml

or from JupyterLab:

nbpipe sidebar

Step fields

Field Required Description
notebook yes Notebook to run, relative to the project root
output no File the notebook must produce — workflow fails if absent

About

Run sequences of Jupyter notebooks as a workflow from the command line or the JupyterLab sidebar

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors