Skip to main content

uv-powered Python zipapp builder.

Project description

moonlit

moonlit is a CLI that bundles a uv-managed Python project (and optionally a uv workspace) into a single self-contained zipapp per PEP 441. The produced .pyz ships every transitive dependency from uv.lock; on the end user's machine it extracts to a per-build cache on first run, then dispatches the configured entry point.

It is similar to LinkedIn's shiv, with two differences:

  • Built on uv, not pip. Resolution is done by uv export --frozen against uv.lock; staging is done by uv pip install --target (no virtualenv); the target's wheel is built by uv build --wheel.
  • uv workspaces are first-class. --package <member> selects a workspace target; transitive workspace deps are bundled automatically via uv build --all-packages.

Status

Pre-release (0.x). API and CLI surface are stabilizing toward 1.0; the produced .pyz runtime contract is pinned by the design specs under specs/.

Install

uv tool install moonlit

Or with pipx / pip:

pipx install moonlit
# or
pip install --user moonlit

From source:

git clone https://github.com/OpenAfterHours/moonlit.git
cd moonlit
uv sync
uv run moonlit --help

Quick start

In a uv-managed project (pyproject.toml + uv.lock):

uv run moonlit build -e myapp.cli:main -o myapp.pyz
python ./myapp.pyz

In a uv workspace:

uv run moonlit build --package shouter -e shouter.cli:main -o shouter.pyz
python ./shouter.pyz

The produced .pyz is self-contained: uv.lock's entire dependency closure is bundled, plus the target's own wheel. On first run it extracts site-packages/ to a per-build cache (%LOCALAPPDATA%\moonlit on Windows, ~/.moonlit on POSIX); subsequent runs hit the cache directly without unpacking.

Build output

Default mode shows per-step progress on stderr — a Braille spinner per step on TTYs (⠋ freezing dependencies (uv export)✓ frozen · 87 packages · 0.7s), or plain / lines when stderr is not a TTY (CI logs, file redirect, pipe). The spec-frozen success line wrote <path> (<size>, <N> entries) always lands on stdout. -q/--quiet suppresses stderr; -v/--verbose additionally echoes + uv <argv> (POSIX-shlex format) before each uv call.

How it works

The moonlit build pipeline runs ten ordered steps:

  1. Workspace detection. Parse [tool.uv.workspace] from pyproject.toml; expand members globs; apply exclude; PEP 503 normalize.
  2. Target selection. Workspace + --package <name> → matched member; non-workspace → project root.
  3. uv export writes a frozen requirements file from uv.lock.
  4. uv pip install --target stages the third-party closure under a temp site-packages/ (no venv).
  5. uv build --wheel (or --all-packages for workspaces) builds the target's wheel.
  6. Each produced wheel is installed into the same site-packages/.
  7. If -c <script> was used, the entry point is resolved from staged *.dist-info/entry_points.txt.
  8. build_id is computed: a sorted SHA-256 over every file in site-packages/ (excluding __pycache__/.pyc).
  9. Archive assembly: shebang prefix, then a ZIP_DEFLATED archive containing site-packages/, the stdlib-only _bootstrap/ package, the rendered __main__.py, and env.json.
  10. Atomic finalize: temp-then-rename to the output path; POSIX chmod 0o755.

At runtime, the _bootstrap package reads env.json, derives a cache key from (name, build_id), takes either the lock-free fast path (cache hit) or the locked slow path (extract under O_CREAT|O_EXCL sentinel, atomic-replace into the cache via os.rename + os.replace), then calls site.addsitedir() and invokes the entry point.

Documentation

docs/index.md Marketing landing page (rendered via the standalone overrides/home.html template — markdown body intentionally empty).
docs/getting-started.md Walkthroughs for single-package projects and uv workspaces.
docs/cli-reference.md Every flag, every exit code, preflight order, stdout/stderr semantics.
docs/runtime.md What runs inside the .pyz: cache layout, env vars, runtime exit codes, stale-lock recovery.

The docs are built with zensical:

uv sync --group docs
uv run zensical serve   # http://127.0.0.1:8000

Project layout

