appimage 2.0.1

Package Python applications as self-contained AppImages

appimage

Package Python applications as self-contained AppImages.

---

appimage bundles a complete Python distribution together with your application and all its dependencies into a single executable file.

The same Python that uv installs. The bundled interpreter comes from python-build-standalone — identical to what uv python install provides. What you develop with locally is what gets shipped in the AppImage.

Quick Start

pip install appimage

A pyproject.toml is all that's needed — and if your project already has one, you're ready to build. app, entry_point, and python version are read from [project] automatically.

# Check what will be detected before building
python -m appimage.build --check

# Build — the AppImage is written to dist/myapp-x86_64.AppImage
python -m appimage.build

# Optionally: persist detected values to pyproject.toml to pin or adjust them
python -m appimage.build --init

Bundled interpreter access

The bundled Python is accessible at runtime without extracting the AppImage:

./myapp-x86_64.AppImage --python-interpreter            # interactive REPL
./myapp-x86_64.AppImage --python-interpreter script.py  # run a script
./myapp-x86_64.AppImage --python-interpreter -m pip list
./myapp-x86_64.AppImage --python-list-entry-points      # list all entry points
./myapp-x86_64.AppImage --python-entry-point other:main # switch entry point

Virtual environments

The AppImage can act as the Python interpreter for a virtual environment. Packages installed into the venv extend the bundled ones — without repackaging the AppImage:

./myapp-x86_64.AppImage --python-interpreter -m venv ~/.venv/myapp
~/.venv/myapp/bin/pip install extra-package
~/.venv/myapp/bin/myapp

When launched through a venv symlink, the bundled appimage module activates the environment automatically.

Reproducible builds

Pin the exact Python release to get byte-for-byte reproducible AppImages:

[tool.appimage.build]
python_date = "20260211"

Configuration

All options go in [tool.appimage.build] inside pyproject.toml — every key is optional. Lifecycle hooks, extra files, custom AppRun scripts, and environment variable injection are supported.

→ Full documentation