Jupyter Client 7.1

This package provides the Python API for starting, managing and communicating with Jupyter kernels.

Important

This document contains the authoritative description of the Jupyter messaging protocol. All developers are strongly encouraged to keep it updated as the implementation evolves, so that we have a single common reference for all protocol details.

User Documentation

• Messaging in Jupyter
  • Versioning
  • Introduction
  • General Message Format
  • Compatibility
  • The Wire Protocol
  • Python API
  • Messages on the shell (ROUTER/DEALER) channel
  • Messages on the Control (ROUTER/DEALER) channel
  • Messages on the IOPub (PUB/SUB) channel
  • Messages on the stdin (ROUTER/DEALER) channel
  • Heartbeat for kernels
  • Custom Messages
  • Notes

Developer documentation

• Making kernels for Jupyter
  • Connection files
  • Handling messages
  • Kernel specs
• Making simple Python wrapper kernels
  • Required steps
  • Example
  • Optional steps
• Customizing the kernel’s runtime environment
  • Kernel Provisioning
  • The kernel manager and kernel provisioner relationship
  • Discovery
  • Backwards Compatibility
  • Implementing a custom provisioner

API

• jupyter_client API
  • kernelspec - discovering kernels
  • manager - starting, stopping, signalling
  • client - communicating with kernels
  • kernel provisioner apis

Changes

• Changes in Jupyter Client {#changelog}
  • 7.1.0
  • 7.0.6
  • 7.0.5
  • 7.0.4
  • 7.0.3
  • 7.0.2
  • 7.0.1
  • 7.0.0
  • 6.2.0
  • 6.1.13
  • 6.1.12
  • 6.1.11
  • 6.1.10
  • 6.1.9
  • 6.1.8
  • 6.1.6
  • 6.1.5
  • 6.1.4
  • 6.1.3
  • 6.1.2
  • 6.1.1
  • 6.1.0
  • 6.0.0
  • 5.3.5
  • 5.3.4
  • 5.3.3
  • 5.3.2
  • 5.3.1
  • 5.3.0
  • 5.2.4
  • 5.2.3
  • 5.2.2
  • 5.2.1
  • 5.2
  • 5.1
  • 5.0
  • 4.4
  • 4.3
  • 4.2
  • 4.1
  • 4.0
• Migration Guide
  • Jupyter Client 6.0 to 7.0

Indices and tables

• Index

• Module Index

• Search Page