Skip to main content

Fast, Python-native, npm-free ESM dependency vendoring with import maps and Subresource Integrity

Project description

pyesm

A fast, Python-native, npm-free tool that reads ESM dependencies from pyproject.toml, vendors the compiled module graph from a CDN into a local static directory, and emits a standard import map with Subresource Integrity (SRI) on by default.

  • No Node, no npm, no bundler. Pure Python: pip install pyesm (or uv add pyesm) and go.
  • Framework-agnostic core writes a static importmap.json + vendored files.
  • Optional Django integration renders the import map through staticfiles storage at request time, so it survives ManifestStaticFilesStorage / WhiteNoise filename hashing.
  • Deterministic, lockfile-driven, SRI on by default.

Install

$ pip install pyesm           # or: uv add pyesm
$ pip install "pyesm[django]" # with the optional Django integration
  • Python 3.12+.
  • Runtime dependencies are minimal: just httpx.
  • No Node toolchain and no compiled extensions, ever.

Quick start

$ pyesm add react@^18.2.0 react-dom@^18.2.0   # resolve, lock, vendor, and write the import map
<script type="importmap" src="/static/pyesm/importmap.json"></script>
<script type="module">import "react"</script>

That's it: react (and its whole module graph) now loads from your own static files, with integrity enforced and zero requests to the CDN at runtime. (Drop the @range to take the latest.)

Already have deps in pyproject.toml? Skip add and run pyesm sync.


How it works

The design follows four load-bearing decisions:

  1. The CDN resolves and pins; pyesm crawls. We don't reimplement npm semver. We ask a CDN's ESM endpoint for name@range, pin it to an exact version (jsDelivr via its data API, esm.sh via redirect), then crawl the returned module graph.
  2. Relocate via the import map, never by editing bytes. CDN-built ESM references sibling modules by root-relative path (e.g. /npm/react@18.3.1/+esm). pyesm adds each such specifier to the import map as a key pointing at the local vendored copy. The browser resolves the specifier against your site's origin and the map transparently redirects it to the local file. Vendored .js is written byte-for-byte as fetched.
  3. No fragile relative edges. Because cross-module references are absolute (root-relative) paths, the import map is the single indirection layer; there is nothing to rewrite inside the files.
  4. Integrity is computed over the vendored bytes. Every module gets a sha384 stored in the lock; sync recomputes and verifies on every run and fails loudly on mismatch (the CDN changed bytes under a pinned URL) rather than silently overwriting. By default the import map also carries an SRI integrity entry for every URL (opt out with integrity = false). Because bytes are never edited, the hash stays valid even when ManifestStaticFilesStorage renames the file.

A global content-addressed cache (~/.cache/pyesm/<hash>) is shared across all projects; identical modules are downloaded once, ever, and hardlinked into each project's output directory.


Configuration

All configuration lives under [tool.pyesm] in pyproject.toml.

Key Default Meaning
provider "jsdelivr" CDN to vendor from: jsdelivr or esmsh.
output-dir "static/pyesm" Where vendored files are written (relative to project root).
base-url "/static/pyesm/" Public URL prefix used in the static import map. Must end with /.
importmap "static/pyesm/importmap.json" Output path for the static import map.
production true Request production (vs dev) builds where the CDN distinguishes (esm.sh).
shims "auto" es-module-shims injection: auto, always, or never.
concurrency 16 Max parallel downloads.
integrity true Emit the SRI integrity block in the import map.

Dependencies go in a separate table. Keys containing dots, slashes, or scopes must be quoted:

[tool.pyesm.dependencies]
react       = "^18.2.0"
"react-dom" = "^18.2.0"
lit         = "3"
"htmx.org"  = "2"
"@scope/pkg" = "1.2.3"

CLI reference

The single entry point is pyesm. Running it bare prints help.

