Skip to main content

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

Project description

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.

Project details


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.9.1.tar.gz (60.9 kB view details)

Uploaded Source

Built Distribution

nbclient-0.9.1-py3-none-any.whl (24.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nbclient-0.9.1.tar.gz
  • Upload date:
  • Size: 60.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.11.8

File hashes

Hashes for nbclient-0.9.1.tar.gz
Algorithm Hash digest
SHA256 4f7b78c6c2a380e228f8a3bb469b847cb24e5b8ad6fda410691b5621e05ce5a2
MD5 a63aa6ade0b49ba976061b9c98fe8402
BLAKE2b-256 79143d476e879ee9e1d6cfe798e13d39ab4b0e5102b1970dfbdc7dbe8f75a1b6

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: nbclient-0.9.1-py3-none-any.whl
  • Upload date:
  • Size: 24.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.11.8

File hashes

Hashes for nbclient-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2c50a866e8dd6c5f655de47d2e252c82d2ebe978574e760ac229f5950593a434
MD5 45e0077102cb2c57f2b78a7b4cd0118e
BLAKE2b-256 ad41c3bdff990ded5607321af31e284223eb5fa702e375332fd805f2a9163522

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page