Skip to main content

🛠️ sidetool

sidetool 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.

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 sidetool?

If you build windows desktop apps using PySide6 or PyQt, sidetool:

  • 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

Executes the Python program after recursively builds all .ui and .qrc files in the current directory and subdirectories using pyside6-uic.exe and pyside6-rcc.exe. Then run python source code.

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: sidetool-run [-h] file

positional parameters:
  file        python file to run

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

2. clean

Removes temporary files and build artifacts, including:

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

Run it like this:

sidetool-clean

3. compile

Builds your python app into an executable using PyInstaller.

  • Compiles .ui and .qrc and image resources
  • Generates a PyInstaller .spec file
  • Runs PyInstaller with the provided options
usage: sidetool-compile [-h] --file FILE --type {onefile,onedir,console} [--icon="myicon.ico"] [--embed="sqlite3.dll"]

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

✨ 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 sidetool helper from PyPI with following command:

pip install sidetool

📝 License

MIT License
© 2025 Alan Lilly

Metadata

Release files for sidetool 0.4.8

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

Source distribution (sdist)

Source distribution for sidetool 0.4.8
File Size Uploaded Provenance Actions
sidetool-0.4.8.tar.gz 8.7 kB Without provenance Details for sidetool-0.4.8.tar.gz

Built distribution (wheel)

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

Total release size: 18.0 kB

Release files / sidetool-0.4.8.tar.gz

Download URL sidetool-0.4.8.tar.gz
Size 8.7 kB
Tags Source
SHA-256 checksum
How to use checksums
1a115162cfbccd63cee1c32188147c98769d2bce9912d4b7d642524d0c437c85
BLAKE2b-256 checksum
How to use checksums
64e09d55b7f48a2261961310a3bc165427edbcb6980ff681472f15926d3bacf2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.2

Release files / sidetool-0.4.8-py3-none-any.whl

Download URL sidetool-0.4.8-py3-none-any.whl
Size 9.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f82f5d40ec7cf5430f2c005f2083693774aee5117b198f52b3feab75a74dc406
BLAKE2b-256 checksum
How to use checksums
e9b203eeb952e76a26b7fa305c2e59759fef8ed6bfdce0cb1a2b50c89db92e74
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.2

Security for sidetool 0.4.8

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.4.8 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