Skip to main content

Python Jupyter kernel delegating to a local virtual environment

Project description

Python Local .venv Kernel

Github Build Status PyPI Conda Version Conda Recipe MIT License

A Jupyter kernel that delegates to ipykernel in the .venv environment of a project folder.

Derived from poetry-kernel, see the FAQ.

See the demo at the December 2023 Jupyter Community Call:

Jupyter Community Call

Installation

The python-localvenv-kernel package can be installed via pip (pip install python-localvenv-kernel) or as a Conda package (conda install python-localvenv-kernel).

It must be installed into the same environment as the Jupyter server, see 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)
  • The project environment must include the ipykernel package (but not jupyter)
  • Start Jupyter from the project folder
  • Select the "Python (local .venv)" kernel

Jupyter launcher screenshot (kernel selector)

Jupyter launcher screenshot (notebook)

FAQ

See FAQ.md.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-localvenv-kernel-0.1.7.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

python_localvenv_kernel-0.1.7-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file python-localvenv-kernel-0.1.7.tar.gz.

File metadata

File hashes

Hashes for python-localvenv-kernel-0.1.7.tar.gz
Algorithm Hash digest
SHA256 f890d16710ddfc3d935c288d42cc6f26ac2e2a318887c2dd20f2c5c41b0b247e
MD5 a8959fbd3426d6c6c92a87dccbf1ee16
BLAKE2b-256 0cb7b293207a943f6341b5703d1526dd336eaf8cf6d3c6d8ae141db89c919618

See more details on using hashes here.

File details

Details for the file python_localvenv_kernel-0.1.7-py3-none-any.whl.

File metadata

File hashes

Hashes for python_localvenv_kernel-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 61b5f556a9c5abe5a4160888de4ecd9c11e63aaf3623558fafdd796cc101a614
MD5 f34f0a236f1e916a7fbaa964406e906b
BLAKE2b-256 ba10c48efed10096b396c8bc257ac1b3118690d988aa96910af0ce118ff982ce

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page