src/moonlit/
├── __init__.py         # __version__
├── __main__.py         # `python -m moonlit` entry
├── cli.py              # Click frontend
├── builder.py          # 10-step build pipeline orchestrator
├── resolver.py         # the only module that calls `uv` subprocesses
├── workspace.py        # parses [tool.uv.workspace]
├── hashing.py          # deterministic build_id
├── errors.py           # MoonlitError hierarchy with stable exit codes
├── _progress.py        # spinner + step-line progress reporter (build-time)
├── _templates/
│   ├── __init__.py
│   └── main_py.tmpl    # rendered into every .pyz as __main__.py
└── _bootstrap/         # SHIPPED INSIDE EVERY .pyz — stdlib-only
    ├── __init__.py     # bootstrap() orchestrator
    ├── environment.py  # env.json validation
    ├── extract.py      # D4 atomic-replace, D14 fast path
    ├── locking.py      # O_CREAT|O_EXCL sentinel lock
    ├── runner.py       # site.addsitedir, entry-point resolution
    └── errors.py

specs/                  # Foundational design contracts (start here for hacking)
overrides/home.html     # Standalone landing template (docs homepage)
scripts/release.py      # Version-bump + tag helper (run before publishing)
tests/
├── unit/               # 479 unit tests
└── e2e/                # 25 contract tests via subprocess

Status of features

Feature State
Build single-package projects done
Build uv workspaces with transitive deps done
--entry-point (-e) and --console-script (-c) done
Atomic .pyz output (temp-then-rename) done
First-run extraction + cache-hit fast path done
Cross-platform caching (%LOCALAPPDATA%, ~/.moonlit) done
MOONLIT_ROOT, MOONLIT_FORCE_EXTRACT, MOONLIT_ENTRY_POINT, MOONLIT_DEBUG done
--reproducible builds (zeroed mtimes, sorted entries) deferred to v0.2
--compile-pyc deferred to v0.2
--no-modify integrity verification deferred to v0.2
--windows-exe native launcher deferred to v0.2
Real flock/msvcrt locking deferred to v0.2
moonlit info <pyz> subcommand deferred to v0.2

Contributing

Read CLAUDE.md for development conventions and specs/ for the design contracts (start with specs/README.md, then specs/00-architecture.md).

uv run pytest                       # 504 tests, ~11s with e2e
uv run pytest tests/unit            # unit only, ~5s
uv run ruff format --check .        # format check (CI gate)
uv run ruff check .                 # lints (CI gate)
uv run zensical build --strict      # docs build (CI gate)

The e2e suite (tests/e2e/) shells out to real uv and produces real .pyz files; it skips automatically if uv is not on PATH.

CI runs all four gates on every pull request via .github/workflows/ci.yml.

Cutting a release

scripts/release.py is the release helper. It enforces a clean working tree, that you're on the release branch, and that the target tag doesn't already exist; runs pytest + ruff + uv build against the current code; bumps the version in pyproject.toml, src/moonlit/__init__.py, and overrides/home.html; runs uv lock; commits as chore: release vX.Y.Z; and creates an annotated tag. Pushing and uv publish are deliberately left to you.

uv run python scripts/release.py patch        # 0.1.0 -> 0.1.1
uv run python scripts/release.py minor        # 0.1.0 -> 0.2.0
uv run python scripts/release.py 0.2.3        # explicit (must be strictly greater)
uv run python scripts/release.py patch --dry-run

License

MIT.

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

moonlit-0.1.3.tar.gz (273.8 kB view details)

Uploaded Source

Built Distribution

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

moonlit-0.1.3-py3-none-any.whl (165.3 kB view details)

Uploaded Python 3

File details

Details for the file moonlit-0.1.3.tar.gz.

File metadata

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

File hashes

Hashes for moonlit-0.1.3.tar.gz
Algorithm Hash digest
SHA256 a8ecc2231fd9ab758559971a0ce15b3fb0de89b5479ab2ac8c5a9a8761762dab
MD5 8173dafccb9e19f7bb621cffb509f687
BLAKE2b-256 bc5991b81f645def308e9bccec752e3697285d1e79bdad293268623bd0f40fc6

See more details on using hashes here.

Provenance

The following attestation bundles were made for moonlit-0.1.3.tar.gz:

Publisher: release.yml on OpenAfterHours/moonlit

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

File details

Details for the file moonlit-0.1.3-py3-none-any.whl.

File metadata

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

File hashes

Hashes for moonlit-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d4fcebb191708564b71036d52ee09d8c2c19b8f3be3e2c12282887fc9f24e6ad
MD5 65ccfb057372038218b3b44b3704931a
BLAKE2b-256 552305c5e94e9a8e00de6fd40d4ab785a68596e08f1228d9920531d0f2417b57

See more details on using hashes here.

Provenance

The following attestation bundles were made for moonlit-0.1.3-py3-none-any.whl:

Publisher: release.yml on OpenAfterHours/moonlit

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