# Python Local `.venv` Kernel
[](https://github.com/goerz/python-localvenv-kernel)
[](https://github.com/goerz/python-localvenv-kernel/actions)
[](https://pypi.org/project/python-localvenv-kernel/)
[](https://anaconda.org/conda-forge/python-localvenv-kernel)
[](https://github.com/conda-forge/python-localvenv-kernel-feedstock)
[](https://opensource.org/licenses/MIT)
A Jupyter kernel that delegates to `ipykernel` in the `.venv` environment of a project folder.
Derived from [`poetry-kernel`](https://github.com/pathbird/poetry-kernel), see the [FAQ](https://github.com/goerz/python-localvenv-kernel/blob/master/FAQ.md#how-does-this-kernel-differ-from-poetry-kernel).
See the demo at the December 2023 Jupyter Community Call:
[](https://www.youtube.com/watch?v=hUU77BfU-Kk&t=360)
## Installation
The `python-localvenv-kernel` package can be installed via `pip` (`pip install python-localvenv-kernel`) or as a [Conda package](https://github.com/conda-forge/python-localvenv-kernel-feedstock#about-python-localvenv-kernel-feedstock) (`conda install python-localvenv-kernel`).
It must be installed into the same environment as the Jupyter server, see [Usage](#usage) below.
## Usage
* Jupyter and the `python-localvenv-kernel` package should be installed in the same environment
* The project folder must have a virtual (project) environment instantiated in a subfolder `.venv`. The name of folder can be overridden by setting the environment variable `KERNEL_VENV` (see [FAQ](https://github.com/goerz/python-localvenv-kernel/blob/master/FAQ.md#how-can-i-change-the-directory-for-the-virtual-environment))
* The project environment must include the `ipykernel` package (but not `jupyter`)
* Start Jupyter from the project folder
* Select the "Python (local .venv)" kernel
## FAQ
[See `FAQ.md`.][FAQ]
[FAQ]: https://github.com/goerz/python-localvenv-kernel/blob/master/FAQ.md
Raw data
{
"_id": null,
"home_page": "https://github.com/goerz/python-localvenv-kernel",
"name": "python-localvenv-kernel",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "Interactive, Interpreter, Shell, Web",
"author": "Michael H. Goerz",
"author_email": "mail@michaelgoerz.net",
"download_url": "https://files.pythonhosted.org/packages/5c/08/ef957639fd6c6474dc3a9d8d534d506a0230b17eed66acb6aebedf9509df/python-localvenv-kernel-0.1.6.tar.gz",
"platform": null,
"description": "# Python Local `.venv` Kernel\n\n[](https://github.com/goerz/python-localvenv-kernel)\n[](https://github.com/goerz/python-localvenv-kernel/actions)\n[](https://pypi.org/project/python-localvenv-kernel/)\n[](https://anaconda.org/conda-forge/python-localvenv-kernel)\n[](https://github.com/conda-forge/python-localvenv-kernel-feedstock)\n[](https://opensource.org/licenses/MIT)\n\nA Jupyter kernel that delegates to `ipykernel` in the `.venv` environment of a project folder.\n\nDerived from [`poetry-kernel`](https://github.com/pathbird/poetry-kernel), see the [FAQ](https://github.com/goerz/python-localvenv-kernel/blob/master/FAQ.md#how-does-this-kernel-differ-from-poetry-kernel).\n\nSee the demo at the December 2023 Jupyter Community Call:\n\n[](https://www.youtube.com/watch?v=hUU77BfU-Kk&t=360)\n\n\n## Installation\n\nThe `python-localvenv-kernel` package can be installed via `pip` (`pip install python-localvenv-kernel`) or as a [Conda package](https://github.com/conda-forge/python-localvenv-kernel-feedstock#about-python-localvenv-kernel-feedstock) (`conda install python-localvenv-kernel`).\n\nIt must be installed into the same environment as the Jupyter server, see [Usage](#usage) below.\n\n\n## Usage\n\n* Jupyter and the `python-localvenv-kernel` package should be installed in the same environment\n* The project folder must have a virtual (project) environment instantiated in a subfolder `.venv`. The name of folder can be overridden by setting the environment variable `KERNEL_VENV` (see [FAQ](https://github.com/goerz/python-localvenv-kernel/blob/master/FAQ.md#how-can-i-change-the-directory-for-the-virtual-environment))\n* The project environment must include the `ipykernel` package (but not `jupyter`)\n* Start Jupyter from the project folder\n* Select the \"Python (local .venv)\" kernel\n\n\n\n\n\n\n## FAQ\n\n[See `FAQ.md`.][FAQ]\n\n[FAQ]: https://github.com/goerz/python-localvenv-kernel/blob/master/FAQ.md\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python Jupyter kernel delegating to a local virtual environment",
"version": "0.1.6",
"project_urls": {
"Homepage": "https://github.com/goerz/python-localvenv-kernel"
},
"split_keywords": [
"interactive",
" interpreter",
" shell",
" web"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "84cf94b1ba503b23e91b26707612226d29a9426cdbd6475dc91dd4df29d246b0",
"md5": "501c7d0ce3e5fc71bfe23c51efedb4ab",
"sha256": "1afc0a271fc5cfb8a80a99d6d993022d35b3fa659fd9e9730aff9acc759f9fa5"
},
"downloads": -1,
"filename": "python_localvenv_kernel-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "501c7d0ce3e5fc71bfe23c51efedb4ab",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 5881,
"upload_time": "2024-03-27T19:43:26",
"upload_time_iso_8601": "2024-03-27T19:43:26.288164Z",
"url": "https://files.pythonhosted.org/packages/84/cf/94b1ba503b23e91b26707612226d29a9426cdbd6475dc91dd4df29d246b0/python_localvenv_kernel-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5c08ef957639fd6c6474dc3a9d8d534d506a0230b17eed66acb6aebedf9509df",
"md5": "ff9ad9d7dba3c2078ed5a58e7e8daaad",
"sha256": "441289ed5970a2d07c0209ca7b4a1f18ef5a0093910f6c6f6c6a61a27801d903"
},
"downloads": -1,
"filename": "python-localvenv-kernel-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "ff9ad9d7dba3c2078ed5a58e7e8daaad",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 6018,
"upload_time": "2024-03-27T19:43:27",
"upload_time_iso_8601": "2024-03-27T19:43:27.796363Z",
"url": "https://files.pythonhosted.org/packages/5c/08/ef957639fd6c6474dc3a9d8d534d506a0230b17eed66acb6aebedf9509df/python-localvenv-kernel-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-27 19:43:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "goerz",
"github_project": "python-localvenv-kernel",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "python-localvenv-kernel"
}
JSON
