Skip to main content

Converting Jupyter Notebooks

Project description

nbconvert

Jupyter Notebook Conversion

Google Group Build Status Documentation Status Documentation Status codecov.io CircleCI Docs Status

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:

  • HTML
  • LaTeX
  • PDF
  • Reveal JS
  • Markdown (md)
  • ReStructured Text (rst)
  • executable script

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

sudo apt-get install pandoc

Or

brew install pandoc

Install nbconvert for development using:

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

Running the tests after a dev install above:

pip install nbconvert[test]
py.test --pyargs nbconvert

Documentation

Technical Support

  • Issues and Bug Reports: A place to report bugs or regressions found for nbconvert
  • Community Technical Support and Discussion - Discourse: A place for installation, configuration, and troubleshooting assistannce by the Jupyter community. As a non-profit project and maintainers who are primarily volunteers, we encourage you to ask questions and share your knowledge on Discourse.

Jupyter Resources

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

nbconvert-6.5.0.tar.gz (908.4 kB view details)

Uploaded Source

Built Distribution

nbconvert-6.5.0-py3-none-any.whl (561.6 kB view details)

Uploaded Python 3

File details

Details for the file nbconvert-6.5.0.tar.gz.

File metadata

  • Download URL: nbconvert-6.5.0.tar.gz
  • Upload date:
  • Size: 908.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for nbconvert-6.5.0.tar.gz
Algorithm Hash digest
SHA256 223e46e27abe8596b8aed54301fadbba433b7ffea8196a68fd7b1ff509eee99d
MD5 486a48c4dc3986e8801058273964d189
BLAKE2b-256 71947b4fcc2f413a0f6cd2befe31da4c7df0eb4978e5a21a7aaddb008bba7e54

See more details on using hashes here.

File details

Details for the file nbconvert-6.5.0-py3-none-any.whl.

File metadata

  • Download URL: nbconvert-6.5.0-py3-none-any.whl
  • Upload date:
  • Size: 561.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for nbconvert-6.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c56dd0b8978a1811a5654f74c727ff16ca87dd5a43abd435a1c49b840fcd8360
MD5 b7548656dc6d69908301f2b1f9ff749f
BLAKE2b-256 e8f92de57146b8995d7f1b68d6fd0b4751d68c23f52e6f4ad926a7274184e8f2

See more details on using hashes here.

Supported by

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