• Stars
    star
    412
  • Rank 101,565 (Top 3 %)
  • Language
    C++
  • License
    BSD 3-Clause "New...
  • Created over 5 years ago
  • Updated 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Jupyter kernel for the Python programming language

xeus-python

GitHub Action CI Documentation Status Binder Join the Gitter Chat

xeus-python is a Jupyter kernel for Python based on the native implementation of the Jupyter protocol xeus.

Installation

xeus-python has been packaged for the mamba (or conda) package manager.

To ensure that the installation works, it is preferable to install xeus-python in a fresh environment. It is also needed to use a miniforge or miniconda installation because with the full anaconda you may have a conflict with the zeromq library which is already installed in the anaconda distribution.

The safest usage is to create an environment named xeus-python

mamba create -n xeus-python
source activate xeus-python

Installing from conda-forge

Then you can install in this environment xeus-python and its dependencies

mamba install xeus-python notebook -c conda-forge

Installing from PyPI

Depending on the platform, PyPI wheels may be available for xeus-python.

pip install xeus-python notebook

If you encounter the following error message

Collecting xeus-python
  Cache entry deserialization failed, entry ignored
  Could not find a version that satisfies the requirement xeus-python (from versions: )
No matching distribution found for xeus-python

you probably need to upgrade pip: pip install --upgrade pip before attempting to install xeus-python again.

The wheels uploaded on PyPI are experimental. In general we strongly recommend using a package manager instead. We maintain the conda-forge package, and nothing prevents you from creating a package your favorite Linux distribution or FreeBSD.

The ongoing effort to package xeus-python for pip takes place in the xeus-python-wheel repository.

Installing from source

Or you can install it from the sources, you will first need to install dependencies

mamba install cmake xeus xeus-zmq nlohmann_json cppzmq xtl pybind11 pybind11_json xeus-python-shell jupyterlab -c conda-forge

Then you can compile the sources (replace $CONDA_PREFIX with a custom installation prefix if need be)

mkdir build && cd build
cmake .. -D CMAKE_PREFIX_PATH=$CONDA_PREFIX -D CMAKE_INSTALL_PREFIX=$CONDA_PREFIX -D CMAKE_INSTALL_LIBDIR=lib -D PYTHON_EXECUTABLE=`which python`
make && make install

Trying it online

To try out xeus-python interactively in your web browser, just click on the binder link:

Binder

Usage

Launch the Jupyter notebook with jupyter notebook or Jupyter lab with jupyter lab and launch a new Python notebook by selecting the xpython kernel.

Raw mode

You can run xeus-python in the "raw" mode by selecting the XPython Raw kernel. In this mode:

  • IPython is not used: IPython magics are not available
  • Jupyter console is not supported

but

  • xeus-python starts faster
  • Completion/Inspection/Code execution works faster
  • Interactive widgets are supported

This is useful when using xeus-python in Voila, where you should see a ~15% performance improvement, reducing the load of your application.

xeus-python in JupyterLite!

You can install xeus-python in JupyterLite, see https://github.com/jupyterlite/xeus-python-kernel for more information.

Code execution and variable display:

Basic code execution

Output streams:

Streams

Input streams:

Input

Error handling:

Erro handling

Inspect:

Inspect

Code completion:

Completion

Rich display:

Rich display

And of course widgets:

Widgets Widgets binary

Documentation

To get started with using xeus-python, check out the full documentation

http://xeus-python.readthedocs.io

What are the advantages of using xeus-python over ipykernel (IPython kernel)?

Check-out this blog post for the answer: https://blog.jupyter.org/a-new-python-kernel-for-jupyter-fcdf211e30a8. Long story short:

  • xeus-python is a lot lighter than ipykernel, which makes it a lot easier to implement new features on top of it.
  • xeus-python already works with the Jupyter Lab debugger: https://github.com/jupyterlab/debugger
  • xeus-based kernels are more versatile in that one can overload e.g. the concurrency model. This is something that Kitware’s SlicerJupyter project takes advantage of to integrate with the Qt event loop of their Qt-based desktop application.

Dependencies

xeus-python depends on

