165 lines
6 KiB
Text
165 lines
6 KiB
Text
|
Metadata-Version: 2.1
|
||
|
|
Name: nbconvert
|
||
|
|
Version: 6.0.7
|
||
|
|
Summary: Converting Jupyter Notebooks
|
||
|
|
Home-page: https://jupyter.org
|
||
|
|
Author: Jupyter Development Team
|
||
|
|
Author-email: jupyter@googlegroups.com
|
||
|
|
License: BSD
|
||
|
|
Project-URL: Documentation, https://nbconvert.readthedocs.io/en/latest/
|
||
|
|
Project-URL: Funding, https://numfocus.org/
|
||
|
|
Project-URL: Source, https://github.com/jupyter/nbconvert
|
||
|
|
Project-URL: Tracker, https://github.com/jupyter/nbconvert/issues
|
||
|
|
Keywords: Interactive,Interpreter,Shell,Web
|
||
|
|
Platform: Linux
|
||
|
|
Platform: Mac OS X
|
||
|
|
Platform: Windows
|
||
|
|
Classifier: Intended Audience :: Developers
|
||
|
|
Classifier: Intended Audience :: System Administrators
|
||
|
|
Classifier: Intended Audience :: Science/Research
|
||
|
|
Classifier: License :: OSI Approved :: BSD License
|
||
|
|
Classifier: Programming Language :: Python
|
||
|
|
Classifier: Programming Language :: Python :: 3
|
||
|
|
Requires-Python: >=3.6
|
||
|
|
Description-Content-Type: text/markdown
|
||
|
|
Requires-Dist: mistune (<2,>=0.8.1)
|
||
|
|
Requires-Dist: jinja2 (>=2.4)
|
||
|
|
Requires-Dist: pygments (>=2.4.1)
|
||
|
|
Requires-Dist: jupyterlab-pygments
|
||
|
|
Requires-Dist: traitlets (>=4.2)
|
||
|
|
Requires-Dist: jupyter-core
|
||
|
|
Requires-Dist: nbformat (>=4.4)
|
||
|
|
Requires-Dist: entrypoints (>=0.2.2)
|
||
|
|
Requires-Dist: bleach
|
||
|
|
Requires-Dist: pandocfilters (>=1.4.1)
|
||
|
|
Requires-Dist: testpath
|
||
|
|
Requires-Dist: defusedxml
|
||
|
|
Requires-Dist: nbclient (<0.6.0,>=0.5.0)
|
||
|
|
Provides-Extra: all
|
||
|
|
Requires-Dist: pytest ; extra == 'all'
|
||
|
|
Requires-Dist: pytest-cov ; extra == 'all'
|
||
|
|
Requires-Dist: pytest-dependency ; extra == 'all'
|
||
|
|
Requires-Dist: ipykernel ; extra == 'all'
|
||
|
|
Requires-Dist: ipywidgets (>=7) ; extra == 'all'
|
||
|
|
Requires-Dist: pyppeteer (==0.2.2) ; extra == 'all'
|
||
|
|
Requires-Dist: tornado (>=4.0) ; extra == 'all'
|
||
|
|
Requires-Dist: sphinx (>=1.5.1) ; extra == 'all'
|
||
|
|
Requires-Dist: sphinx-rtd-theme ; extra == 'all'
|
||
|
|
Requires-Dist: nbsphinx (>=0.2.12) ; extra == 'all'
|
||
|
|
Requires-Dist: ipython ; extra == 'all'
|
||
|
|
Provides-Extra: docs
|
||
|
|
Requires-Dist: sphinx (>=1.5.1) ; extra == 'docs'
|
||
|
|
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
|
||
|
|
Requires-Dist: nbsphinx (>=0.2.12) ; extra == 'docs'
|
||
|
|
Requires-Dist: ipython ; extra == 'docs'
|
||
|
|
Provides-Extra: serve
|
||
|
|
Requires-Dist: tornado (>=4.0) ; extra == 'serve'
|
||
|
|
Provides-Extra: test
|
||
|
|
Requires-Dist: pytest ; extra == 'test'
|
||
|
|
Requires-Dist: pytest-cov ; extra == 'test'
|
||
|
|
Requires-Dist: pytest-dependency ; extra == 'test'
|
||
|
|
Requires-Dist: ipykernel ; extra == 'test'
|
||
|
|
Requires-Dist: ipywidgets (>=7) ; extra == 'test'
|
||
|
|
Requires-Dist: pyppeteer (==0.2.2) ; extra == 'test'
|
||
|
|
Provides-Extra: webpdf
|
||
|
|
Requires-Dist: pyppeteer (==0.2.2) ; extra == 'webpdf'
|
||
|
|
|
||
|
|
# nbconvert
|
||
|
|
### Jupyter Notebook Conversion
|
||
|
|
|
||
|
|
[](https://groups.google.com/forum/#!forum/jupyter)
|
||
|
|
[](https://travis-ci.org/jupyter/nbconvert)
|
||
|
|
[](https://nbconvert.readthedocs.io/en/latest/?badge=latest)
|
||
|
|
[](https://nbconvert.readthedocs.io/en/stable/?badge=stable)
|
||
|
|
[](https://codecov.io/github/jupyter/nbconvert?branch=master)
|
||
|
|
[](https://circleci.com/gh/jupyter/nbconvert/tree/master)
|
||
|
|
|
||
|
|
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
|
||
|
|
* PDF
|
||
|
|
* 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`.
|
||
|
|
|
||
|
|
## Python requirement
|
||
|
|
|
||
|
|
Nbconvert 6.0 provides limited support for Python 3.6 (3.6.1 or greater), and support will be dropped with nbconvert 6.1. Limited support means we will test and run CI on Python 3.6.12 or higher. Issues that are found only affecting Python 3.6 are not guaranteed to be fixed. We recommend all users of nbconvert use Python 3.7 and higher.
|
||
|
|
|
||
|
|
## 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](https://nbconvert.readthedocs.io/en/latest/)
|
||
|
|
[[PDF](https://media.readthedocs.org/pdf/nbconvert/latest/nbconvert.pdf)]
|
||
|
|
- [nbconvert examples on GitHub](https://github.com/jupyter/nbconvert-examples)
|
||
|
|
- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html)
|
||
|
|
[[PDF](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf)]
|
||
|
|
|
||
|
|
## Technical Support
|
||
|
|
|
||
|
|
- [Issues and Bug Reports](https://github.com/jupyter/nbconvert/issues): A place to report
|
||
|
|
bugs or regressions found for nbconvert
|
||
|
|
- [Community Technical Support and Discussion - Discourse](https://discourse.jupyter.org/): 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
|
||
|
|
|
||
|
|
- [Jupyter mailing list](https://groups.google.com/forum/#!forum/jupyter)
|
||
|
|
- [Project Jupyter website](https://jupyter.org)
|
||
|
|
|
||
|
|
[Jinja]: http://jinja.pocoo.org/
|
||
|
|
|
||
|
|
|