Skip to main content

maketool

maketool is a command-line utility and helper module that simplifies execution and building PySide6 Python 3.7+ applications into executables using PyInstaller 5.8.0. Note: Windows only

It's especially useful for GUI projects that need embedded resources (e.g., .ui, .qrc) and aim to produce portable .exe builds with minimal setup.


Why Use maketool?

If you build windows desktop apps using PySide6, maketool:

  • Saves time when converting .ui and .qrc files
  • Simplifies PyInstaller builds
  • Packages your application with minimal commands
  • Automates repetitive tasks like building and cleanup
  • Integrates easily with .bat scripts or shell commands
  • Is great for both beginners and advanced developers using PySide6

Commands

1. run

Purpose: Compile .ui and .qrc files recursively (using pyside6-uic.exe and pyside6-rcc.exe), then run the Python program using pythonw.exe.

Note: it will ONLY rebuild pyside components that are out of date, so that execution is fast as possible, yet always includes any changes. FYI: python program is run with pythonw.exe so that the terminal window does not appear.

usage: maketool-run [-h] file

parameters:
  file        python file to run

parameters:
  -h, --help  show this help message and exit

2. clean

Purpose: Remove build artifacts, caches, generated UI files, PyInstaller output, and spec files.

  • __pycache__ folders
  • *_ui.py, *_rc.py, *.pyc, *.pyo
  • PyInstaller build/ and dist/ folders
  • .spec files in the current directory

Run it like this:

maketool-clean

3. compile

Purpose: Build an executable using PyInstaller, including UI/QRC compilation, icon embedding, version stamping, and resource embedding.

  • Supports onefile/onedir/console modes.

  • AutoGenerates a PyInstaller .spec file

  • Handles .ui/.qrc compilation automatically.

  • Supports embedding arbitrary files which is useful for DLLs or data assets.

  • Runs PyInstaller with the provided options

  • Updates version if exists in python file with --version value if provided

usage: maketool-compile [-h] --file FILE --type {onefile,onedir,console} [--icon=ICON] [--embed=EMBED] [--version=VERSION]

parameters:
  -h, --help            show this help message and exit
  --file FILE           python file to compile to exe
  --type {onefile,onedir,console}
                        type of exe to build
  --icon ICON           ico file
  --embed EMBED         comma delimited list of files to embed
  --version VERSION     program version (otherwise use __version__ in py source)

4. sublime

WARNING: This will overwrite existing custom key bindings at that path Purpose: Install custom Sublime Text 4 shortcuts and commands. Future: plan for support of vscode editor.

CTRL+BACKSPACE - delete line CTRL+ALT+E - open windows explorer where current file is located CTRL+0 - reset font size F1 - insert print statement for variable where cursor is located F5 - run pyflakes on current python source F6 - maketool-refscan - scan for unused/orphan files in the project F7 - build (runs maketool-run on current script via the build system) F10 - insert current date/day

usage: maketool-sublime [-h] --path PATH

parameters:
  -h, --help            show this help message and exit
  --path PATH           sublime text - data/package/user path

5. refscan

Purpose: Scan for unused/orphan files using string-based heuristics. This is especially useful for catching forgotten assets like .ui, .qss, .ico, images, etc. "Unused" means "no string reference found anywhere in .py files".

Default behavior is unused only:

maketool-refscan

Show both used and unused:

maketool-refscan --show-used

Write a CSV report:

maketool-refscan --csv refscan-report.csv

Notes:

  • This is heuristic (string-based). It may miss dynamically constructed paths/imports and may produce false positives.
  • For best results, run it from your project root.

Features

  • Simple command-line interface for .bat or .sh workflows
  • Converts all .ui and .qrc files recursively
  • Cleans up Python build artifacts
  • Packages apps using PyInstaller
  • Supports custom .ico icons
  • Supports optional resource embedding

Requirements


Installation

Install maketool helper from PyPI with following command:

pip install maketool

License

MIT License
Copyright 2026 Alan Lilly

Metadata

Release files for maketool 0.8.31

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for maketool 0.8.31
File Size Uploaded Provenance Actions
maketool-0.8.31.tar.gz 18.6 kB Without provenance Details for maketool-0.8.31.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for maketool 0.8.31
File Interpreter ABI Platform Actions
maketool-0.8.31-py3-none-any.whl Python 3 none any Details for maketool-0.8.31-py3-none-any.whl

Total release size: 37.6 kB

Release files / maketool-0.8.31.tar.gz

Download URL maketool-0.8.31.tar.gz
Size 18.6 kB
Tags Source
SHA-256 checksum
How to use checksums
ef52f771fc2a9b451aa339eefc7dff2c1a10e7cd70c10c3853be0e29dbf1f34e
BLAKE2b-256 checksum
How to use checksums
ac1cd131fb5dc6d757ddb7db84244b717a9ca2e8e484fd656b513385aa81596e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.2

Release files / maketool-0.8.31-py3-none-any.whl

Download URL maketool-0.8.31-py3-none-any.whl
Size 19.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
311e8d485e2f35f278b64990127d3a3424e84a3951ef715cb1f73bf666d7b938
BLAKE2b-256 checksum
How to use checksums
e2b808c8727ac6d9a4ca5176b413e49fdbb92539a1e0d731bd2e529385acaa72
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.2

Security for maketool 0.8.31

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.8.31 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page