PySide6 Project Template

Easy to use template for PySide6 projects. This template is designed to help you get started with PySide6 quickly and easily. It includes a basic project structure, a build script, and a pyproject file.

Even if some company computers are underpowered, they're still usable in most cases. You just need to install uv and Python 3.8.

Warning

The project is currently testing new features and is in an unstable phase.

default theme preview

Main Dependencies

• pyside-cli
• PySide6
• qasync
• httpx
• PyQtDarkTheme
• Nuitka
• pytest

Project Structure

File or Directory	Description
.cache/assets.json	Build Caches
.gitlab-ci.yml	GitLab auto release script
.github/workflow/release.yml	GitHub auto release script
app/	Source code directory
app/assets/**	Qt resources files (images, icons, etc.)
app/i18n/*.ts	Qt I18N's *.ts files
app/resources/*.py	Generated Python files from UI and QRC files
app/ui/**.ui	Qt Designer UI files
build/	Build destination directory
CHANGE.md	Release notes for CI/CD
pyproject.toml	Project builds and settings
qml_demo	See qml_demo/README.md

Project Setup and Usage

build via pyside-cli

Create your project

I recommend using pyside-cli to create your project, for example:

pip install pyside-cli
pyside-cli create your_project

IDE/Editor Support

• IDEA (PyCharm, CLion, etc.)

• Microsoft Visual Studio Code

Command

You also can use the command line to run the project.

• Setup development environment.

  uv sync

• Using QtDesigner to create UI files. The UI files are must have located in the ui folder.

  uv run pyside6-designer app/ui/main_window.ui

• How to build and package the project. Run the following command to get the help message:

  uv run pyside-cli --help

• Run test in command line:

  uv run pyside-cli test

  Or use your environment file to run the app:

  uv run pyside-cli build --stage rc
  uv run --env-file .env -- python -m app

Others

• Release and Product Version Control
• Internationalization
• Windows 7 Compatibility
• macOS Build Guide