Skip to main content

appimage

Zero-setup, reproducible builds.

Read the Docs

PyPI Python versions License Documentation Status


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

  • Same Python as uv: the bundled interpreter comes from python-build-standalone, the same builds uv python install uses - what you develop and test with locally is what ships in the AppImage
  • Reproducible builds, opt-in: pin the toolchain once and get byte-identical .AppImage output across machines and over time (details below)

Quick Start — just want an AppImage

python -m pip install appimage

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

No pyproject.toml yet? uv init creates a minimal one in seconds.

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

# Writes the AppImage to dist/myapp-x86_64.AppImage
python -m appimage.ctl build

That's it - a working AppImage. Shipping to production? See Reproducible builds below for byte-identical output across machines and over time.

Reproducible builds

Two reasons this matters: security - anyone can independently rebuild from source and verify the result matches, instead of trusting the build server - and production operation - an unpinned toolchain silently changes what gets bundled as tools and dependencies release new versions, so the same build command can produce a different result next month even without a single code change.

To guarantee byte-identical builds across machines and over time:

# See what's pinned and what's missing
python -m appimage.ctl check

# Pin the toolchain, hash-pin every dependency, verify with a real build,
# then turn reproducible = true on in pyproject.toml - only once that build succeeds
python -m appimage.ctl enable-reproducible

# Every later build already enforces it - no flag needed
python -m appimage.ctl build

Important: these pins go stale - re-run periodically to pick up newer releases:

python -m appimage.ctl lock           # refresh dependency pins
python -m appimage.ctl update-tools   # refresh toolchain pins

See Reproducible builds for the piecewise form and what each step does.

Bundled interpreter access

Run the bundled Python directly, or switch to any other installed console script by name - handy for a REPL, a one-off script, or an app that bundles more than one command:

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

Example: want to start a Django application from an AppImage? A Django project needs a WSGI server to actually serve traffic (gunicorn) and separate management commands (django-admin migrate, createsuperuser, ...) - all running the exact same code and dependencies:

./mysite-x86_64.AppImage --python-entry-point gunicorn mysite.wsgi:application
./mysite-x86_64.AppImage --python-entry-point django-admin migrate
./mysite-x86_64.AppImage --python-entry-point django-admin createsuperuser

Virtual environments

Install a plugin without rebuilding the AppImage. SSH-MITM, for example, discovers plugins as installed entry points - a venv built on the AppImage's own interpreter lets pip install add one, picked up automatically.

./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.

Configuration

All options go in [tool.appimage] inside pyproject.toml, and every key is optional. Lifecycle hooks, extra files, custom AppRun scripts, and environment variable injection are supported. See the full documentation for details.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

appimage-4.0.1.tar.gz (91.9 kB view details)

Uploaded Source

Built Distribution

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

appimage-4.0.1-py3-none-any.whl (100.9 kB view details)

Uploaded Python 3

File details

Details for the file appimage-4.0.1.tar.gz.

File metadata

  • Download URL: appimage-4.0.1.tar.gz
  • Upload date:
  • Size: 91.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for appimage-4.0.1.tar.gz
Algorithm Hash digest
SHA256 c7f9394e5fff4fe81f6a548cfa802ea980ad01f7b447d34c3c79a248b16ade78
MD5 87dfbb938185c16c09b38c53354fcaf1
BLAKE2b-256 7bbc5ed75d0e4c09230b455b37e2a9b8f622cdbc3e3ffb88494b5c3dc25e831a

See more details on using hashes here.

Provenance

The following attestation bundles were made for appimage-4.0.1.tar.gz:

Publisher: python-publish.yml on ssh-mitm/appimage

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

File details

Details for the file appimage-4.0.1-py3-none-any.whl.

File metadata

  • Download URL: appimage-4.0.1-py3-none-any.whl
  • Upload date:
  • Size: 100.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for appimage-4.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4b1c574a07b839b9050fec699a4d060c99b81fd0050dbcea1d169b0a1f0f0248
MD5 28c6d67246cb28edaa90f5210715d1bb
BLAKE2b-256 1202c001f32c6b97404ec1f5d297487a6be7c72b385cf8b44ef6be62a883817c

See more details on using hashes here.

Provenance

The following attestation bundles were made for appimage-4.0.1-py3-none-any.whl:

Publisher: python-publish.yml on ssh-mitm/appimage

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

Release history Release notifications | RSS feed

This release

4.0.1 This release

2 files

4.0.0

2 files

3.0.1

2 files

3.0.0

2 files

2.0.1

2 files

2.0.0

2 files

1.2.0

2 files

1.1.1

2 files

1.1.0

2 files

1.0.0

2 files

0.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page