Skip to main content

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

Project description

Binder Build Status Documentation Status image Python 3.7 Python 3.8 Python 3.9 Python 3.10 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.

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

Uploaded Source

Built Distribution

nbclient-0.6.6-py3-none-any.whl (71.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nbclient-0.6.6.tar.gz
  • Upload date:
  • Size: 78.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for nbclient-0.6.6.tar.gz
Algorithm Hash digest
SHA256 0df76a7961d99a681b4796c74a1f2553b9f998851acc01896dce064ad19a9027
MD5 62062d25b4c564995f13fdeacf16500d
BLAKE2b-256 bf530488846ed174a29049230be39db0fa56a699f269dfb340d1bc2491bf3536

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: nbclient-0.6.6-py3-none-any.whl
  • Upload date:
  • Size: 71.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for nbclient-0.6.6-py3-none-any.whl
Algorithm Hash digest
SHA256 09bae4ea2df79fa6bc50aeb8278d8b79d2036792824337fa6eee834afae17312
MD5 d090eb87e7d8482b22860c8a81955df8
BLAKE2b-256 6888a3f13adcf5708cf0d5f9c4c95e12d1527f6498d87b30d463b588bb466c15

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