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
Resources
Release history Release notifications
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
| Filename, size | File type | Python version | Upload date | Hashes |
|---|---|---|---|---|
| Filename, size nbconvert-5.6.0-py2.py3-none-any.whl (454.0 kB) | File type Wheel | Python version py2.py3 | Upload date | Hashes View hashes |
| Filename, size nbconvert-5.6.0.tar.gz (701.7 kB) | File type Source | Python version None | Upload date | Hashes View hashes |
Hashes for nbconvert-5.6.0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 48d3c342057a2cf21e8df820d49ff27ab9f25fc72b8f15606bd47967333b2709 |
|
| MD5 | 797256721486b98c36797a4b48c32283 |
|
| BLAKE2-256 | f9df4505c0a7fea624cac461d0f41051f33456ae656753f65cee8c2f43121cb2 |
