|
|
- Metadata-Version: 2.1
- Name: nbconvert
- Version: 5.6.1
- 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 :: 2.7
- Classifier: Programming Language :: Python :: 3
- Classifier: Programming Language :: Python :: 3.5
- Classifier: Programming Language :: Python :: 3.6
- Classifier: Programming Language :: Python :: 3.7
- Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*
- Description-Content-Type: text/markdown
- Requires-Dist: mistune (<2,>=0.8.1)
- Requires-Dist: jinja2 (>=2.4)
- Requires-Dist: 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
- Provides-Extra: all
- Requires-Dist: pytest ; extra == 'all'
- Requires-Dist: pytest-cov ; extra == 'all'
- Requires-Dist: ipykernel ; extra == 'all'
- Requires-Dist: jupyter-client (>=5.3.1) ; extra == 'all'
- Requires-Dist: ipywidgets (>=7) ; extra == 'all'
- Requires-Dist: pebble ; 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: sphinxcontrib-github-alt ; extra == 'all'
- Requires-Dist: ipython ; extra == 'all'
- Requires-Dist: mock ; (python_version < "3.4") and 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: sphinxcontrib-github-alt ; extra == 'docs'
- Requires-Dist: ipython ; extra == 'docs'
- Requires-Dist: jupyter-client (>=5.3.1) ; extra == 'docs'
- Provides-Extra: execute
- Requires-Dist: jupyter-client (>=5.3.1) ; extra == 'execute'
- 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: ipykernel ; extra == 'test'
- Requires-Dist: jupyter-client (>=5.3.1) ; extra == 'test'
- Requires-Dist: ipywidgets (>=7) ; extra == 'test'
- Requires-Dist: pebble ; extra == 'test'
- Requires-Dist: mock ; (python_version < "3.4") and extra == 'test'
-
- # 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)
- [](http://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`.
-
- ## 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
-
- - [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)
- - [Issues](https://github.com/jupyter/nbconvert/issues)
- - [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter)
- - [Project Jupyter website](https://jupyter.org)
- - [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html)
- [[PDF](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf)]
-
-
- [Jinja]: http://jinja.pocoo.org/
-
-
|