xeus-python xeus-zmq xtl cppzmq nlohmann_json pybind11 pybind11_json pygments debugpy xeus-python-shell
master >=1.0.0,<2.0 >=0.7.0,<0.8 ~4.4.1 >=3.6.1,<3.10 >=2.6.1,<3.0 >=0.2.8,<0.3 >=2.3.1,<3.0.0 >=1.1.0 >=0.5.0,<0.6.0
0.15.x >=1.0.0,<2.0 >=0.7.0,<0.8 ~4.4.1 >=3.6.1,<3.10 >=2.6.1,<3.0 >=0.2.8,<0.3 >=2.3.1,<3.0.0 >=1.1.0 >=0.5.0,<0.6.0

Prior to version 0.15, xeus-python was depending on xeus instead of xeus-zmq:

xeus-python xeus xtl cppzmq nlohmann_json pybind11 pybind11_json pygments debugpy xeus-python-shell
0.14.3 >=2.0.0,<3.0 >=0.7.0,<0.8 ~4.4.1 >=3.6.1,<3.10 >=2.6.1,<3.0 >=0.2.8,<0.3 >=2.3.1,<3.0.0 >=1.1.0 >=0.5.0,<0.6.0
0.14.2 >=2.0.0,<3.0 >=0.7.0,<0.8 ~4.4.1 >=3.6.1,<3.10 >=2.6.1,<3.0 >=0.2.8,<0.3 >=2.3.1,<3.0.0 >=1.1.0 >=0.4.1,<0.5.0
0.14.1 >=2.0.0,<3.0 >=0.7.0,<0.8 ~4.4.1 >=3.6.1,<3.10 >=2.6.1,<3.0 >=0.2.8,<0.3 >=2.3.1,<3.0.0 >=1.1.0 >=0.4.1,<0.5.0
0.14.0 >=2.0.0,<3.0 >=0.7.0,<0.8 ~4.4.1 >=3.6.1,<3.10 >=2.6.1,<3.0 >=0.2.8,<0.3 >=2.3.1,<3.0.0 >=1.1.0 >=0.4.1,<0.5.0
0.13.x >=2.0.0,<3.0 >=0.7.0,<0.8 ~4.4.1 >=3.6.1,<3.10 >=2.6.1,<3.0 >=0.2.8,<0.3 >=2.3.1,<3.0.0 >=1.1.0 >=0.3.0,<0.4.0

Contributing

See CONTRIBUTING.md to know how to contribute and set up a development environment.

License

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.

More Repositories

1

xeus-cling

Jupyter kernel for the C++ programming language
C++
2,682
star
2

xeus

Implementation of the Jupyter kernel protocol in C++
C++
838
star
3

cpp-terminal

C++ library for writing multiplatform terminal applications
C++
447
star
4

xeus-sqlite

Jupyter kernel for SQLite
C++
156
star
5

xeus-sql

Jupyter kernel for SQL databases
C++
148
star
6

xwidgets

C++ backend for Jupyter interactive widgets
C++
131
star
7

xleaflet

C++ backend for the jupyter leaflet widget
C++
77
star
8

xeus-octave

Jupyter kernel for GNU Octave
Jupyter Notebook
51
star
9

xeus-lua

Jupyter kernel for the Lua programming language
C++
40
star
10

xproperty

Traitlets-like C++ properties and implementation of the observer pattern
C++
36
star
11

xeus-robot

Jupyter kernel for Robot Framework
Jupyter Notebook
30
star
12

xeus-calc

Jupyter kernel for a simple calculator
C++
17
star
13

xeus-python-wheel

Building a PyPI wheel for xeus-python
CMake
12
star
14

xena

The world needs Xena, stay tuned!
CMake
8
star
15

xeus-nelson

Jupyter kernel for Nelson
C++
6
star
16

xhale

Converter from sphinx and breathe inventory files to doxygen tag files
Python
5
star
17

xeus-qt

ZeroMQ-based middleware for xeus integrated in the Qt event loop
CMake
5
star
18

xeus-wren

Jupyter kernel for the Wren programming language
C++
5
star
19

xeus-zmq

ZeroMQ-based middleware for xeus
C++
5
star
20

xcanvas

C++ back-end for ipycanvas
C++
5
star
21

xeus-cookiecutter

Cookiecutter for xeus-based Jupyter kernels
CMake
4
star
22

robotframework-interpreter

Utilities for building a Robot Framework interpreter
Python
3
star
23

xvega-bindings

xvega bindings for xeus
C++
3
star
24

xeus-lite

Emscripten-based middleware for xeus
C++
2
star
25

xeus-python-shell

Core Python code for xeus-python
Python
2
star