nbexec

nbexec is a Jupyter extension for headless notebook execution. It adds a web API endpoint /api/executions to Jupyter notebook server which makes available to execute a notebook by requesting an HTTP request. It also allows you to define parameters in a notebook and give them at runtime (in each HTTP request).

nbexec publishes a documentation for a notebook in the URL path /execution_doc/<notebook_file> which shows the notebook description (written in markdown), parameters and the source code.

These features make possible to deploy your own API by just uploading a notebook.

Contents:

User Guide

• Getting Started
  • Basic Example
  • Machine Learning Example
• Notebook Parameters
  • Defining parameters with comment ‘nbexec: params’
  • Defining parameters with tag ‘params’
  • Default Values
  • Parameter Definition
  • How nbexec deals with it
• Execution API
  • Execution Model
  • Execution Life Cycle
  • API Spec
  • Progress Payload
  • Output File
  • Authentication
  • Limitations
• Execution Document
  • Notebook Description
  • Parameters Section
  • Usage Examples
  • Notebook Page
• Related Work

See also

Jupyter Documentation

The Jupyter documentation provides information about the Notebook code and other Jupyter sub-projects.