runipy 0.0.4

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

$ myvar=value runipy MyNotebook.ipynb

Then in the notebook, to access myvar:

from os import environ
myvar = environ['myvar']

environ is just a dict, so you can use .get() to fall back on a default value:

from os import environ
myvar = environ.get('myvar', 'default!')

Programmatic use

It is also possible to run IPython notebooks from Python, using:

from runipy.notebook_runner import NotebookRunner

r = NotebookRunner("MyNotebook.ipynb")
r.run_notebook()

and you can enable pylab with:

r = NotebookRunner("MyNotebook.ipynb", pylab=True)

Credit

Portions of the code are based on code by Min RK