Check out the Exe app above

Creating a PySide6 Project with Custom Widgets and PyInstaller

Watch youtube tutorial

1. Install Python

First, ensure that you have Python installed on your system. You can download Python from python.org.

2. Install the Custom Widgets Module

Next, install the custom widgets module from GitHub using pip:

pip install QT-PyQt-PySide-Custom-Widgets

3. Create a New Project

Create a new PySide6 project using the custom widgets project maker command:

Custom_Widgets --create-project

4. Open the Project Folder

Navigate to the project folder that was created.

5. Edit the UI in Qt Designer

Inside the project folder, open the ui folder and start editing the UI using Qt Designer.

6. Monitor UI Changes

While editing the UI, open a terminal inside the project folder and run the following command to monitor UI files for changes:

Custom_Widgets --monitor-ui ui

This will automatically convert UI files to Python and generate necessary files for the custom widgets module.

7. Preview the UI

After finishing the UI design, preview it to ensure everything looks as expected.

8. Add GUI Functions and Classes

Now, add other GUI functions and classes inside the Python files (e.g., main.py).

9. Customize and Style the GUI

Customize and style your GUI using the custom widgets module. This module will read the JSON files and QSS stylesheet files inside the project folder.

10. Convert the GUI App to an Executable

Finally, convert your GUI application to an executable using PyInstaller. First, install PyInstaller:

pip install pyinstaller

Generate the Spec File

Next, generate the spec file for your project:

pyi-makespec --onefile --windowed main.py

Edit the Spec File

Open the generated .spec file and edit it as shown below. Replace names and paths as necessary:

# -*- mode: python ; coding: utf-8 -*-

block_cipher = None

a = Analysis(
    ['main.py'],
    pathex=[],  # Add paths if needed
    binaries=[],
    datas=[],  # Add data files if needed
    hiddenimports=['PySide6'],  
    hookspath=[],
    hooksconfig={},
    runtime_hooks=[],
    excludes=['PyQt5', 'PySide2', 'PyQt6'],  
    noarchive=False,
)

pyz = PYZ(a.pure)

exe = EXE(
    pyz,
    a.scripts,
    [],
    exclude_binaries=True,
    name='YourAppName',  # Set the name of your executable
    debug=False,
    bootloader_ignore_signals=False,
    strip=False,
    upx=True,
    console=False,  # Set console to False
    disable_windowed_traceback=False,
    argv_emulation=False,
    target_arch=None,
    codesign_identity=None,
    entitlements_file=None,
    icon='path/to/your/icon.ico'  # Replace 'path/to/your/icon.ico' with the path to your icon file
)

coll = COLLECT(
    exe,
    a.binaries,
    a.datas,
    strip=False,
    upx=True,
    upx_exclude=[],
    name='main',
)

Build the Executable

Finally, build the executable using the edited spec file:

pyinstaller your_spec_file.spec

Locate the Executable

After the build process is complete, the executable will be located in the dist folder inside your project directory. The path will be similar to:

your_project_folder/dist/YourAppName.exe

Note: Remember to copy other required static data files to your exe folder.