Metadata-Version: 2.1
Name: python-localvenv-kernel
Version: 0.1.1
Summary: Python Jupyter kernel delegating to a local virtual environment
Home-page: https://github.com/goerz/python-localvenv-kernel
Author: Michael H. Goerz
Author-email: mail@michaelgoerz.net
License: MIT
Keywords: Interactive,Interpreter,Shell,Web
Classifier: Framework :: Jupyter
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: colorama ~=0.4.4

# Python Local-Venv Kernel

A Jupyter kernel that delegates to the `.venv` folder in the notebook directory.

Derived from [`poetry-kernel`](https://github.com/pathbird/poetry-kernel), see the [FAQ](FAQ.md)

## Installation

The `python-local-venv` package must be installed into the environment as Jupyter itself.

```
pip install python-local-venv
```

```
conda install python-local-venv
```

## Usage

* Jupyter and the `python-local-venv` package should be installed in the same environment
* The project folder must have a virtual (project) environment instantiated in a subfolder `.venv`
* The project environment must include the `ipykernel` package (but not `jupyter`)
* Start Jupyter from the project folder
* Select the "Python (local .venv)"

## FAQ

[See FAQ.md.](FAQ.md)
