https://github.com/ColCarroll/carpo

Run and time jupyter notebooks
https://github.com/ColCarroll/carpo

Last synced: 3 months ago
JSON representation

Run and time jupyter notebooks

• Host: GitHub
• URL: https://github.com/ColCarroll/carpo
• Owner: ColCarroll
• License: mit
• Created: 2017-04-09T20:53:25.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-08-14T21:42:46.000Z (about 1 year ago)
• Last Synced: 2024-07-04T02:17:07.636Z (4 months ago)
• Language: Python
• Size: 37.1 KB
• Stars: 12
• Watchers: 3
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
|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:

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

Carpo has gives helpful messages when successfully running notebooks:

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

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

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

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

.. image:: 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

.. |Build Status| image:: https://travis-ci.org/ColCarroll/carpo.svg?branch=master

   :target: https://travis-ci.org/ColCarroll/carpo

.. |Coverage Status| image:: https://coveralls.io/repos/github/ColCarroll/carpo/badge.svg?branch=master

   :target: https://coveralls.io/github/ColCarroll/carpo?branch=master