Jupyter Kernel Gateway

Jupyter Kernel Gateway is a web server that supports different mechanisms for spawning and communicating with Jupyter kernels, such as:

• A Jupyter Notebook server-compatible HTTP API used for requesting kernels and talking the Jupyter kernel protocol with the kernels over Websockets
• A HTTP API defined by annotated notebook cells that maps HTTP verbs and resources to code to execute on a kernel

The server launches kernels in its local process/filesystem space. It can be containerized and scaled out using common technologies like tmpnb, Cloud Foundry, and Kubernetes.

Contents:

User Documentation

• Getting started
  • Using pip
  • Using jupyter/minimal-kernel
  • Using another docker-stacks image
• Use Cases
• Features
• jupyter-websocket Mode
  • HTTP Resources
  • Websocket Resources
• notebook-http Mode
  • Getting the Request Data
  • Setting the Response Body
  • Setting the Response Status and Headers
  • Swagger Spec
  • Running

Configuration

• KernelGatewayApp configuration options
• Troubleshooting
  • I can’t access kernel gateway in my Docker container.
  • Kernel gateway raises an error when I use notebook-http mode.

Contributor Documentation

• Development Workflow
  • Prerequisites
  • Clone the repo
  • Build the development image
  • Run the tests
  • Run the gateway server
  • Build the docs
  • Update the Swagger API spec

Community Documentation

About Jupyter Kernel Gateway

• Summary of changes
  • 0.5
  • 0.5.0 (2016-04-08)
  • 0.4
  • 0.3
  • 0.2
  • 0.1

Questions? Suggestions?

• Jupyter mailing list
• Jupyter website
• Stack Overflow - Jupyter
• Stack Overflow - Jupyter-notebook

Indices and tables

• Index
• Module Index
• Search Page