🐍⚡️Support Python for everyone by grabbing a 30% discount on PyCharm—ALL proceeds go to the Python Software Foundation. Offer ends soon, so grab it today!  GET 30% OFF PYCHARM

Converting Jupyter Notebooks

Navigation

Verified details

These details have been verified by PyPI
Owner
Maintainers
Avatar for bgranger from gravatar.com bgranger Avatar for fperez from gravatar.com fperez Avatar for ivanov from gravatar.com ivanov Avatar for jasongrout from gravatar.com jasongrout Avatar for jhamrick from gravatar.com jhamrick Avatar for Kyle.Kelley from gravatar.com Kyle.Kelley Avatar for martinRenou from gravatar.com martinRenou Avatar for mbussonn from gravatar.com mbussonn Avatar for mdpacer from gravatar.com mdpacer Avatar for minrk from gravatar.com minrk Avatar for mpacer from gravatar.com mpacer Avatar for MSeal from gravatar.com MSeal Avatar for Sylvain.Corlay from gravatar.com Sylvain.Corlay Avatar for takowl from gravatar.com takowl

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: BSD License (BSD)
  • Author: Jupyter Development Team
  • Tags Interactive , Interpreter , Shell , Web
  • Requires: Python >=3.7
Classifiers
Report project as malware

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

Supported by

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