C++ implementation of the Jupyter Kernel protocol

Introduction

xeus is a framework meant to facilitate the implementation of kernels for Project Jupyter. It takes the burden of implementing the Jupyter Kernel protocol so developers can focus on implementing the interpreter part of the kernel.

Licensing

We use a shared copyright model that enables all contributors to maintain the copyright on their contributions.

This software is licensed under the BSD-3-Clause license. See the LICENSE file for details.

INSTALLATION

• Installation
  • Installing xeus-zmq
  • Installing xeus-lite

USAGE

• Usage
• Implementing a kernel
  • Implementing the interpreter
    • Code Execution
    • Input request
    • Configuration
    • Code Completion
    • Code Inspection
    • Code Completeness
    • Kernel info
    • Kernel shutdown
  • Kernel replies
    • Error reply
    • Successful reply
    • Complete reply
    • Is complete reply
    • Create info reply
  • Implementing the main entry
  • Kernel file
  • Compiling and installing the kernel
  • Writing unit-tests for your kernel
• Customizing the kernel
  • History manager
  • Logger
  • Server

DEVELOPER SECTION

• Internals of xeus
• Server
  • Public API
  • xserver_zmq
  • xserver_control_main
  • xserver_shell_main

MISCELLANEOUS

• Related projects
  • Xeus-based kernels
    • xeus-cling
    • xeus-python
    • xeus-sql
    • xeus-sqlite
    • xeus-robot
    • xeus-lua
    • xeus-octave
    • xeus-wren
  • xeus-cookiecutter
  • SlicerJupyter
  • xwidgets