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 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:
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
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-5.4.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5de8fb2284422272a1d45abc77c07b888127550a6d602ce619592a2b08a474ff |
|
MD5 | dd7a18682e4ece2cdfe1070f3eef1ac0 |
|
BLAKE2b-256 | b8391e67fea74dc9577cc49f9863fe3ec824e525d1304ab6027d95a94cd586f5 |