Jupyter kernels using Pixi for reproducible notebooks

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for scherzocrk from gravatar.com scherzocrk
Meta

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License (MIT)
  • Tags jupyter, jupyterlab, jupyterlab-extension, kernel, pixi
  • Requires: Python <4.0, >=3.9
Classifiers

Project description

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 Jupyterlab 4, 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.

Pixi environments

Pixi kernel supports multiple Pixi environments in a single Pixi project. To select a specific environment, use JupyterLab property inspector, save your notebook and restart your kernel.

JupyterLab property inspector showing Pixi environment selector

Limitations

Pixi kernel only works with the default environment in VSCode.

Related

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page