Command Network? Behavior
pyesm add <pkg>[@range] … yes Add to [tool.pyesm.dependencies], re-resolve, update lock, vendor.
pyesm remove <pkg> … yes Remove from deps, re-resolve, prune now-unused vendored files.
pyesm lock yes Re-resolve from pyproject.toml, rewrite pyesm.lock.
pyesm sync (alias install) only if cold Make local files + import map match the lock; download missing modules and verify every integrity. Offline & near-instant when the cache is warm.
pyesm build no (Re)emit the static importmap.json from the lock.
pyesm clean no Remove the contents of output-dir (keeps the lock).
pyesm outdated yes Report deps whose range now resolves to a newer pinned version.

add accepts version ranges inline, scope-aware:

$ pyesm add lit@3 "@scope/pkg@1.2.3"
$ pyesm remove react-dom

Global flags

Flag Effect
--frozen Fail if pyesm.lock is missing or stale. Never mutates the lock (a CI gate).
--offline Never hit the network; fail if a needed module isn't cached.
--provider <p> Override the configured provider for this run.
-q / -v Quieter / more verbose output.
--version Print the pyesm version.

The lockfile (pyesm.lock)

lock writes a deterministic JSON lockfile next to pyproject.toml. Commit it: it drives reproducible, offline sync in CI and deploys. It captures:

  • provider and inputs_hash: a hash of the resolved dependency table; lets sync skip re-resolution when pyproject.toml is unchanged.
  • imports: each bare specifier → its pinned entry-module URL.
  • modules: every node in the crawled graph: url (canonical CDN URL), path (local file), integrity (sha384-…), deps, and keys (the root-relative specifiers that map to it).

Two lock runs on an unchanged pyproject.toml produce byte-identical files (modulo genuine CDN drift, which surfaces as an explicit failure, never a silent change).


Static mode (default)

pyesm build (and sync) writes importmap.json using base-url to form public URLs. Embed it however you like:

<!-- external -->
<script type="importmap" src="/static/pyesm/importmap.json"></script>

<!-- or inline the JSON contents directly into a <script type="importmap"> -->

<script type="module">import "react"</script>

es-module-shims and cross-browser SRI

Native import-map integrity shipped in Chromium and Safari, but not everywhere; browsers that don't understand the integrity key silently ignore it and load modules unverified. To enforce SRI everywhere, pyesm can inject the es-module-shims polyfill, controlled by shims:

  • auto (default): vendor and inject the polyfill so integrity is enforced even where the browser wouldn't.
  • always: same as auto.
  • never: don't vendor or inject.

The polyfill is vendored like every other file: downloaded once (at lock/sync) from the configured provider, stored in the lock with its own sha384, and served from output-dir with an integrity attribute. Production makes no CDN request for it. In Django mode the <script> tag is emitted for you; in static mode reference the vendored file yourself (<base-url>es-module-shims@<version>.js, integrity in the lock).


Django integration

Add the app to your settings:

INSTALLED_APPS = [
    # …
    "pyesm.contrib.django",
]

Render the map at request time with the template tag:

