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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for nbclient-0.6.8.tar.gz
Algorithm Hash digest
SHA256 268fde3457cafe1539e32eb1c6d796bbedb90b9e92bacd3e43d83413734bb0e8
MD5 fe3d0f58588b245d11b4b3e149a98964
BLAKE2b-256 0121917a25fbc2b37ed37135be97efb4c98526008505451ffa841adcd7d11ed5

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: nbclient-0.6.8-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.6

File hashes

Hashes for nbclient-0.6.8-py3-none-any.whl
Algorithm Hash digest
SHA256 7cce8b415888539180535953f80ea2385cdbb444944cdeb73ffac1556fdbc228
MD5 e44e9bddd11a4dbccf52323fde72f581
BLAKE2b-256 e61dde31c4139603b3f43147dca571de7d1928bd23d5c674865342bd457ec419

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