Skip to main content

Configurable desktop launcher for Docker-based applications

Project description

docker-app-launcher

Configurable desktop launcher for Docker-based applications. One persistent window. It opens, shows progress, and never closes itself — no dialog chains.

CI PyPI Python License: MIT

🇩🇪 Deutsche Version

Quick Start

pip install docker-app-launcher

Python API (3 lines)

from docker_app_launcher import LauncherConfig, launch

launch(LauncherConfig(
    app_name="My App",
    container_name="my-app",
    default_port=8080,
))

CLI

docker-app-launcher --config launcher.json   # open the window
docker-app-launcher --status                  # print state and exit
docker-app-launcher --install --port 9000     # build + start headless
docker-app-launcher --check                   # is Docker running?

launcher.json

Everything is configurable. Only app_name is required — the rest is derived (slug, container/image names, compose project, config dir) or defaulted.

{
  "app_name": "My App",
  "container_name": "my-app",
  "default_port": 8080,
  "compose_file": "docker-compose.prod.yml",
  "install_dir": "/opt/my-app",
  "health_check_path": "/api/health",
  "health_check_key": "status",
  "health_check_value": "ok",
  "repo_url": "https://github.com/owner/repo",
  "locale": "en"
}

Features

  • One persistent window — never closes itself; only the X closes it.
  • Docker check on startup — distinguishes not installed / running / stopped / no Docker.
  • Live build progress — the Docker build is streamed line-by-line into the window.
  • Configurable port — editable in the GUI and via --port, validated and persisted (to launcher.json and .env).
  • Verified actions — install runs a health check; uninstall re-lists the containers to confirm they are gone.
  • Install manifest + startup cleanup — finds and offers to remove stale leftovers of older installs.
  • Verbose uninstall / cleanup — every step reported with a ✓ / ✗ result.
  • System tray (optional) — pip install docker-app-launcher[tray]; the window minimizes to the tray while running.
  • DE / EN i18n — with per-app custom-string overrides via custom_strings.
  • Actions architecture — all business logic is GUI-free and unit-tested without a display.
  • CLI ↔ GUI parity — both call the exact same actions layer.

Architecture

Module Responsibility
config.py LauncherConfig dataclass — the single source of truth.
actions.py All business logic. No tkinter. Fully testable.
gui.py LauncherApp(tk.Tk) — a thin window over the actions.
tray.py Optional system tray (pystray + Pillow).
i18n.py DE/EN strings with custom-string overrides.
__main__.py CLI entry point + GUI router.

Configuration reference

See LauncherConfig for the full field list (app identity, network/health, Docker timeouts, paths, GUI, links, cleanup, tray, i18n, and lifecycle callbacks).

Development

poetry install --with dev --all-extras
make ci        # lint + format-check + typecheck + tests
make test      # tests with coverage
make fix       # auto-fix lint + format

Used by

License

MIT © Asterios Raptis

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

docker_app_launcher-0.2.2.tar.gz (35.1 kB view details)

Uploaded Source

Built Distribution

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

docker_app_launcher-0.2.2-py3-none-any.whl (40.2 kB view details)

Uploaded Python 3

File details

Details for the file docker_app_launcher-0.2.2.tar.gz.

File metadata

  • Download URL: docker_app_launcher-0.2.2.tar.gz
  • Upload date:
  • Size: 35.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for docker_app_launcher-0.2.2.tar.gz
Algorithm Hash digest
SHA256 b3b193963a5c5bc3e000c88af0c1cb5174aa651793319d9b15cdc571c2104024
MD5 f816a1fb882400a79c4eafa8c352b5e1
BLAKE2b-256 16f8123d479e746a06d00075211f26bafee7213f4431bf811edf9b18fdb2b5d1

See more details on using hashes here.

File details

Details for the file docker_app_launcher-0.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for docker_app_launcher-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c2014f2204fef5ee8d3b794bba8cadced98914605a0c56410f04e519457a21ed
MD5 59579097b9b4106dfb2659fe0fa2951f
BLAKE2b-256 799fcc3fca29908154c9070617ce810d98d04ea0f224d1e98a1e96014e1ac7f9

See more details on using hashes here.

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