METADATA 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  1. Metadata-Version: 2.4
  2. Name: nbclient
  3. Version: 0.10.4
  4. Summary: A client library for executing notebooks. Formerly nbconvert's ExecutePreprocessor.
  5. Project-URL: Documentation, https://nbclient.readthedocs.io
  6. Project-URL: Funding, https://numfocus.org/
  7. Project-URL: Homepage, https://jupyter.org
  8. Project-URL: Source, https://github.com/jupyter/nbclient
  9. Project-URL: Tracker, https://github.com/jupyter/nbclient/issues
  10. Author-email: Jupyter Development Team <jupyter@googlegroups.com>
  11. License: BSD 3-Clause License
  12. Copyright (c) 2020-, Jupyter Development Team
  13. All rights reserved.
  14. Redistribution and use in source and binary forms, with or without
  15. modification, are permitted provided that the following conditions are met:
  16. 1. Redistributions of source code must retain the above copyright notice, this
  17. list of conditions and the following disclaimer.
  18. 2. Redistributions in binary form must reproduce the above copyright notice,
  19. this list of conditions and the following disclaimer in the documentation
  20. and/or other materials provided with the distribution.
  21. 3. Neither the name of the copyright holder nor the names of its
  22. contributors may be used to endorse or promote products derived from
  23. this software without specific prior written permission.
  24. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25. AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26. IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  27. DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  28. FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29. DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30. SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  31. CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  32. OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33. OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34. License-File: LICENSE
  35. Keywords: executor,jupyter,notebook,pipeline
  36. Classifier: Intended Audience :: Developers
  37. Classifier: Intended Audience :: Science/Research
  38. Classifier: Intended Audience :: System Administrators
  39. Classifier: License :: OSI Approved :: BSD License
  40. Classifier: Programming Language :: Python
  41. Classifier: Programming Language :: Python :: 3
  42. Classifier: Programming Language :: Python :: 3.10
  43. Classifier: Programming Language :: Python :: 3.11
  44. Classifier: Programming Language :: Python :: 3.12
  45. Classifier: Programming Language :: Python :: 3.13
  46. Classifier: Programming Language :: Python :: 3.14
  47. Requires-Python: >=3.10.0
  48. Requires-Dist: jupyter-client>=6.1.12
  49. Requires-Dist: jupyter-core!=5.0.*,>=4.12
  50. Requires-Dist: nbformat>=5.1.3
  51. Requires-Dist: traitlets>=5.4
  52. Provides-Extra: dev
  53. Requires-Dist: pre-commit; extra == 'dev'
  54. Provides-Extra: docs
  55. Requires-Dist: autodoc-traits; extra == 'docs'
  56. Requires-Dist: flaky; extra == 'docs'
  57. Requires-Dist: ipykernel>=6.19.3; extra == 'docs'
  58. Requires-Dist: ipython; extra == 'docs'
  59. Requires-Dist: ipywidgets; extra == 'docs'
  60. Requires-Dist: mock; extra == 'docs'
  61. Requires-Dist: moto; extra == 'docs'
  62. Requires-Dist: myst-parser; extra == 'docs'
  63. Requires-Dist: nbconvert>=7.1.0; extra == 'docs'
  64. Requires-Dist: pytest-asyncio>=1.3.0; extra == 'docs'
  65. Requires-Dist: pytest-cov>=4.0; extra == 'docs'
  66. Requires-Dist: pytest<10,>=9.0.1; extra == 'docs'
  67. Requires-Dist: sphinx-book-theme; extra == 'docs'
  68. Requires-Dist: sphinx>=1.7; extra == 'docs'
  69. Requires-Dist: sphinxcontrib-spelling; extra == 'docs'
  70. Requires-Dist: testpath; extra == 'docs'
  71. Requires-Dist: xmltodict; extra == 'docs'
  72. Provides-Extra: test
  73. Requires-Dist: flaky; extra == 'test'
  74. Requires-Dist: ipykernel>=6.19.3; extra == 'test'
  75. Requires-Dist: ipython; extra == 'test'
  76. Requires-Dist: ipywidgets; extra == 'test'
  77. Requires-Dist: nbconvert>=7.1.0; extra == 'test'
  78. Requires-Dist: pytest-asyncio>=1.3.0; extra == 'test'
  79. Requires-Dist: pytest-cov>=4.0; extra == 'test'
  80. Requires-Dist: pytest<10,>=9.0.1; extra == 'test'
  81. Requires-Dist: testpath; extra == 'test'
  82. Requires-Dist: xmltodict; extra == 'test'
  83. Description-Content-Type: text/markdown
  84. [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyter/nbclient/main?filepath=binder%2Frun_nbclient.ipynb)
  85. [![Build Status](https://github.com/jupyter/nbclient/workflows/CI/badge.svg)](https://github.com/jupyter/nbclient/actions)
  86. [![Documentation Status](https://readthedocs.org/projects/nbclient/badge/?version=latest)](https://nbclient.readthedocs.io/en/latest/?badge=latest)
  87. [![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/)
  88. [![Python 3.8](https://img.shields.io/badge/python-3.8-blue.svg)](https://www.python.org/downloads/release/python-380/)
  89. [![Python 3.9](https://img.shields.io/badge/python-3.9-blue.svg)](https://www.python.org/downloads/release/python-390/)
  90. [![Python 3.10](https://img.shields.io/badge/python-3.10-blue.svg)](https://www.python.org/downloads/release/python-3100/)
  91. [![Python 3.11](https://img.shields.io/badge/python-3.11-blue.svg)](https://www.python.org/downloads/release/python-3110/)
  92. [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
  93. # nbclient
  94. **NBClient** lets you **execute** notebooks.
  95. A client library for programmatic notebook execution, **NBClient** is a tool for running Jupyter Notebooks in
  96. different execution contexts, including the command line.
  97. ## Interactive Demo
  98. To demo **NBClient** interactively, click this Binder badge to start the demo:
  99. [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyter/nbclient/main?filepath=binder%2Frun_nbclient.ipynb)
  100. ## Installation
  101. In a terminal, run:
  102. ```
  103. python3 -m pip install nbclient
  104. ```
  105. ## Documentation
  106. See [ReadTheDocs](https://nbclient.readthedocs.io/en/latest/) for more in-depth details about the project and the
  107. [API Reference](https://nbclient.readthedocs.io/en/latest/reference/index.html).
  108. ## Python Version Support
  109. This library currently supports Python 3.6+ versions. As minor Python
  110. versions are officially sunset by the Python org, nbclient will similarly
  111. drop support in the future.
  112. ## Origins
  113. This library used to be part of the [nbconvert](https://nbconvert.readthedocs.io/en/latest/) project. NBClient extracted nbconvert's `ExecutePreprocessor`into its own library for easier updating and importing by downstream libraries and applications.
  114. ## Relationship to JupyterClient
  115. NBClient and JupyterClient are distinct projects.
  116. `jupyter_client` is a client library for the jupyter protocol. Specifically, `jupyter_client` provides the Python API
  117. for starting, managing and communicating with Jupyter kernels.
  118. While, nbclient allows notebooks to be run in different execution contexts.
  119. ## About the Jupyter Development Team
  120. The Jupyter Development Team is the set of all contributors to the Jupyter project.
  121. This includes all of the Jupyter subprojects.
  122. The core team that coordinates development on GitHub can be found here:
  123. https://github.com/jupyter/.
  124. ## Our Copyright Policy
  125. Jupyter uses a shared copyright model. Each contributor maintains copyright
  126. over their contributions to Jupyter. But, it is important to note that these
  127. contributions are typically only changes to the repositories. Thus, the Jupyter
  128. source code, in its entirety is not the copyright of any single person or
  129. institution. Instead, it is the collective copyright of the entire Jupyter
  130. Development Team. If individual contributors want to maintain a record of what
  131. changes/contributions they have specific copyright on, they should indicate
  132. their copyright in the commit message of the change, when they commit the
  133. change to one of the Jupyter repositories.
  134. With this in mind, the following banner should be used in any source code file
  135. to indicate the copyright and license terms:
  136. ```
  137. # Copyright (c) Jupyter Development Team.
  138. # Distributed under the terms of the Modified BSD License.
  139. ```