| Name | pixi-kernel JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | None |
| Summary | Jupyter kernels using Pixi for reproducible notebooks |
| upload_time | 2024-04-17 16:05:21 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4.0,>=3.8 |
| 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
[![Pixi Badge][pixi-badge]](https://pixi.sh)
[](https://mybinder.org/v2/gh/renan-r-santos/pixi-kernel-binder/main?labpath=example.ipynb)
[![GitHub Actions][github-actions-badge]](https://github.com/renan-r-santos/pixi-kernel/actions)
[![Ruff][ruff-badge]](https://github.com/astral-sh/ruff)
[pixi-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json&style=flat-square
[github-actions-badge]: https://github.com/renan-r-santos/pixi-kernel/actions/workflows/ci.yml/badge.svg
[ruff-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
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.8+ and Pixi 0.18+ 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 `pixi`, `pip` or any other conda or
pip-based 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 |
| -------- | -------------- | -------------------------------------------------------- |
| Bash | Bash Kernel | [bash_kernel](https://github.com/takluyver/bash_kernel) |
| C++ | Xeus Cling | [xeus-cling](https://github.com/jupyter-xeus/xeus-cling) |
| 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. Check
the [contributing guide](CONTRIBUTING.md#adding-support-for-new-kernels) for more information on
adding new kernels.
## mybinder.org
You can try Pixi Kernel on [mybinder.org](https://mybinder.org) by clicking the badge at the top of
this README. Check [pixi-kernel-binder](https://github.com/renan-r-santos/pixi-kernel-binder) for
how to set up a Binder repository with Pixi Kernel.
## Limitations
Pixi Kernel does not support using Pixi environments other than the default one. If you have an
idea how to support this, please open an issue or check the [contributing guide](CONTRIBUTING.md)
to open a pull request.
## 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.8",
"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/cf/d4/7d878c43b9ca9a9bba90a6b05ce876698d932e1fe728b7de436ddf4a5a47/pixi_kernel-0.3.0.tar.gz",
"platform": null,
"description": "# Pixi Kernel\n\n[![Pixi Badge][pixi-badge]](https://pixi.sh)\n[](https://mybinder.org/v2/gh/renan-r-santos/pixi-kernel-binder/main?labpath=example.ipynb)\n[![GitHub Actions][github-actions-badge]](https://github.com/renan-r-santos/pixi-kernel/actions)\n[![Ruff][ruff-badge]](https://github.com/astral-sh/ruff)\n\n[pixi-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json&style=flat-square\n[github-actions-badge]: https://github.com/renan-r-santos/pixi-kernel/actions/workflows/ci.yml/badge.svg\n[ruff-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\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.8+ and Pixi 0.18+ 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 `pixi`, `pip` or any other conda or\n pip-based 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| Bash | Bash Kernel | [bash_kernel](https://github.com/takluyver/bash_kernel) |\n| C++ | Xeus Cling | [xeus-cling](https://github.com/jupyter-xeus/xeus-cling) |\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. Check\nthe [contributing guide](CONTRIBUTING.md#adding-support-for-new-kernels) for more information on\nadding new kernels.\n\n## mybinder.org\n\nYou can try Pixi Kernel on [mybinder.org](https://mybinder.org) by clicking the badge at the top of\nthis README. Check [pixi-kernel-binder](https://github.com/renan-r-santos/pixi-kernel-binder) for\nhow to set up a Binder repository with Pixi Kernel.\n\n## Limitations\n\nPixi Kernel does not support using Pixi environments other than the default one. If you have an\nidea how to support this, please open an issue or check the [contributing guide](CONTRIBUTING.md)\nto open a pull request.\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.3.0",
"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": "a2efab6a0e8ed67fa1dc0d57b31a6f2bfd473f9301ae2c2529104afc3392835d",
"md5": "51a34870c6cf7b09163babaee6c32c3a",
"sha256": "504164f28b07a75d272ecc15674903868ceaa5494f7eb1a179c45fb20cd621f1"
},
"downloads": -1,
"filename": "pixi_kernel-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "51a34870c6cf7b09163babaee6c32c3a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 651272,
"upload_time": "2024-04-17T16:05:20",
"upload_time_iso_8601": "2024-04-17T16:05:20.303900Z",
"url": "https://files.pythonhosted.org/packages/a2/ef/ab6a0e8ed67fa1dc0d57b31a6f2bfd473f9301ae2c2529104afc3392835d/pixi_kernel-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cfd47d878c43b9ca9a9bba90a6b05ce876698d932e1fe728b7de436ddf4a5a47",
"md5": "db43f1ee51b8cb23019a83686703a0eb",
"sha256": "7fad1983bf4b76f3a8b8a8f62f9f734e040f1ba520eaedd73c70acbe4650fa7e"
},
"downloads": -1,
"filename": "pixi_kernel-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "db43f1ee51b8cb23019a83686703a0eb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 1146769,
"upload_time": "2024-04-17T16:05:21",
"upload_time_iso_8601": "2024-04-17T16:05:21.932018Z",
"url": "https://files.pythonhosted.org/packages/cf/d4/7d878c43b9ca9a9bba90a6b05ce876698d932e1fe728b7de436ddf4a5a47/pixi_kernel-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-17 16:05:21",
"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,
"lcname": "pixi-kernel"
}
