PySide6-DAW

Desktop Application Widget (DAW) for PySide6. PySide6-DAW is designed as Python package and provides additional widgets, especially for desktop applications. The aim of PySide6-DAW is to simplify and speedup the desktop application development with PySide6, without losing any functionality.

Installation

To install the PySide6-DAW Python package, execute the following command on your terminal:

pip install git+https://github.com/maerkl24/PySide6-DAW.git

Usage

The provided widgets are based on PySide6.QtWidgets.QWidget and thus can be treated as any other widget. The following code snippet demonstrates to usage of PySide6-DAW in a simple manner.

import sys
from PySide6.QtGui import QPixmap
from PySide6.QtWidgets import QApplication, QMainWindow, QWidget
from PySide6_DAW.Widgets import DesktopApplication, SideBarButton

class MainWindow(QMainWindow):
    def __init__(self) -> None:
        super().__init__(parent=None)

        # Create desktop application widget
        desktop_app = DesktopApplication(self)

        # Add a page to the desktop application widget
        icon_1 = QPixmap("my_icon.png")
        bttn_1 = SideBarButton(icon_1, "Button 1")
        page_1 = QWidget()
        desktop_app.addPage(bttn_1, SideBarButton.Alignment.TOP, page_1)

        self.setCentralWidget(desktop_app)

if __name__ == "__main__":
    app = QApplication(sys.argv)
    window = MainWindow()
    window.show()
    sys.exit(app.exec())

There is also a more detailed example here.

Development and Contribution

You would like to develop and contribute to this project? Then this chapter is what you were looking for.

PDM

This project uses PDM as Python package and dependency manager. In order to develop on this project, it is recommended to install PDM. For more information, see: https://pdm.fming.dev/latest/#installation

Install Development Tools

To install the PySide6-DAW Python package with its dependencies and all development tools, execute the following command on your terminal:

pdm install --dev

Execute Development Tools

To execute the development tools, run the following commands on your terminal:

pdm run isort PySide6_DAW
pdm run black PySide6_DAW
pdm run pylint PySide6_DAW
pdm run mypy PySide6_DAW

TODOs

• Fix example workflow (How to check GUI app without desktop?)
• Evaluate making DesktopApplication inheriting from MainWindow
• Setup contribution rules and workflow check
• Setup PyPi deployment