Skip to main content

Release pipeline for Python apps on Windows — embedded Python, launcher stub, Inno Setup installer.

Project description

snackbox

A release pipeline tool for Python apps on Windows.

Packages your Python project into a self-contained Windows release using embedded Python, a compiled launcher stub with custom icon, and an optional Inno Setup installer. No freezing, no bytecode magic — just normal Python, transparently packaged.

Installation

pipx install snackbox

Or with pip:

pip install snackbox

Quick Start

# Generate a starter config
snackbox init

# Edit snackbox.yaml to match your project

# Build a release folder
snackbox build

# Build a release + Inno Setup installer
snackbox installer

What it does

snackbox build creates a release/ folder containing:

release/
├── myapp.exe           # Compiled launcher stub (with your icon)
├── version.txt         # Version string (e.g., 1.0.0.abc1234)
├── python/             # Embedded Python environment
│   ├── python.exe
│   ├── Lib/site-packages/
│   │   └── myapp/      # Your installed package
│   └── ...
└── (your assets)       # Config files, data, etc.

snackbox installer additionally creates an Inno Setup installer .exe.

Configuration

Create snackbox.yaml in your project root:

app:
  name: "My App"
  slug: "myapp"
  version_from: "pyproject.toml"
  icon: "assets/myapp.ico"  # optional

python:
  version: "3.12.10"

build:
  wheel:
    backend: "poetry"  # or "pip", "hatch"
  extra_deps: []

launcher:
  entry_point: "myapp"    # runs: python -m myapp
  console: "yes"          # "yes", "no", or "attach"

assets:
  - "config.yaml:config.yaml"
  - "data:data"

version:
  git_hash: true
  dirty_flag: true
  save_patch: true

installer:
  enabled: true
  publisher: "Your Name"
  url: "https://github.com/you/myapp"
  install_dir: "{localappdata}\\MyApp"
  add_to_path: true
  start_menu: true

Console Modes

The launcher.console setting controls how the launcher behaves:

  • "yes" - Always show console (standard CLI app)
  • "no" - No console window (GUI app)
  • "attach" - Smart mode: attaches to existing terminal if launched from one, otherwise runs headless. Perfect for CLI tools that can also run as background services.

Commands

snackbox init              # Generate starter snackbox.yaml
snackbox build             # Build release folder
snackbox build --clean     # Rebuild embedded Python from scratch
snackbox build --force     # Force reinstall the app wheel
snackbox installer         # Build release + Inno Setup installer
snackbox cache show        # Show cache location and contents
snackbox cache clean       # Wipe the download cache
snackbox --version         # Print snackbox version

Requirements

  • Windows: Native builds work directly
  • GCC: MinGW-w64 for compiling the launcher (install via MSYS2 or scoop)
  • Inno Setup: For building installers (optional)

Cross-compilation (Linux/macOS)

Use the Docker image for cross-compilation:

docker run --rm -v $(pwd):/project ghcr.io/lanceliogs/snackbox build
docker run --rm -v $(pwd):/project ghcr.io/lanceliogs/snackbox installer

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

snackbox-0.1.0.tar.gz (19.2 kB view details)

Uploaded Source

Built Distribution

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

snackbox-0.1.0-py3-none-any.whl (26.3 kB view details)

Uploaded Python 3

File details

Details for the file snackbox-0.1.0.tar.gz.

File metadata

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

File hashes

Hashes for snackbox-0.1.0.tar.gz
Algorithm Hash digest
SHA256 5cfda127fca8b4c597296885c595a07e17a55c0855febada5405f5c9cec6307f
MD5 67b0f5f6057f08a7d9121517bd8533fa
BLAKE2b-256 6b70e80073bbbec402bdb4fde5e3ad2bff2384df4546e8b9199e570cec7f7c50

See more details on using hashes here.

Provenance

The following attestation bundles were made for snackbox-0.1.0.tar.gz:

Publisher: release.yml on Lanceliogs/snackbox

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

File details

Details for the file snackbox-0.1.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for snackbox-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d69b164c2178a6c69a49eea67a1d7b76b37f29e740b1299c95df3467481fc100
MD5 41a506ed8698de188a6004bf8fbcefff
BLAKE2b-256 5119afd793dbd6fc4a60e1f350c54e586bc1b1ee1a9c219330ace2367a96a80f

See more details on using hashes here.

Provenance

The following attestation bundles were made for snackbox-0.1.0-py3-none-any.whl:

Publisher: release.yml on Lanceliogs/snackbox

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