nbclient0.10.0
Published
A client library for executing notebooks. Formerly nbconvert's ExecutePreprocessor.
pip install nbclient
Package Downloads
Authors
Project URLs
Requires Python
>=3.8.0
Dependencies
- jupyter-client
>=6.1.12 - jupyter-core
!=5.0.*,>=4.12 - nbformat
>=5.1 - traitlets
>=5.4 - pre-commit
; extra == 'dev' - autodoc-traits
; extra == 'docs' - mock
; extra == 'docs' - moto
; extra == 'docs' - myst-parser
; extra == 'docs' - nbclient
[test]; extra == 'docs' - sphinx-book-theme
; extra == 'docs' - sphinx
>=1.7; extra == 'docs' - sphinxcontrib-spelling
; extra == 'docs' - flaky
; extra == 'test' - ipykernel
>=6.19.3; extra == 'test' - ipython
; extra == 'test' - ipywidgets
; extra == 'test' - nbconvert
>=7.0.0; extra == 'test' - pytest-asyncio
; extra == 'test' - pytest-cov
>=4.0; extra == 'test' - pytest
<8,>=7.0; extra == 'test' - testpath
; extra == 'test' - xmltodict
; extra == 'test'
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:
Installation
In a terminal, run:
python3 -m pip install nbclient
Documentation
See ReadTheDocs for more in-depth details about the project and the API Reference.
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 project. NBClient extracted nbconvert's ExecutePreprocessorinto 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.
About the Jupyter Development Team
The Jupyter Development Team is the set of all contributors to the Jupyter project. This includes all of the Jupyter subprojects.
The core team that coordinates development on GitHub can be found here: https://github.com/jupyter/.
Our Copyright Policy
Jupyter uses a shared copyright model. Each contributor maintains copyright over their contributions to Jupyter. But, it is important to note that these contributions are typically only changes to the repositories. Thus, the Jupyter source code, in its entirety is not the copyright of any single person or institution. Instead, it is the collective copyright of the entire Jupyter Development Team. If individual contributors want to maintain a record of what changes/contributions they have specific copyright on, they should indicate their copyright in the commit message of the change, when they commit the change to one of the Jupyter repositories.
With this in mind, the following banner should be used in any source code file to indicate the copyright and license terms:
# Copyright (c) Jupyter Development Team.
# Distributed under the terms of the Modified BSD License.