jupyterlite-pyodide-lock

Create pre-solved environments for jupyterlite-pyodide-kernel with pyodide-lock.

docs	install	build

View the full documentation on ReadTheDocs.

Installing

pip install jupyterlite-pyodide-lock

or:

mamba install -c conda-forge jupyterlite-pyodide-lock

Usage

Configure

Requirements

A number of ways to add requirements to the lock file are supported:

• adding wheels in {lite_dir}/static/pyodide-lock
• configuring specs as a list of PEP508 dependency specs
• configuring packages as a list of
  • URLs to remote wheels that will be downloaded and cached
  • local paths relative to lite_dir of .whl files (or folders of wheels)

{
  "PyodideLockAddon": {
    "enabled": true,
    "specs": ["ipywidgets >=8.1,<8.2"],
    "packages": ["../dist/ipywidgets-8.1.2-py3-none-any.whl", "../dist"]
  }
}

Lockers

The Locker is responsible for starting a browser, executing micopip.install and micropip.freeze to try to get a viable lock file solution.

{
  "PyodideLockAddon": {
    "enabled": true,
    "locker": "browser"
  },
  "BrowserLocker": {
    "browser": "firefox",
    "headless": true,
    "private_mode": true,
    "temp_profile": true
  }
}

A convenience CLI options will show some information about detected browsers:

jupyter pyodide-lock browsers

Reproducible Locks

By configuring the lock date to a UNIX epoch timestamp, artifacts from a PyPI index newer than that date will be filtered out before a lock is attempted.

Combined with a fixed pyodide_url archive, this should prevent known packages and their dependencies from "drifting."

{
  "PyodideAddon":
    {
      "pyodide_url": f"https://github.com/pyodide/pyodide/releases/download/0.25.0/pyodide-core-0.25.0.tar.bz2",
    },
  "PyodideLockAddon": { "enabled": true, "lock_date_epoch": 1712980201 }
}

Alternately, this can be provided by environment variable:

JLPL_LOCK_DATE_EPOCH=$(date -u +%s) jupyter lite build

date -u +%s

>>> from datetime import datetime, timezone
>>> int(datetime.now(tz=timezone.utc).timestamp())

git log -1 --format=%ct requirements.txt