ColCarroll / carpo

Run and time jupyter notebooks

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status Coverage Status

Carpo

An irregular satellite of Jupyter.

A command line utility to run, profile, and save Jupyter notebooks.

Installation

Carpo may be installed from pypi:

pip install carpo

Tested against python 2.7, 3.4, 3.5, 3.6.

Quickstart

Use

carpo run path/to_notebook.ipynb

to run a notebook.

carpo show path/to_notebook.ipynb

will show data from past runs.

More depth

Carpo plays nicely with shell expansion:

https://colindcarroll.com/img/carpo/carpo_show.png

Carpo has gives helpful messages when successfully running notebooks:

https://colindcarroll.com/img/carpo/carpo_run.png

Carpo shows the cell and the error when a run fails:

https://colindcarroll.com/img/carpo/carpo_error.png

Also, carpo plays nicely with git, and will remember if a notebook has been run:

https://colindcarroll.com/img/carpo/carpo_git.png

Help

Includes help messages:

$ carpo --help
Usage: carpo [OPTIONS] COMMAND [ARGS]...

  Base for cli commands.

Options:
  --help  Show this message and exit.

Commands:
  run   Try to re-run all notebooks.
  show  View status of notebooks

About

Run and time jupyter notebooks

License:MIT License


Languages

Language:Python 95.7%Language:Jupyter Notebook 4.3%