twosigma/nbconvert

Name: nbconvert

Owner: Two Sigma

Description: Jupyter Notebook Conversion

Created: 2018-03-01 21:55:27.0

Updated: 2018-03-01 21:55:29.0

Pushed: 2018-03-22 12:25:51.0

Homepage: https://nbconvert.readthedocs.io/

Size: 2678

Language: Jupyter Notebook

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

nbconvert

Jupyter Notebook Conversion

Google Group Build Status Documentation Status Documentation Status codecov.io

The nbconvert tool, jupyter nbconvert, converts notebooks to various other formats via Jinja templates. The nbconvert tool allows you to convert an .ipynb notebook file into various static formats including:

Usage

From the command line, use nbconvert to convert a Jupyter notebook (input) to a a different format (output). The basic command structure is:

$ jupyter nbconvert --to <output format> <input notebook>

where <output format> is the desired output format and <input notebook> is the filename of the Jupyter notebook.

Example: Convert a notebook to HTML

Convert Juptyer notebook file, mynotebook.ipynb, to HTML using:

$ jupyter nbconvert --to html mynotebook.ipynb

This command creates an HTML output file named mynotebook.html.

Dev Install

Check if pandoc is installed (pandoc --version); if needed, install:

 apt-get install pandoc

Or

 install pandoc

Install nbconvert for development using:

clone https://github.com/jupyter/nbconvert.git
bconvert
install -e .

Running the tests after a dev install above:

install nbconvert[test]
est --pyargs nbconvert
Resources

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.