# Pixi kernel
[](https://pypi.python.org/pypi/pixi-kernel)
[](https://pypi.python.org/pypi/pixi-kernel)
[](https://pypi.python.org/pypi/pixi-kernel)
[](https://github.com/renan-r-santos/pixi-kernel/actions)
[](https://codecov.io/gh/renan-r-santos/pixi-kernel)
[](https://github.com/astral-sh/uv)
[](https://github.com/astral-sh/ruff)
Per-directory Pixi environments with multi-language Jupyter kernels.
<!--- TODO: add theme selector when supported on PyPI https://github.com/pypi/warehouse/issues/11251 -->
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](#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](https://pixi.sh/latest/) for more information on how to use Pixi.
## Kernel support
Pixi kernel supports the following kernels:
| Language | Kernel | Package name |
| -------- | -------------- | -------------------------------------------------- |
| Python | IPython Kernel | [ipykernel](https://github.com/ipython/ipykernel) |
| R | IR Kernel | [r-irkernel](https://github.com/IRkernel/IRkernel) |
Support for other kernels and languages can be added by opening an issue or a pull request, see
[CONTRIBUTING](CONTRIBUTING.md#adding-support-for-new-kernels).
## 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.
## Limitations
Pixi kernel only works with the default environment in VSCode.
## Related
- [Pyproject Local Jupyter Kernel](https://github.com/bluss/pyproject-local-kernel)
- [Poetry-kernel](https://github.com/pathbird/poetry-kernel)
- [Python Local .venv Kernel](https://github.com/goerz/python-localvenv-kernel)
Raw data
{
"_id": null,
"home_page": null,
"name": "pixi-kernel",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "jupyter, jupyterlab, jupyterlab-extension, kernel, pixi",
"author": null,
"author_email": "Renan Rodrigues dos Santos <renan.engmec@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/db/4c/aea77df8b2b8a8f4ba8d04247c7106f5b1e824c335f63081640ba3826eab/pixi_kernel-0.6.1.tar.gz",
"platform": null,
"description": "# Pixi kernel\n\n[](https://pypi.python.org/pypi/pixi-kernel)\n[](https://pypi.python.org/pypi/pixi-kernel)\n[](https://pypi.python.org/pypi/pixi-kernel)\n[](https://github.com/renan-r-santos/pixi-kernel/actions)\n[](https://codecov.io/gh/renan-r-santos/pixi-kernel)\n[](https://github.com/astral-sh/uv)\n[](https://github.com/astral-sh/ruff)\n\nPer-directory Pixi environments with multi-language Jupyter kernels.\n\n<!--- TODO: add theme selector when supported on PyPI https://github.com/pypi/warehouse/issues/11251 -->\n\n\n\nPixi kernel supports Jupyterlab 4, Python 3.9+ and Pixi 0.30.0+ using `pyproject.toml` and\n`pixi.toml` configurations.\n\n**Disclaimer**: _This project is not affiliated with Pixi, and not an official Pixi plugin._\n\n## Quick Start\n\nThis assumes you want a Python kernel. For other languages, check the [Kernel\nsupport](#kernel-support) table and replace `ipykernel` with the desired kernel package.\n\n1. Install Pixi and `pixi-kernel` alongside JupyterLab using your favorite package manager.\n2. Restart JupyterLab.\n3. Create a new directory and initialize a Pixi project with `pixi init` and `pixi add ipykernel`.\n4. Restart the kernel and you are good to go.\n\nSee the [Pixi docs](https://pixi.sh/latest/) for more information on how to use Pixi.\n\n## Kernel support\n\nPixi kernel supports the following kernels:\n\n| Language | Kernel | Package name |\n| -------- | -------------- | -------------------------------------------------- |\n| Python | IPython Kernel | [ipykernel](https://github.com/ipython/ipykernel) |\n| R | IR Kernel | [r-irkernel](https://github.com/IRkernel/IRkernel) |\n\nSupport for other kernels and languages can be added by opening an issue or a pull request, see\n[CONTRIBUTING](CONTRIBUTING.md#adding-support-for-new-kernels).\n\n## Pixi environments\n\nPixi kernel supports multiple Pixi environments in a single Pixi project. To select a specific\nenvironment, use JupyterLab property inspector, save your notebook and restart your kernel.\n\n\n\n## Limitations\n\nPixi kernel only works with the default environment in VSCode.\n\n## Related\n\n- [Pyproject Local Jupyter Kernel](https://github.com/bluss/pyproject-local-kernel)\n- [Poetry-kernel](https://github.com/pathbird/poetry-kernel)\n- [Python Local .venv Kernel](https://github.com/goerz/python-localvenv-kernel)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Jupyter kernels using Pixi for reproducible notebooks",
"version": "0.6.1",
"project_urls": {
"Documentation": "https://github.com/renan-r-santos/pixi-kernel",
"Homepage": "https://github.com/renan-r-santos/pixi-kernel",
"Repository": "https://github.com/renan-r-santos/pixi-kernel"
},
"split_keywords": [
"jupyter",
" jupyterlab",
" jupyterlab-extension",
" kernel",
" pixi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "adce468e887fa2bb64cbb8c1829bb315f7461f19fae17fa958417191a87dab7c",
"md5": "ea73306ee879d3a6da43d8d24e807a14",
"sha256": "f1d37cfeefdff9455017d7a9687fbbcf1588ae33ba411287a451ea95d559a222"
},
"downloads": -1,
"filename": "pixi_kernel-0.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ea73306ee879d3a6da43d8d24e807a14",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 38880,
"upload_time": "2025-01-18T13:15:14",
"upload_time_iso_8601": "2025-01-18T13:15:14.995659Z",
"url": "https://files.pythonhosted.org/packages/ad/ce/468e887fa2bb64cbb8c1829bb315f7461f19fae17fa958417191a87dab7c/pixi_kernel-0.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "db4caea77df8b2b8a8f4ba8d04247c7106f5b1e824c335f63081640ba3826eab",
"md5": "bde29f0620352cc55cf6667f8216cbe1",
"sha256": "993a741af866f4ad581adb6fc3ae3451f6087493b480dae943a02ff4d1fab93a"
},
"downloads": -1,
"filename": "pixi_kernel-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "bde29f0620352cc55cf6667f8216cbe1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 637255,
"upload_time": "2025-01-18T13:15:17",
"upload_time_iso_8601": "2025-01-18T13:15:17.491152Z",
"url": "https://files.pythonhosted.org/packages/db/4c/aea77df8b2b8a8f4ba8d04247c7106f5b1e824c335f63081640ba3826eab/pixi_kernel-0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-18 13:15:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "renan-r-santos",
"github_project": "pixi-kernel",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pixi-kernel"
}
JSON
