pyinstaller-plus 0.1.26

PyInstaller wrapper that runs DistroMate packaging/publish after build

pyinstaller-plus

pyinstaller-plus is a PyInstaller-compatible wrapper that keeps your existing PyInstaller workflow and then runs DistroMate packaging or publishing, with a built-in login shortcut. This README focuses on end-user packaging usage.

Features

• Compatible with standard PyInstaller arguments
• Supports login mode (distromate login)
• Runs distromate package after a successful PyInstaller build
• Supports publish mode (distromate publish)
• Works on Windows, macOS, and Linux
• Depends on the distromate Python package instead of bundling its own CLI
• Supports --appid for package / publish
• Uses PyInstaller args and .spec metadata as defaults, then overlays distromate.yaml

Install

pip install pyinstaller-plus

distromate will be installed automatically as a dependency.

Quick Start

1. Log in to DistroMate:

pyinstaller-plus login

2. Optional: create a distromate.yaml (or distromate.yml) in your project root. If omitted, pyinstaller-plus still derives package metadata from your PyInstaller args or .spec file.

3. Build and package:

pyinstaller-plus package -v 1.2.3 --appid com.example.app your.spec

4. Build and publish:

pyinstaller-plus publish -v 1.2.3 --appid com.example.app your.spec

Use --distromate-config ./config/release.yaml if your overlay file is not in the project root.

CLI Behavior

pyinstaller-plus executes one of these flows:

• login: resolve DistroMate CLI from the Python dependency or PATH, then run distromate login

• package / publish:

  1. Run python -m PyInstaller ...
  2. Resolve DistroMate CLI from:
     • installed distromate Python package
     • PATH
  3. Resolve release version from:
     • package -v / package --version
     • publish -v / publish --version
     • pyproject.toml -> project.version
  4. Resolve publish app id from:
     • package --appid
     • publish --appid
  5. Derive adapter defaults from PyInstaller args and .spec metadata:
     • productName
     • package.name
     • package.executable
     • package.target
     • package.icon (from --icon or EXE(icon=...))
     • package.description (from --version-file or EXE(version=...) -> FileDescription)
     • package.publisher (from --version-file or EXE(version=...) -> CompanyName)
  6. Overlay distromate.yaml / distromate.yml on top of those defaults
  7. Pipe the final config to one of:
     • distromate --config - package -v <version>
     • distromate --config - publish -v <version>

Commands

• login: run distromate login
• package -v <version> [--appid <appid>] [--distromate-config <path>]: build with PyInstaller, then run distromate package
• publish -v <version> [--appid <appid>] [--distromate-config <path>]: build with PyInstaller, then run distromate publish

Use -- when you need to pass PyInstaller's own --version through the wrapper.

Example distromate.yml

productName: MyApp

publish:
  appId: your_appid

package:
  name: myapp
  description: My desktop app
  executable: dist/myapp.exe
  target: dist
  publisher: MyApp Publisher
  language: english
  files:
    - "**/*"
    - "!**/.git/**"
    - "!**/*.log"
    - "!temp/**"
    - "!**/__pycache__/**"
    - "!**/*.pyc"
  preservePaths:
    - config
    - data

package.files uses electron-builder-compatible glob patterns.