Welcome to 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. NBClient was spun out of nbconvert’s former ExecutePreprocessor.

Demo

To demo NBClient interactively, click the Binder link below:

Origins

This library used to be part of nbconvert and was extracted into its ownlibrary for easier updating and importing by downstream libraries and applications.

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.

Documentation

These pages guide you through the installation and usage of nbclient.

Documentation

• Installation
• Executing notebooks
• Changes in NBClient {#changelog}

API Reference

If you are looking for information about a specific function, class, or method, this documentation section will help you.

Table of Contents

• Reference
  • nbclient package
    • Subpackages
    • Submodules
    • nbclient.client module
    • nbclient.exceptions module
    • Module contents
  • Config file and command line options
    • Options
  • nbclient
    • nbclient package

Indices and tables

• Index

• Module Index

• Search Page