| Name | pixi-kernel JSON |
| Version |
0.5.3
JSON |
| download |
| home_page | None |
| Summary | Jupyter kernels using Pixi for reproducible notebooks |
| upload_time | 2024-12-21 13:50:52 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4.0,>=3.9 |
| license | MIT |
| keywords |
jupyter
kernel
pixi
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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 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).
## Limitations
Pixi Kernel only works with the default environment. If you have an idea how to support multiple
environments see [this issue](https://github.com/renan-r-santos/pixi-kernel/issues/20) or see
[CONTRIBUTING](CONTRIBUTING.md#adding-support-for-new-kernels).
## 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, kernel, pixi",
"author": null,
"author_email": "Renan Rodrigues dos Santos <renan.engmec@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/5a/80/a0033097ba690806ae2881ee9f4ecc06414d62cb7aa8a9d85c9d49025ace/pixi_kernel-0.5.3.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 Python 3.9+ and Pixi 0.30.0+ using `pyproject.toml` and `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## Limitations\n\nPixi Kernel only works with the default environment. If you have an idea how to support multiple\nenvironments see [this issue](https://github.com/renan-r-santos/pixi-kernel/issues/20) or see\n[CONTRIBUTING](CONTRIBUTING.md#adding-support-for-new-kernels).\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.5.3",
"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",
" kernel",
" pixi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "741d7b683772a20f7abb52d8f6a700b88b982a721b1f20d610961fa403ea9ac1",
"md5": "6031d4a0a5be3588b5d4c2003e8c0d9c",
"sha256": "a1f2dde405983916cea1b3b8f656d6d12f9653e65a7c6102a75a629e3c1e9b0e"
},
"downloads": -1,
"filename": "pixi_kernel-0.5.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6031d4a0a5be3588b5d4c2003e8c0d9c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 26000,
"upload_time": "2024-12-21T13:50:50",
"upload_time_iso_8601": "2024-12-21T13:50:50.188017Z",
"url": "https://files.pythonhosted.org/packages/74/1d/7b683772a20f7abb52d8f6a700b88b982a721b1f20d610961fa403ea9ac1/pixi_kernel-0.5.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5a80a0033097ba690806ae2881ee9f4ecc06414d62cb7aa8a9d85c9d49025ace",
"md5": "f09e597c24adf744ac034c6bba6734ec",
"sha256": "79b4dbcab688feb9fd919286438333dc12baaa329179260c2af8ee1a959a692e"
},
"downloads": -1,
"filename": "pixi_kernel-0.5.3.tar.gz",
"has_sig": false,
"md5_digest": "f09e597c24adf744ac034c6bba6734ec",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 472173,
"upload_time": "2024-12-21T13:50:52",
"upload_time_iso_8601": "2024-12-21T13:50:52.963950Z",
"url": "https://files.pythonhosted.org/packages/5a/80/a0033097ba690806ae2881ee9f4ecc06414d62cb7aa8a9d85c9d49025ace/pixi_kernel-0.5.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-21 13:50:52",
"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"
}
