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

Uploaded Source

Built Distribution

nbclient-0.6.3-py3-none-any.whl (71.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nbclient-0.6.3.tar.gz
  • Upload date:
  • Size: 77.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for nbclient-0.6.3.tar.gz
Algorithm Hash digest
SHA256 b80726fc1fb89a0e8f8be1e77e28d0026b1e8ed90bc143c8a0c7622e4f8cdd9e
MD5 895b6541e27a64eb33728c9387c65327
BLAKE2b-256 a62144d5915f077e0180b56527c9df5f5e9fc038ea4036f918cb12a5576d4536

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nbclient-0.6.3-py3-none-any.whl
  • Upload date:
  • Size: 71.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for nbclient-0.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2747ac9b385720d8a6c34f2f71e72cbe64aec6cadaadcc064a4df0b0e99c5874
MD5 1fa9beaee2e4a7276ae5d2b7894cbe37
BLAKE2b-256 33b7f94f83283e54d0729994bd46928b06451448b4a08e7476e6950fd1c8a2b2

See more details on using hashes here.

Supported by

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