You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
112 lines
5.0 KiB
112 lines
5.0 KiB
Metadata-Version: 2.1
|
|
Name: nbclient
|
|
Version: 0.6.6
|
|
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.7
|
|
Classifier: Programming Language :: Python :: 3.8
|
|
Classifier: Programming Language :: Python :: 3.9
|
|
Classifier: Programming Language :: Python :: 3.10
|
|
Requires-Python: >=3.7.0
|
|
Description-Content-Type: text/markdown
|
|
License-File: LICENSE
|
|
Requires-Dist: jupyter-client (>=6.1.5)
|
|
Requires-Dist: nbformat (>=5.0)
|
|
Requires-Dist: nest-asyncio
|
|
Requires-Dist: traitlets (>=5.2.2)
|
|
Provides-Extra: sphinx
|
|
Requires-Dist: autodoc-traits ; extra == 'sphinx'
|
|
Requires-Dist: mock ; extra == 'sphinx'
|
|
Requires-Dist: moto ; extra == 'sphinx'
|
|
Requires-Dist: myst-parser ; extra == 'sphinx'
|
|
Requires-Dist: Sphinx (>=1.7) ; extra == 'sphinx'
|
|
Requires-Dist: sphinx-book-theme ; extra == 'sphinx'
|
|
Provides-Extra: test
|
|
Requires-Dist: black ; extra == 'test'
|
|
Requires-Dist: check-manifest ; extra == 'test'
|
|
Requires-Dist: flake8 ; extra == 'test'
|
|
Requires-Dist: ipykernel ; extra == 'test'
|
|
Requires-Dist: ipython (<8.0.0) ; extra == 'test'
|
|
Requires-Dist: ipywidgets (<8.0.0) ; extra == 'test'
|
|
Requires-Dist: mypy ; extra == 'test'
|
|
Requires-Dist: pip (>=18.1) ; extra == 'test'
|
|
Requires-Dist: pre-commit ; extra == 'test'
|
|
Requires-Dist: pytest (>=4.1) ; extra == 'test'
|
|
Requires-Dist: pytest-asyncio ; extra == 'test'
|
|
Requires-Dist: pytest-cov (>=2.6.1) ; extra == 'test'
|
|
Requires-Dist: setuptools (>=60.0) ; extra == 'test'
|
|
Requires-Dist: testpath ; extra == 'test'
|
|
Requires-Dist: twine (>=1.11.0) ; extra == 'test'
|
|
Requires-Dist: xmltodict ; extra == 'test'
|
|
|
|
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyter/nbclient/master?filepath=binder%2Frun_nbclient.ipynb)
|
|
[![Build Status](https://github.com/jupyter/nbclient/workflows/CI/badge.svg)](https://github.com/jupyter/nbclient/actions)
|
|
[![Documentation Status](https://readthedocs.org/projects/nbclient/badge/?version=latest)](https://nbclient.readthedocs.io/en/latest/?badge=latest)
|
|
[![image](https://codecov.io/github/jupyter/nbclient/coverage.svg?branch=master)](https://codecov.io/github/jupyter/nbclient?branch=master)
|
|
[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/)
|
|
[![Python 3.8](https://img.shields.io/badge/python-3.8-blue.svg)](https://www.python.org/downloads/release/python-380/)
|
|
[![Python 3.9](https://img.shields.io/badge/python-3.9-blue.svg)](https://www.python.org/downloads/release/python-390/)
|
|
[![Python 3.10](https://img.shields.io/badge/python-3.10-blue.svg)](https://www.python.org/downloads/release/python-3100/)
|
|
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
|
|
|
|
# nbclient
|
|
|
|
**NBClient** lets you **execute** notebooks.
|
|
|
|
A client library for programmatic notebook execution, **NBClient** is a tool for running Jupyter Notebooks in
|
|
different execution contexts, including the command line.
|
|
|
|
## Interactive Demo
|
|
|
|
To demo **NBClient** interactively, click this Binder badge to start the demo:
|
|
|
|
[![Binder](https://mybinder.org/badge_logo.svg)](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.
|