METADATA 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219
  1. Metadata-Version: 2.4
  2. Name: nbconvert
  3. Version: 7.17.1
  4. Summary: Convert Jupyter Notebooks (.ipynb files) to other formats.
  5. Project-URL: Homepage, https://jupyter.org
  6. Author-email: Jupyter Development Team <jupyter@googlegroups.com>
  7. License: BSD 3-Clause License
  8. - Copyright (c) 2001-2015, IPython Development Team
  9. - Copyright (c) 2015-, Jupyter Development Team
  10. All rights reserved.
  11. Redistribution and use in source and binary forms, with or without
  12. modification, are permitted provided that the following conditions are met:
  13. 1. Redistributions of source code must retain the above copyright notice, this
  14. list of conditions and the following disclaimer.
  15. 2. Redistributions in binary form must reproduce the above copyright notice,
  16. this list of conditions and the following disclaimer in the documentation
  17. and/or other materials provided with the distribution.
  18. 3. Neither the name of the copyright holder nor the names of its
  19. contributors may be used to endorse or promote products derived from
  20. this software without specific prior written permission.
  21. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  22. AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23. IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  24. DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  25. FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26. DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  27. SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  28. CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  29. OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30. OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31. License-File: LICENSE
  32. Keywords: Interactive,Interpreter,Shell,Web
  33. Classifier: Intended Audience :: Developers
  34. Classifier: Intended Audience :: Science/Research
  35. Classifier: Intended Audience :: System Administrators
  36. Classifier: License :: OSI Approved :: BSD License
  37. Classifier: Programming Language :: Python
  38. Classifier: Programming Language :: Python :: 3
  39. Requires-Python: >=3.9
  40. Requires-Dist: beautifulsoup4
  41. Requires-Dist: bleach[css]!=5.0.0
  42. Requires-Dist: defusedxml
  43. Requires-Dist: importlib-metadata>=3.6; python_version < '3.10'
  44. Requires-Dist: jinja2>=3.0
  45. Requires-Dist: jupyter-core>=4.7
  46. Requires-Dist: jupyterlab-pygments
  47. Requires-Dist: markupsafe>=2.0
  48. Requires-Dist: mistune<4,>=2.0.3
  49. Requires-Dist: nbclient>=0.5.0
  50. Requires-Dist: nbformat>=5.7
  51. Requires-Dist: packaging
  52. Requires-Dist: pandocfilters>=1.4.1
  53. Requires-Dist: pygments>=2.4.1
  54. Requires-Dist: traitlets>=5.1
  55. Provides-Extra: all
  56. Requires-Dist: flaky; extra == 'all'
  57. Requires-Dist: intersphinx-registry; extra == 'all'
  58. Requires-Dist: ipykernel; extra == 'all'
  59. Requires-Dist: ipython; extra == 'all'
  60. Requires-Dist: ipywidgets>=7.5; extra == 'all'
  61. Requires-Dist: myst-parser; extra == 'all'
  62. Requires-Dist: nbsphinx>=0.2.12; extra == 'all'
  63. Requires-Dist: playwright; extra == 'all'
  64. Requires-Dist: pydata-sphinx-theme; extra == 'all'
  65. Requires-Dist: pyqtwebengine>=5.15; extra == 'all'
  66. Requires-Dist: pytest>=7; extra == 'all'
  67. Requires-Dist: sphinx>=5.0.2; extra == 'all'
  68. Requires-Dist: sphinxcontrib-spelling; extra == 'all'
  69. Requires-Dist: tornado>=6.1; extra == 'all'
  70. Provides-Extra: docs
  71. Requires-Dist: intersphinx-registry; extra == 'docs'
  72. Requires-Dist: ipykernel; extra == 'docs'
  73. Requires-Dist: ipython; extra == 'docs'
  74. Requires-Dist: myst-parser; extra == 'docs'
  75. Requires-Dist: nbsphinx>=0.2.12; extra == 'docs'
  76. Requires-Dist: pydata-sphinx-theme; extra == 'docs'
  77. Requires-Dist: sphinx>=5.0.2; extra == 'docs'
  78. Requires-Dist: sphinxcontrib-spelling; extra == 'docs'
  79. Provides-Extra: qtpdf
  80. Requires-Dist: pyqtwebengine>=5.15; extra == 'qtpdf'
  81. Provides-Extra: qtpng
  82. Requires-Dist: pyqtwebengine>=5.15; extra == 'qtpng'
  83. Provides-Extra: serve
  84. Requires-Dist: tornado>=6.1; extra == 'serve'
  85. Provides-Extra: test
  86. Requires-Dist: flaky; extra == 'test'
  87. Requires-Dist: ipykernel; extra == 'test'
  88. Requires-Dist: ipywidgets>=7.5; extra == 'test'
  89. Requires-Dist: pytest>=7; extra == 'test'
  90. Provides-Extra: webpdf
  91. Requires-Dist: playwright; extra == 'webpdf'
  92. Description-Content-Type: text/markdown
  93. # nbconvert
  94. ### Jupyter Notebook Conversion
  95. [![Build Status](https://github.com/jupyter/nbconvert/actions/workflows/tests.yml/badge.svg?query=branch%3Amain++)](https://github.com/jupyter/nbconvert/actions/workflows/tests.yml/badge.svg?query=branch%3Amain++)
  96. [![Documentation Status](https://readthedocs.org/projects/nbconvert/badge/?version=latest)](https://nbconvert.readthedocs.io/en/latest/?badge=latest)
  97. The **nbconvert** tool, `jupyter nbconvert`, converts notebooks to various other
  98. formats via [Jinja] templates. The nbconvert tool allows you to convert an
  99. `.ipynb` notebook file into various static formats including:
  100. - HTML
  101. - LaTeX
  102. - PDF
  103. - Reveal JS
  104. - Markdown (md)
  105. - ReStructured Text (rst)
  106. - executable script
  107. ## Usage
  108. From the command line, use nbconvert to convert a Jupyter notebook (_input_) to a
  109. a different format (_output_). The basic command structure is:
  110. ```
  111. $ jupyter nbconvert --to <output format> <input notebook>
  112. ```
  113. where `<output format>` is the desired output format and `<input notebook>` is the
  114. filename of the Jupyter notebook.
  115. ### Example: Convert a notebook to HTML
  116. Convert Jupyter notebook file, `mynotebook.ipynb`, to HTML using:
  117. ```
  118. $ jupyter nbconvert --to html mynotebook.ipynb
  119. ```
  120. This command creates an HTML output file named `mynotebook.html`.
  121. ## Dev Install
  122. Check if pandoc is installed (`pandoc --version`); if needed, install:
  123. ```
  124. sudo apt-get install pandoc
  125. ```
  126. Or
  127. ```
  128. brew install pandoc
  129. ```
  130. Install nbconvert for development using:
  131. ```
  132. git clone https://github.com/jupyter/nbconvert.git
  133. cd nbconvert
  134. pip install -e .
  135. ```
  136. Running the tests after a dev install above:
  137. ```
  138. pip install nbconvert[test]
  139. py.test --pyargs nbconvert
  140. ```
  141. ## Documentation
  142. - [Documentation for Jupyter nbconvert](https://nbconvert.readthedocs.io/en/latest/)
  143. - [nbconvert examples on GitHub](https://github.com/jupyter/nbconvert-examples)
  144. - [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html)
  145. ## Technical Support
  146. - [Issues and Bug Reports](https://github.com/jupyter/nbconvert/issues): A place to report
  147. bugs or regressions found for nbconvert
  148. - [Community Technical Support and Discussion - Discourse](https://discourse.jupyter.org/): A place for
  149. installation, configuration, and troubleshooting assistannce by the Jupyter community.
  150. As a non-profit project and maintainers who are primarily volunteers, we encourage you
  151. to ask questions and share your knowledge on Discourse.
  152. ## Jupyter Resources
  153. - [Jupyter mailing list](https://groups.google.com/forum/#!forum/jupyter)
  154. - [Project Jupyter website](https://jupyter.org)
  155. ## About the Jupyter Development Team
  156. The Jupyter Development Team is the set of all contributors to the Jupyter project.
  157. This includes all of the Jupyter subprojects.
  158. The core team that coordinates development on GitHub can be found here:
  159. https://github.com/jupyter/.
  160. ## Our Copyright Policy
  161. Jupyter uses a shared copyright model. Each contributor maintains copyright
  162. over their contributions to Jupyter. But, it is important to note that these
  163. contributions are typically only changes to the repositories. Thus, the Jupyter
  164. source code, in its entirety is not the copyright of any single person or
  165. institution. Instead, it is the collective copyright of the entire Jupyter
  166. Development Team. If individual contributors want to maintain a record of what
  167. changes/contributions they have specific copyright on, they should indicate
  168. their copyright in the commit message of the change, when they commit the
  169. change to one of the Jupyter repositories.
  170. With this in mind, the following banner should be used in any source code file
  171. to indicate the copyright and license terms:
  172. ```
  173. # Copyright (c) Jupyter Development Team.
  174. # Distributed under the terms of the Modified BSD License.
  175. ```
  176. [jinja]: http://jinja.pocoo.org/