Skip to main content

Automatic hook and data file bundler for PyInstaller.

Project description

pyi-autobundle

Automatic hook and data file bundler for PyInstaller — a tool to help generate hooks, collect package assets, and produce PyInstaller spec files automatically so you can build portable binaries with a single command.

Key Features

  • Static AST import scanning and basic dynamic import detection.
  • Optional runtime import tracing to capture imports that only appear at runtime.
  • Package inspection to collect datas (images, JSON, templates, ML models) and native binaries.
  • Automatic generation of PyInstaller hook-*.py files and a working .spec file.
  • One-command CLI: pybundle (entrypoint: pyi_autobundle.cli:main).
  • Centralized configuration via pyproject.toml under [tool.pyi-autobundle].
  • .buildignore support to exclude files, directories, or patterns from inclusion.
  • Built-in hidden-imports database for common problematic packages (numpy, pandas, torch, PIL).
  • --dry-run mode to audit what would be included without building.

Installation

Install in editable/development mode or as a package in your Python environment:

python -m pip install -e .
python -m pip install pyinstaller

CLI Usage

Basic one-command build:

pybundle path\to\main.py --trace

Common flags:

  • --trace : run the runtime import tracer in addition to static scanning
  • --onefile : build a single-file executable (PyInstaller --onefile)
  • --windowed : create a windowed app (no console)
  • --hooks-dir : directory to write generated hooks (default: .pyi-hooks)
  • --buildignore : path to a .buildignore file to exclude assets
  • --dry-run : list files/modules that would be included and exit

Configuration (pyproject.toml)

You can set default build options in pyproject.toml under the tool.pyi-autobundle table. Example:

[tool.pyi-autobundle]
onefile = true
windowed = false
name = "myapp"
icon = "assets/app.ico"

The CLI will merge values from this config with any flags you pass on the command line.

.buildignore

Place a .buildignore file in your project root to exclude files or patterns from being collected. Lines starting with # are treated as comments. Example:

# exclude tests and dataset
tests/
data/raw/
*.log

Resource discovery

If your code uses a helper like get_resource_path("assets/icon.png"), the static scanner attempts to detect literal calls and automatically include referenced files in the build.

Dry-run audit

Use --dry-run to print a report of datas, binaries, and hiddenimports that would be included by the build process without invoking PyInstaller.

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

pyi_autobundle-0.1.5.tar.gz (12.4 kB view details)

Uploaded Source

Built Distribution

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

pyi_autobundle-0.1.5-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

File details

Details for the file pyi_autobundle-0.1.5.tar.gz.

File metadata

  • Download URL: pyi_autobundle-0.1.5.tar.gz
  • Upload date:
  • Size: 12.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.11

File hashes

Hashes for pyi_autobundle-0.1.5.tar.gz
Algorithm Hash digest
SHA256 001610223a9b8874b7290c921968c32731f15c8f089ecfc71ce638a8e13a4cd2
MD5 891fc12aff315a23b280cffa2c45c32f
BLAKE2b-256 1123ff39573702745ed4d7c9166b56d963e46a30bfabb694c0ad5f9ac7f8a17a

See more details on using hashes here.

File details

Details for the file pyi_autobundle-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: pyi_autobundle-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 15.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.11

File hashes

Hashes for pyi_autobundle-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 66f2bf26d52a45e65bfcff135be34aa478a6ace067a3fcb4d61daaef47452c2e
MD5 1a50323e392bec9e64585f3ddc8a9b3c
BLAKE2b-256 12ee6a6f55540be07099672b2b6cd95d790364caf69d022e225167353d04283c

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