Skip to content

renan-r-santos/pixi-kernel

Repository files navigation

Pixi Kernel

image image image Actions status codecov uv Ruff

Per-directory Pixi environments with multi-language Jupyter kernels.

JupyterLab launcher screen showing Pixi Kernel

Pixi Kernel supports Python 3.9+ and Pixi 0.30.0+ using pyproject.toml and pixi.toml configurations.

Disclaimer: This project is not affiliated with Pixi, and not an official Pixi plugin.

Quick Start

This assumes you want a Python kernel. For other languages, check the Kernel support table and replace ipykernel with the desired kernel package.

  1. Install Pixi and pixi-kernel alongside JupyterLab using your favorite package manager.
  2. Restart JupyterLab.
  3. Create a new directory and initialize a Pixi project with pixi init and pixi add ipykernel.
  4. Restart the kernel and you are good to go.

See the Pixi docs for more information on how to use Pixi.

Kernel support

Pixi Kernel supports the following kernels:

Language Kernel Package name
Python IPython Kernel ipykernel
R IR Kernel r-irkernel

Support for other kernels and languages can be added by opening an issue or a pull request, see CONTRIBUTING.

Limitations

Pixi Kernel only works with the default environment. If you have an idea how to support multiple environments see this issue or see CONTRIBUTING.

Related