135 lines
5.9 KiB
Text
135 lines
5.9 KiB
Text
Metadata-Version: 2.1
|
|
Name: nbclient
|
|
Version: 0.5.1
|
|
Summary: A client library for executing notebooks. Formerly nbconvert's ExecutePreprocessor.
|
|
Home-page: https://jupyter.org
|
|
Author: Jupyter Development Team
|
|
Author-email: jupyter@googlegroups.com
|
|
License: BSD
|
|
Project-URL: Documentation, https://nbclient.readthedocs.io
|
|
Project-URL: Funding, https://numfocus.org/
|
|
Project-URL: Source, https://github.com/jupyter/nbclient
|
|
Project-URL: Tracker, https://github.com/jupyter/nbclient/issues
|
|
Keywords: jupyter,pipeline,notebook,executor
|
|
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
|
|
Classifier: Programming Language :: Python :: 3.6
|
|
Classifier: Programming Language :: Python :: 3.7
|
|
Classifier: Programming Language :: Python :: 3.8
|
|
Requires-Python: >=3.6
|
|
Description-Content-Type: text/markdown
|
|
Requires-Dist: traitlets (>=4.2)
|
|
Requires-Dist: jupyter-client (>=6.1.5)
|
|
Requires-Dist: nbformat (>=5.0)
|
|
Requires-Dist: async-generator
|
|
Requires-Dist: nest-asyncio
|
|
Provides-Extra: dev
|
|
Requires-Dist: codecov ; extra == 'dev'
|
|
Requires-Dist: coverage ; extra == 'dev'
|
|
Requires-Dist: ipython ; extra == 'dev'
|
|
Requires-Dist: ipykernel ; extra == 'dev'
|
|
Requires-Dist: ipywidgets ; extra == 'dev'
|
|
Requires-Dist: pytest (>=4.1) ; extra == 'dev'
|
|
Requires-Dist: pytest-cov (>=2.6.1) ; extra == 'dev'
|
|
Requires-Dist: check-manifest ; extra == 'dev'
|
|
Requires-Dist: flake8 ; extra == 'dev'
|
|
Requires-Dist: mypy ; extra == 'dev'
|
|
Requires-Dist: tox ; extra == 'dev'
|
|
Requires-Dist: bumpversion ; extra == 'dev'
|
|
Requires-Dist: xmltodict ; extra == 'dev'
|
|
Requires-Dist: pip (>=18.1) ; extra == 'dev'
|
|
Requires-Dist: wheel (>=0.31.0) ; extra == 'dev'
|
|
Requires-Dist: setuptools (>=38.6.0) ; extra == 'dev'
|
|
Requires-Dist: twine (>=1.11.0) ; extra == 'dev'
|
|
Requires-Dist: black ; (python_version >= "3.6") and extra == 'dev'
|
|
Provides-Extra: sphinx
|
|
Requires-Dist: Sphinx (>=1.7) ; extra == 'sphinx'
|
|
Requires-Dist: sphinx-book-theme ; extra == 'sphinx'
|
|
Requires-Dist: mock ; extra == 'sphinx'
|
|
Requires-Dist: moto ; extra == 'sphinx'
|
|
Requires-Dist: myst-parser ; extra == 'sphinx'
|
|
Provides-Extra: test
|
|
Requires-Dist: codecov ; extra == 'test'
|
|
Requires-Dist: coverage ; extra == 'test'
|
|
Requires-Dist: ipython ; extra == 'test'
|
|
Requires-Dist: ipykernel ; extra == 'test'
|
|
Requires-Dist: ipywidgets ; extra == 'test'
|
|
Requires-Dist: pytest (>=4.1) ; extra == 'test'
|
|
Requires-Dist: pytest-cov (>=2.6.1) ; extra == 'test'
|
|
Requires-Dist: check-manifest ; extra == 'test'
|
|
Requires-Dist: flake8 ; extra == 'test'
|
|
Requires-Dist: mypy ; extra == 'test'
|
|
Requires-Dist: tox ; extra == 'test'
|
|
Requires-Dist: bumpversion ; extra == 'test'
|
|
Requires-Dist: xmltodict ; extra == 'test'
|
|
Requires-Dist: pip (>=18.1) ; extra == 'test'
|
|
Requires-Dist: wheel (>=0.31.0) ; extra == 'test'
|
|
Requires-Dist: setuptools (>=38.6.0) ; extra == 'test'
|
|
Requires-Dist: twine (>=1.11.0) ; extra == 'test'
|
|
Requires-Dist: black ; (python_version >= "3.6") and extra == 'test'
|
|
|
|
[](https://mybinder.org/v2/gh/jupyter/nbclient/master?filepath=binder%2Frun_nbclient.ipynb)
|
|
[](https://travis-ci.org/jupyter/nbclient)
|
|
[](https://github.com/jupyter/nbclient/actions)
|
|
[](https://nbclient.readthedocs.io/en/latest/?badge=latest)
|
|
[](https://codecov.io/github/jupyter/nbclient?branch=master)
|
|
[](https://www.python.org/downloads/release/python-360/)
|
|
[](https://www.python.org/downloads/release/python-370/)
|
|
[](https://www.python.org/downloads/release/python-380/)
|
|
[](https://github.com/ambv/black)
|
|
|
|
# nbclient
|
|
|
|
**NBClient**, a client library for programmatic notebook execution, is a tool for running Jupyter Notebooks in
|
|
different execution contexts. NBClient was spun out of [nbconvert](https://nbconvert.readthedocs.io/en/latest/)'s
|
|
former `ExecutePreprocessor`.
|
|
|
|
**NBClient** lets you **execute** notebooks.
|
|
|
|
## Interactive Demo
|
|
|
|
To demo **NBClient** interactively, click this Binder badge to start the demo:
|
|
|
|
[](https://mybinder.org/v2/gh/jupyter/nbclient/master?filepath=binder%2Frun_nbclient.ipynb)
|
|
|
|
## Installation
|
|
|
|
In a terminal, run:
|
|
|
|
python3 -m pip install nbclient
|
|
|
|
## Documentation
|
|
|
|
See [ReadTheDocs](https://nbclient.readthedocs.io/en/latest/) for more in-depth details about the project and the
|
|
[API Reference](https://nbclient.readthedocs.io/en/latest/reference/index.html).
|
|
|
|
|
|
## Python Version Support
|
|
|
|
This library currently supports Python 3.6+ versions. As minor Python
|
|
versions are officially sunset by the Python org, nbclient will similarly
|
|
drop support in the future.
|
|
|
|
## Origins
|
|
|
|
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.
|
|
|
|
## Relationship to JupyterClient
|
|
|
|
NBClient and JupyterClient are distinct projects.
|
|
|
|
`jupyter_client` is a client library for the jupyter protocol. Specifically, `jupyter_client` provides the Python API
|
|
for starting, managing and communicating with Jupyter kernels.
|
|
|
|
While, nbclient allows notebooks to be run in different execution contexts.
|
|
|
|
|