Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tuv-sud-product-service-gmbh/qutestyle
An expandable application framework for Qt
https://github.com/tuv-sud-product-service-gmbh/qutestyle
gui pyside6 python qt
Last synced: 1 day ago
JSON representation
An expandable application framework for Qt
- Host: GitHub
- URL: https://github.com/tuv-sud-product-service-gmbh/qutestyle
- Owner: TUV-SUD-Product-Service-GmbH
- License: mit
- Created: 2022-03-25T23:33:33.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2025-01-06T18:24:55.000Z (3 days ago)
- Last Synced: 2025-01-06T19:34:47.427Z (3 days ago)
- Topics: gui, pyside6, python, qt
- Language: Python
- Homepage:
- Size: 873 KB
- Stars: 19
- Watchers: 1
- Forks: 4
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# QuteStyle
QuteStyle is an expandable application framework for PySide6 and heavily inspired by [PyDracula](https://github.com/Wanderson-Magalhaes/Modern_GUI_PyDracula_PySide6_or_PyQt6).
The main goal of this project is to provide a simple and easy to use application frame that can be used to create a new application.
It is mainly suited for applications that rely on a center widget for user interaction. Functionality is extendable by having different widgets that can be loaded into that center widget area.
**Project status**
[](https://www.python.org/downloads/)
[](https://www.qt.io/qt-for-python)
[](https://github.com/TUV-SUD-Product-Service-GmbH/QuteStyle/blob/master/LICENSE)
[](https://github.com/python/black)
**Tests**
[](https://results.pre-commit.ci/latest/github/TUV-SUD-Product-Service-GmbH/QuteStyle/master)
[](https://github.com/TUV-SUD-Product-Service-GmbH/QuteStyle/actions?query=workflow%3ACodeQL)
[](https://github.com/TUV-SUD-Product-Service-GmbH/QuteStyle/actions?query=workflow%3ATests)
[](https://codecov.io/gh/TUV-SUD-Product-Service-GmbH/QuteStyle)
**Package**
[](https://pypi.org/project/qute-style/)
[](https://pypi.org/project/qute-style/#files)
## Features
- Easy integration of already existing widgets
- Preset themes that easily can be modified
- Custom widgets
- Splash screen
- Build-in release history
- Used and developed in a productive environment
## Themes and Styled Widgets
QuteStyle provides five themes, defining the color composition of the app.
Additionally, the user can define new themes ([check this out](https://github.com/TUV-SUD-Product-Service-GmbH/QuteStyle/blob/master/docs/style.md)). We provide five themes, for example a dark and light mode ```Darcula``` and ```Highbridge Grey```.
We defined [custom widgets](https://github.com/TUV-SUD-Product-Service-GmbH/QuteStyle/blob/master/docs/widgets.md), such that they fit to the overall style and implemented new behaviour. A selection can be found in the Test-App:
## Requirements
- [Python 3.10+](https://www.python.org/downloads/)
- [PySide6](https://wiki.qt.io/Qt_for_Python)
## Installation Method
```plaintext
pip install qute-style
```
## Usage
```Python
import sys
from qute_style_examples.sample_main_window import StyledMainWindow
from qute_style.qs_application import QuteStyleApplication
from qute_style.update_window import AppData
class MyApplication(QuteStyleApplication):
# take a look at qute_style_examples.sample_main_window and qute_style_examples.sample_widgets
# to find out more about setting up a main window and the widgets that it
# should display
MAIN_WINDOW_CLASS = StyledMainWindow
# add basic information about your application
APP_DATA = AppData(
"Test-App",
"2.3.4",
":/svg_images/logo_qute_style.svg",
":/svg_images/logo_qute_style.svg",
"",
"Test Version",
)
if __name__ == "__main__":
APP_NAME = "Test-App"
app = MyApplication(sys.argv)
sys.exit(app.exec())
```
For further information, see our [documentation](https://github.com/TUV-SUD-Product-Service-GmbH/QuteStyle/tree/master/docs).
## Example
Check out our example app by running:
```plaintext
python -m qute_style_examples
```
## License
The original design idea is from [Wanderson-Magalhaes](https://github.com/Wanderson-Magalhaes) and his project [PyDracula](https://github.com/Wanderson-Magalhaes/Modern_GUI_PyDracula_PySide6_or_PyQt6) (MIT License).
The svg files are derived from [Material design icons](https://fonts.google.com/icons) (Apache License Version 2.0). Other files are covered by QuteStyle's MIT license.
## Contributing
All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome.