PyX Wizard — Library Edition v0.29.4

Python → EXE Builder Package Python scripts into standalone Windows executables from code.

Quick Start

import pyxwizard

pyxwizard.begin()
pyxwizard.location("my_script.py")
pyxwizard.name("MyApp")
pyxwizard.build()

API Reference

Feedback Modes

Control how much terminal output PyX Wizard produces during a build.

feedback() and callbacks (on_progress, on_log, on_step) can be set before begin() — they persist across begin() calls and are never silently reset.

import pyxwizard

pyxwizard.feedback("step")   # Safe to set before begin()
pyxwizard.begin()
pyxwizard.location("my_script.py")
pyxwizard.name("MyApp")
pyxwizard.build()

Note: Callbacks (on_progress, on_log, on_step) always fire regardless of feedback mode. Set feedback("none") and wire up callbacks to fully control output from your own GUI.

GUI Integration — Callbacks

Wire PyX Wizard directly into your GUI without any terminal noise.

import pyxwizard

# Suppress all terminal output — can be set before begin()
pyxwizard.feedback("none")

# Wire your widgets — these also persist across begin() calls
pyxwizard.on_progress(my_progress_bar.set)    # fn(value: 0.0–1.0, label: str)
pyxwizard.on_log(my_textbox.append)           # fn(message: str)
pyxwizard.on_step(my_sidebar.update)          # fn(step_id: str, label: str, progress: float)

pyxwizard.begin()
pyxwizard.location("my_script.py")
pyxwizard.name("MyApp")
result = pyxwizard.build()

BuildResult

pyxwizard.build() returns a BuildResult object with everything you need. BuildResult is truthy when the build succeeds, so if result: works as expected.

result = pyxwizard.build()

if result.success:
    print(f"EXE: {result.exe_path}")
    print(f"Size: {result.exe_size_mb:.1f} MB")
    print(f"Time: {result.build_duration_seconds:.1f}s")
else:
    print(f"Failed: {result.error_message}")

# Also works:
if result:
    print("Build succeeded!")

Post-Build & Maintenance

Output Files

Every build produces the following files inside PyX_Data/<project>/:

Notes

• "self" mode: pyxwizard.location("self") packages the calling script. All import pyxwizard and pyxwizard.xxx() lines are automatically removed from the packaged copy.

• Data folders: Files in bundled folders are accessible at runtime with "packaged-within-exe:folder_name/file.ext" string literals (auto-rewritten by the preprocessor). Exclusion: pyxwizard.location("self") cannot be used with Data Folders.

• Venv reuse: Building the same project name twice reuses the existing virtual environment instead of recreating it.

• Library categories: On begin(), PyX Wizard fetches a remote JSON of known library metadata to improve PyInstaller compatibility (collect-all, hidden-imports, copy-metadata). Works offline too — just without categorisation.

• Version info: pyxwizard.version("1.2.3") embeds file properties visible in Windows Explorer → right-click → Properties → Details tab.

• Splash screen: pyxwizard.splash("splash.png") requires PyInstaller 4.6+ and Tkinter available in the target environment. As of v0.29.4, Pillow is automatically installed in the build venv if needed, and tkinter availability is validated before the build — if tkinter is missing, the splash flag is silently skipped with a warning instead of failing the build.

• Dry run: pyxwizard.dry_run(True) runs every step (venv, deps, preprocessing) except the actual PyInstaller build — useful for validating your config.

• Feedback & callback persistence: pyxwizard.feedback(), on_progress(), on_log(), and on_step() can be called before begin(). They are not reset when begin() runs, so you can wire up your GUI once and call begin() + build() multiple times.

Changelog (v0.29.4)

• Fixed: Splash screen builds no longer fail — Pillow is now auto-installed in the venv and tkinter availability is checked before the build.
• Fixed: feedback() and callback registrations (on_progress, on_log, on_step) now persist across begin() calls instead of being silently reset.
• Fixed: build() return type corrected from Union[Optional[Path], BuildResult] to BuildResult.
• Fixed: BuildResult now supports bool() — if result: works as documented.
• Fixed: Removed broken uppercase/lowercase PyInstaller retry logic; PyInstaller errors now surface the last 30 lines of output for easier debugging.

Further Details

Check out PyX Wizard by TRADELY

PyPI Library available at: PyPI PyXWizard

Use the README there to set up the library.