Converting Jupyter Notebooks
Project description
nbconvert
Jupyter Notebook Conversion
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
- 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
- Documentation for Jupyter nbconvert [PDF]
- nbconvert examples on GitHub
- Documentation for Project Jupyter [PDF]
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
Built Distribution
Hashes for nbconvert-7.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8cc353e3e6a37cf9d8363997b9470fa0de5adda84063ed65a43d4d3de1bf37a9 |
|
MD5 | f8c1ae78ec9b33830a0e55a3e2504541 |
|
BLAKE2b-256 | bb6e12e26c80f6a62a0b75f543f6df9d8d6305f96994f90bc8c3595703594cf2 |