Jupyter Protocol 0.1

This package provides the Python API for message composition relevant to Jupyter kernels. For information related to the launch, communication and lifecycle management of Jupyter kernels, please refer to the Jupyter Kernel Management documentation.

Note

The information contained in this documentation also resides in the Jupyter Client documentation. The documentation will be consolidated at a future date. Please consider the Jupyter Client documentation as the authoritative description relative to the messaging protocol until further notice.

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 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

Changes

• Changes in Jupyter Protocol
  • 0.1.0

Indices and tables

• Index

• Module Index

• Search Page