Repository files navigation

Jupyter Kernel Gateway is a web server that provides headless access toJupyter kernels. Your application communicates with the kernels remotely,through REST calls and Websockets rather than ZeroMQ messages.There are no provisions for editing notebooks through the Kernel Gateway.The following operation modes, called personalities, are supportedout of the box:

• Send code snippets for execution using theJupyter kernel protocolover Websockets. Start and stop kernels through REST calls.This HTTP API is compatible with the respective API sectionsof the Jupyter Notebook server.

• Serve HTTP requests from annotated notebook cells. The code snippetsare cells of a static notebook configured in the Kernel Gateway.Annotations define which HTTP verbs and resources it supports.Incoming requests are served by executing one of the cells in a kernel.

Jupyter Kernel Gateway uses the same code as Jupyter Notebookto launch kernels in its local process/filesystem space.It can be containerized and scaled out using common technologies liketmpnb,Cloud Foundry, andKubernetes.

• Attach a local Jupyter Notebook server to a compute cluster in the cloud running near big data (e.g., interactive gateway to Spark)
• Enable a new breed of non-notebook web clients to provision and use kernels (e.g., web dashboards usingjupyter-js-services)
• Create microservices from notebooks using the Kernel Gatewaynotebook-http mode

See theFeatures page in thedocumentation for a list of the Jupyter Kernel Gateway features.

Detailed installation instructions are located in theGetting Started pageof the project docs. Here's a quick start usingpip:

# install from pypipip install jupyter_kernel_gateway# show all config optionsjupyter kernelgateway --help-all# run it with default optionsjupyter kernelgateway

TheDevelopment page includes information about setting up a development environment and typical developer tasks.