Not Logged In

runipy 0.1.5

runipy: run IPython as a script

The IPython notebook provides an interactive interface to a Python interpreter.

Literate programming: the IPython notebook is an ideal format for
writing “literate” programs, in which the code is part of a larger multi-media
document. runipy lets you run such programs directly, without first
converting to a pure Python script.

Report generation: runipy can run the notebook and convert it into HTML
in one go, making it an easy way to automate reports.

Data pipeline: if you use IPython notebooks to create a data pipeline,
runipy lets you automate that pipeline without losing the notebook
formatting.

Requirements

runipy currently supports IPython versions 2.4.x, 3.2.x and the current development
version of 4.x.

Installation

The easiest way to install runipy is with pip:

$ pip install runipy

Command-line use

To run a .ipynb file as a script, run:

$ runipy MyNotebook.ipynb

To save the output of each cell back to the notebook file, run:

$ runipy -o MyNotebook.ipynb

To save the notebook output as a new notebook, run:

$ runipy MyNotebook.ipynb OutputNotebook.ipynb

To run a .ipynb file and generate an HTML report, run:

$ runipy MyNotebook.ipynb --html report.html

Passing Arguments

You can pass arguments to the notebook through environment variables.
The use of environment variables is OS- and shell- dependent, but in a
typical UNIX-like environment they can be passed on the command line
before the program name:

run_notebook() takes two optional arguments. The first, skip_exceptions,
takes a boolean value (False by default). If True, exceptions will be ignored
and the notebook will continue to execute cells after encountering an exception.
The second argument is progress_callback, which must be either None or a
function that takes one argument. This function is called after execution of
each cell with the 0-based index of the cell just evaluated. This can be useful
for tracking progress of long-running notebooks.