Skip to main content

Jupyter kernels using Pixi for reproducible notebooks

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 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pixi_kernel-0.5.1.tar.gz (450.9 kB view details)

Uploaded Source

Built Distribution

pixi_kernel-0.5.1-py3-none-any.whl (25.5 kB view details)

Uploaded Python 3

File details

Details for the file pixi_kernel-0.5.1.tar.gz.

File metadata

  • Download URL: pixi_kernel-0.5.1.tar.gz
  • Upload date:
  • Size: 450.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for pixi_kernel-0.5.1.tar.gz
Algorithm Hash digest
SHA256 f8be9b93f6f880bd964edf8a2ea613ea904ed79fefbb41ad14224cdeb620306a
MD5 d9d12f45e9cf5529c5f9456c42d47746
BLAKE2b-256 37ec72158c5bfdca73074333742c9a420d1fb18a89625b55de16483954dc670a

See more details on using hashes here.

File details

Details for the file pixi_kernel-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: pixi_kernel-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 25.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for pixi_kernel-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5e8cdbde99db5d6e7b2925da40154be6aae921fd0ebf0f86defaaaa228408fe8
MD5 152285c2534fddb779b5325399d0bc32
BLAKE2b-256 f074c79653c1f981f84ffbb2e5a3b63dd32654cef2946b8f7dd1809ab77fb5f9

See more details on using hashes here.

Supported by

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