Skip to main content

Run IPython notebooks from the command line

Project description

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 when aesthetic control is not a priority.

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

Installation

The easiest way to install runipy is with pip:

$ pip install runipy

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

Credit

Portions of the code are based on code by Min RK

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

runipy-0.0.3.tar.gz (4.1 kB view details)

Uploaded Source

File details

Details for the file runipy-0.0.3.tar.gz.

File metadata

  • Download URL: runipy-0.0.3.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for runipy-0.0.3.tar.gz
Algorithm Hash digest
SHA256 dcf5a6dd1a2460c2811685232c651023ec03f08b3487d9779d0f25cc2187fb1e
MD5 9d37bfd5cb679f978ac38da064360b8e
BLAKE2b-256 713227341195b41055dc162b30e4c523837f6216ef59920d8f37a2d31d8cffbb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page