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
14 maintainers
Metadata
14 maintainers
Release files for nbconvert 6.4.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| nbconvert-6.4.4.tar.gz | 907.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| nbconvert-6.4.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.5 MB
Release files / nbconvert-6.4.4.tar.gz
| Download URL | nbconvert-6.4.4.tar.gz |
|---|---|
| Size | 907.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ee0dfe34bbd1082ac9bfc750aae3c73fcbc34a70c5574c6986ff83c10a3541fd
|
|
BLAKE2b-256 checksum How to use checksums |
6ed869385c6f0ed02347810c37c031ba5990cd453f53f44e5d89c2712612a553
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/0.0.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.9.6
|
Release files / nbconvert-6.4.4-py3-none-any.whl
| Download URL | nbconvert-6.4.4-py3-none-any.whl |
|---|---|
| Size | 561.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c0c13d11378e13f72b9cd509c008383dca4051c228e4985f75023b2a5d82fc9f
|
|
BLAKE2b-256 checksum How to use checksums |
16315dcbffe34aeb9dc4760c0b36e21a7a621f0ab776d0fc8d39183fa5e9a77d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/0.0.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.9.6
|
