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
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.6.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f0d6ec03875f96df45aa13e21fd9b8450c42d7e1830418cccc008c0df725fcee |
|
MD5 | 2330dd6f5118900611a9bad83c1b9a42 |
|
BLAKE2b-256 | 796c05a569e9f703d18aacb89b7ad6075b404e8a4afde2c26b73ca77bb644b14 |