{% load pyesm %}
<head>
  {% pyesm_importmap %}   {# emits <script type="importmap">…</script>, plus the shims tag per `shims` #}
</head>

<script type="module">import "react"</script>

Why request-time instead of a static file: the tag routes only the values through staticfiles_storage.url("pyesm/<path>"), so the rendered map contains the storage-hashed URL (e.g. /static/pyesm/react@18.3.1/+esm.4af3.js). This makes it survive ManifestStaticFilesStorage and WhiteNoise filename hashing. The integrity values come straight from the lock and stay valid because the bytes are never edited. The rendered map is cached per process and invalidated when the staticfiles manifest changes.

A typical deploy is pyesm synccollectstatic.

Relevant settings (optional):

Setting Default Meaning
PYESM_PROJECT_ROOT auto-detected Directory containing pyproject.toml / pyesm.lock.
PYESM_STATIC_PREFIX "pyesm" Static path prefix the vendored files live under.

Caching & performance

  • Global content-addressed cache at ~/.cache/pyesm/<sha384>, shared across projects. Override the location with the PYESM_CACHE_DIR environment variable (or XDG_CACHE_HOME).
  • Modules are hardlinked from the cache into output-dir (a byte copy only when crossing filesystems). Bytes are never rewritten.
  • The crawl and the downloads run concurrently on asyncio via a single pooled httpx.AsyncClient, bounded by concurrency.
  • A warm-cache sync of a small graph completes in well under a second and makes no network calls.

Continuous integration

sync is the command to run in CI and on deploy. It's deterministic and needs no network when the cache is warm.

$ pyesm sync --frozen     # fail if pyesm.lock is missing or out of date with pyproject.toml
$ pyesm sync --offline    # fail rather than touch the network (requires a warm cache)

--frozen never mutates the lock, so it's a safe gate against forgetting to commit a lock update.


Providers

No provider requires Node. (JSPM is intentionally excluded: its generator is Node-only.)

  • jsdelivr (default): vendors transformed ESM from cdn.jsdelivr.net/npm/<name>@<ver>/+esm. Because the +esm endpoint serves range URLs without redirecting, pyesm pins the exact version via jsDelivr's data API before crawling, so a caret range vendors a single pinned copy.
  • esmsh: vendors from esm.sh, using its ?meta endpoint where available and following redirects to pin. esm.sh entry URLs aren't version-pinned in the path; pyesm vendors the frozen re-export shim plus its pinned target, all locked by integrity.

Switch per-run with --provider, or set provider in config.


Limitations

  • Runtime-computed dynamic imports (import(someVariable)) can't be discovered statically, so their targets aren't vendored; they'd load from the CDN at runtime. Static import("…literal…") is discovered.
  • outdated is a no-op for esm.sh deps, because esm.sh entry URLs don't pin a version in the URL to compare against. jsDelivr pins exactly and reports accurately.
  • CDN output (+esm, esm.sh transforms) is not guaranteed byte-stable across CDN updates. That's fine at serve time because you host your own frozen copy, but a sync that finds a hash mismatch against a still-pinned URL fails loudly rather than silently overwriting.

Development

$ uv sync                      # create the venv and install deps
$ uv run pre-commit install    # enable the git hooks (ruff + pyright)
$ uv run pytest                # run the test suite
$ uv build                     # build the wheel/sdist

Pre-commit runs ruff format, ruff check, the standard hygiene hooks, and pyright. Run them on demand with uv run pre-commit run --all-files.

Releasing

Pushing a v* tag (matching the pyproject.toml version) builds the sdist + wheel and publishes to PyPI via Trusted Publishing (OIDC, no stored token):

$ git tag v0.1.0 && git push --tags

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

pyesm-0.1.1.tar.gz (48.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyesm-0.1.1-py3-none-any.whl (33.8 kB view details)

Uploaded Python 3

File details

Details for the file pyesm-0.1.1.tar.gz.

File metadata

  • Download URL: pyesm-0.1.1.tar.gz
  • Upload date:
  • Size: 48.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pyesm-0.1.1.tar.gz
Algorithm Hash digest
SHA256 4eeb4eb77cafad4c0e18392a0c4905c4b39819d665443f6ef2dbbf8b5b55af74
MD5 adfe21491cf888158b2714d6603f4f1c
BLAKE2b-256 d67152c8e7b6dc2a73f190923964d09b0c65d681d96bb3158577e6933c19f97a

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyesm-0.1.1.tar.gz:

Publisher: release.yml on novucs/pyesm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyesm-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: pyesm-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 33.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pyesm-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dd05798c850a37c9fc184e8b96beb61b0ab9c54206330139c8f8491eb4ce8a89
MD5 fd63ca05da8f2a58d4723618c6cb3903
BLAKE2b-256 6f39770c0ff06277d4214f58355c705c5f30c0c0dc1b89909c5ae204ec8f20fd

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyesm-0.1.1-py3-none-any.whl:

Publisher: release.yml on novucs/pyesm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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