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.6.tar.gz (6.0 kB view hashes)

Uploaded Source

Built Distribution

python_localvenv_kernel-0.1.6-py3-none-any.whl (5.9 kB view hashes)

Uploaded Python 3

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