Skip to main content

A client library for executing notebooks. Formerly nbconvert's ExecutePreprocessor.

Project description

Binder Build Status Documentation Status image Python 3.6 Python 3.7 Python 3.8 Python 3.9 Code style: black


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's former ExecutePreprocessor.

NBClient lets you execute notebooks.

Interactive Demo

To demo NBClient interactively, click this Binder badge to start the demo:



In a terminal, run:

python3 -m pip install nbclient


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.


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.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for nbclient, version 0.5.4
Filename, size File type Python version Upload date Hashes
Filename, size nbclient-0.5.4-py3-none-any.whl (66.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size nbclient-0.5.4.tar.gz (70.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page