Skip to main content

Binder Build Status Documentation Status Python 3.7 Python 3.8 Python 3.9 Python 3.10 Python 3.11 Code style: 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

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.

Download files

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

Source Distribution

nbclient-0.10.1.tar.gz (62.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nbclient-0.10.1-py3-none-any.whl (25.3 kB view details)

Uploaded Python 3

File details

Details for the file nbclient-0.10.1.tar.gz.

File metadata

  • Download URL: nbclient-0.10.1.tar.gz
  • Upload date:
  • Size: 62.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for nbclient-0.10.1.tar.gz
Algorithm Hash digest
SHA256 3e93e348ab27e712acd46fccd809139e356eb9a31aab641d1a7991a6eb4e6f68
MD5 a4e9c020c34d065479b04f25fb17f7e2
BLAKE2b-256 06db25929926860ba8a3f6123d2d0a235e558e0e4be7b46e9db063a7dfefa0a2

See more details on using hashes here.

File details

Details for the file nbclient-0.10.1-py3-none-any.whl.

File metadata

  • Download URL: nbclient-0.10.1-py3-none-any.whl
  • Upload date:
  • Size: 25.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for nbclient-0.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 949019b9240d66897e442888cfb618f69ef23dc71c01cb5fced8499c2cfc084d
MD5 b0f70e3239145e8931a2975178639ff5
BLAKE2b-256 261aed6d1299b1a00c1af4a033fdee565f533926d819e084caf0d2832f6f87c6

See more details on using hashes here.

Release history Release notifications | RSS feed

0.11.0

2 files

0.10.4

2 files

0.10.3

2 files

0.10.2

2 files

This release

0.10.1 This release

2 files

0.10.0

2 files

0.9.1

2 files

0.9.0

2 files

0.8.0

2 files

0.7.4

2 files

0.7.3

2 files

0.7.2

2 files

0.7.1

2 files

0.7.0

2 files

0.6.8

2 files

0.6.7

2 files

0.6.6

2 files

0.6.5

2 files

0.6.4

2 files

0.6.3

2 files

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

0.5.13

2 files

0.5.12

2 files

0.5.11

2 files

0.5.10

2 files

0.5.9

2 files

0.5.8

2 files

0.5.6

2 files

0.5.5

2 files

0.5.4

2 files

0.5.3

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.3

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.1

2 files

0.3.0

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page