https://github.com/shiinasama/pyside-template
A simple pyside6 project template with build script.
https://github.com/shiinasama/pyside-template
linux macos pyside6 python windows
Last synced: 4 months ago
JSON representation
A simple pyside6 project template with build script.
- Host: GitHub
- URL: https://github.com/shiinasama/pyside-template
- Owner: SHIINASAMA
- License: mit
- Created: 2025-03-29T07:06:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-02-28T09:27:01.000Z (4 months ago)
- Last Synced: 2026-02-28T14:08:24.756Z (4 months ago)
- Topics: linux, macos, pyside6, python, windows
- Language: Python
- Homepage:
- Size: 9.74 MB
- Stars: 51
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGE.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](qml_demo/README.md) |
## Project Setup and Usage
build via pyside-cli
### Create your project
I recommend using [**pyside-cli**](https://github.com/SHIINASAMA/pys-cli)
to create your project, for example:
```bash
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.
```bash
uv sync
```
- Using QtDesigner to create UI files. The UI files are must have located in the `ui` folder.
```bash
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:
```bash
uv run pyside-cli --help
```
- Run test in command line:
```bash
uv run pyside-cli test
```
Or use your environment file to run the app:
```bash
uv run pyside-cli build --stage rc
uv run --env-file .env -- python -m app
```
## Others
- [Release and Product Version Control](docs/publish.md)
- [Internationalization](docs/i18n.md)
- [Windows 7 Compatibility](docs/windows7.md)
- [macOS Build Guide](docs/macos.md)