nbconvert7.16.4
Published
Converting Jupyter Notebooks (.ipynb files) to other formats. Output formats include asciidoc, html, latex, markdown, pdf, py, rst, script. nbconvert can be used both as a Python library (`import nbconvert`) or as a command line tool (invoked as `jupyter nbconvert ...`).
pip install nbconvert
Package Downloads
Authors
Project URLs
Requires Python
>=3.8
Dependencies
- beautifulsoup4
- bleach
!=5.0.0 - defusedxml
- importlib-metadata
>=3.6; python_version < "3.10" - jinja2
>=3.0 - jupyter-core
>=4.7 - jupyterlab-pygments
- markupsafe
>=2.0 - mistune
<4,>=2.0.3 - nbclient
>=0.5.0 - nbformat
>=5.7 - packaging
- pandocfilters
>=1.4.1 - pygments
>=2.4.1 - tinycss2
- traitlets
>=5.1 - flaky
; extra == "all" - ipykernel
; extra == "all" - ipython
; extra == "all" - ipywidgets
>=7.5; extra == "all" - myst-parser
; extra == "all" - nbsphinx
>=0.2.12; extra == "all" - playwright
; extra == "all" - pydata-sphinx-theme
; extra == "all" - pyqtwebengine
>=5.15; extra == "all" - pytest
>=7; extra == "all" - sphinx
==5.0.2; extra == "all" - sphinxcontrib-spelling
; extra == "all" - tornado
>=6.1; extra == "all" - ipykernel
; extra == "docs" - ipython
; extra == "docs" - myst-parser
; extra == "docs" - nbsphinx
>=0.2.12; extra == "docs" - pydata-sphinx-theme
; extra == "docs" - sphinx
==5.0.2; extra == "docs" - sphinxcontrib-spelling
; extra == "docs" - pyqtwebengine
>=5.15; extra == "qtpdf" - pyqtwebengine
>=5.15; extra == "qtpng" - tornado
>=6.1; extra == "serve" - flaky
; extra == "test" - ipykernel
; extra == "test" - ipywidgets
>=7.5; extra == "test" - pytest
>=7; extra == "test" - playwright
; extra == "webpdf"
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
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
About the Jupyter Development Team
The Jupyter Development Team is the set of all contributors to the Jupyter project. This includes all of the Jupyter subprojects.
The core team that coordinates development on GitHub can be found here: https://github.com/jupyter/.
Our Copyright Policy
Jupyter uses a shared copyright model. Each contributor maintains copyright over their contributions to Jupyter. But, it is important to note that these contributions are typically only changes to the repositories. Thus, the Jupyter source code, in its entirety is not the copyright of any single person or institution. Instead, it is the collective copyright of the entire Jupyter Development Team. If individual contributors want to maintain a record of what changes/contributions they have specific copyright on, they should indicate their copyright in the commit message of the change, when they commit the change to one of the Jupyter repositories.
With this in mind, the following banner should be used in any source code file to indicate the copyright and license terms:
# Copyright (c) Jupyter Development Team.
# Distributed under the terms of the Modified BSD License.