jupyter_client

User Documentation

  • Messaging in Jupyter
    • Versioning
    • Introduction
    • General Message Format
    • Compatibility
    • The Wire Protocol
    • Python API
    • Messages on the shell (ROUTER/DEALER) channel
      • Request-Reply
      • Execute
        • Execution counter (prompt number)
        • Execution results
        • Payloads (DEPRECATED)
      • Introspection
      • Completion
      • History
      • Code completeness
      • Connect
      • Comm info
      • Kernel info
      • Kernel shutdown
    • Messages on the IOPub (PUB/SUB) channel
      • Streams (stdout, stderr, etc)
      • Display Data
      • Update Display Data
      • Code inputs
      • Execution results
      • Execution errors
      • Kernel status
      • Clear output
    • Messages on the stdin (ROUTER/DEALER) channel
    • Heartbeat for kernels
    • Custom Messages
      • Opening a Comm
      • Comm Messages
      • Tearing Down Comms
      • Output Side Effects
    • To Do

Developer documentation

  • Making kernels for Jupyter
    • Connection files
    • Handling messages
    • Kernel specs
  • Making simple Python wrapper kernels
    • Required steps
    • Example
    • Optional steps

API

  • jupyter_client API
    • kernelspec - discovering kernels
    • manager - starting, stopping, signalling
      • multikernelmanager - controlling multiple kernels
      • Utility functions
    • client - communicating with kernels

Changes

  • Changes in Jupyter Client
    • 5.0
      • 5.0.1
      • 5.0.0
    • 4.4
      • 4.4.0
    • 4.3
      • 4.3.0
    • 4.2
      • 4.2.2
      • 4.2.1
      • 4.2.0
    • 4.1
      • 4.1.0
    • 4.0
 
jupyter_client
  • Docs »
  • Search

© Copyright 2015, Jupyter Development Team.

Built with Sphinx using a theme provided by Read the Docs.