Skip to main content

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

Project description

Binder Build Status Documentation Status image Python 3.6 Python 3.7 Python 3.8 Python 3.9 Code style: black

nbclient

NBClient, a client library for programmatic notebook execution, is a tool for running Jupyter Notebooks in different execution contexts. NBClient was spun out of nbconvert's former ExecutePreprocessor.

NBClient lets you execute notebooks.

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

Uploaded Source

Built Distribution

nbclient-0.5.3-py3-none-any.whl (82.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nbclient-0.5.3.tar.gz
  • Upload date:
  • Size: 78.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.6.0.post20210108 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.9.1

File hashes

Hashes for nbclient-0.5.3.tar.gz
Algorithm Hash digest
SHA256 db17271330c68c8c88d46d72349e24c147bb6f34ec82d8481a8f025c4d26589c
MD5 fa28a952fe19d2335000ecfb6acadb6e
BLAKE2b-256 1195894f0f5e1671ffce42d22400717058c0a5e37d288a55427ef6ec605f1db6

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: nbclient-0.5.3-py3-none-any.whl
  • Upload date:
  • Size: 82.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.6.0.post20210108 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.9.1

File hashes

Hashes for nbclient-0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e79437364a2376892b3f46bedbf9b444e5396cfb1bc366a472c37b48e9551500
MD5 1fef49779fb75f9bc520d0e8ce27f961
BLAKE2b-256 22a6f3a01a5c1a0e72d1d064f33d4cd9c3a782010f48f48f47f256d0b438994a

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