https://github.com/trin94/pyside6-project-template
An unofficial and opinionated project template designed for a quick start with PySide6 and QtQuick
https://github.com/trin94/pyside6-project-template
python qml qt6 qtquick template
Last synced: 6 months ago
JSON representation
An unofficial and opinionated project template designed for a quick start with PySide6 and QtQuick
- Host: GitHub
- URL: https://github.com/trin94/pyside6-project-template
- Owner: trin94
- License: gpl-3.0
- Created: 2022-05-22T09:04:49.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-05T10:41:03.000Z (6 months ago)
- Last Synced: 2025-04-06T02:06:52.465Z (6 months ago)
- Topics: python, qml, qt6, qtquick, template
- Language: Python
- Homepage:
- Size: 253 KB
- Stars: 109
- Watchers: 3
- Forks: 19
- Open Issues: 1
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# Unofficial Opinionated Template for PySide6 with QtQuick
An unofficial and opinionated project template designed for a quick start with PySide6 and QtQuick.
# Features
- Compatible with Python **3.9+**
- Supports internationalization,
including [Right-to-Left User Interfaces](https://doc.qt.io/qt-6/qtquick-positioning-righttoleft.html)
- Leverages the [Qt Resource System](https://doc.qt.io/qt-6/resources.html) to compile resources in `data`, `i18n`, or
`qml` into a Python file:
- `data` accessible at `:/data` or `qrc:/data`
- `i18n` accessible at `:/i18n` or `qrc:/i18n`
- `qml` accessible at `:/qt/qml` or `qrc:/qt/qml`
- Final build consists solely of Python files
- Preconfigured testing (Python + QML)
- CI setup included
- Client-side window decorations implemented
- No need for Qt Creator; use your preferred text editor
## Development Setup
1. **Install these tools**
- [Compatible Python version](https://www.python.org/downloads)
- [uv](https://github.com/astral-sh/uv)
- [just](https://github.com/casey/just)
- **Windows users also need**
- [Git Bash](https://git-scm.com/downloads)
- Be sure to run `just` inside Git Bash
2. **Clone the repository**
3. **Open a terminal** where you cloned it
4. **Initialize the environment**:
```shell
just init
```
## Workflow
Whenever you change files in the `data`, `i18n`, or `qml` directories, run:
```shell
just build-develop
```
This compiles them into a Python file in the myapp folder, so the app recognizes them on startup.
To start the app, run:
```shell
uv run main.py
```
**Tip:** Configure your IDE to run the `build-develop` recipe before launching the application.
## Just recipes
```just
$ just --list
Available recipes:
[build]
build # Build full project into build/release
build-develop # Build and compile resources into source directory
clean # Remove ALL generated files
init ARGS='--group dev' # Initialize repository
[i18n]
add-translation locale # Add new language
update-translations # Update *.ts files by traversing the source code
[test]
test # Run Python and QML tests
test-python # Run Python tests
test-qml # Run QML tests
```
## Internationalization
- Instructions for adding new languages can be found [here](docs/internationalization.md).
## Read Further
- Qt6: https://doc.qt.io
- Python: https://www.python.org
- PySide6: https://doc.qt.io/qtforpython/contents.html
- Examples for Qt, QtQuick & Python: https://pypi.org/project/PySide6-Examples/
- QML Coding Conventions: https://doc.qt.io/qt-6/qml-codingconventions.html
- Python & QML: https://doc.qt.io/qtforpython/PySide6/QtQml/index.html
- Scripting: https://doc.qt.io/qt-6/topics-scripting.html
- Importing JavaScript Resources in QML: https://doc.qt.io/qt-6/qtqml-javascript-imports.html
- Packaging on Linux: https://github.com/andyholmes/flatter
# Dependencies
- PySide6: https://pypi.org/project/PySide6
- PyTest: https://pypi.org/project/pytest
- Just: https://github.com/casey/just
- App Icon: https://commons.wikimedia.org/wiki/File:Qt_logo_2016.svg
- Material Icons: https://fonts.google.com/icons?selected=Material+Icons
# Apps Made with This Template
- mpvQC (https://mpvqc.github.io)
Create a Pull Request to add your app to the list 😊
# FAQ
- Is it exclusively **PySide6**? Can **PyQt6** be used instead of PySide6?
> Yes, it should be possible but may require additional work.