https://github.com/jss95/dawiq
Python package to build Qt Widget from Dataclass
https://github.com/jss95/dawiq
dataclasses python qt
Last synced: 25 days ago
JSON representation
Python package to build Qt Widget from Dataclass
- Host: GitHub
- URL: https://github.com/jss95/dawiq
- Owner: JSS95
- License: mit
- Created: 2022-07-20T03:00:55.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-09-26T06:46:32.000Z (about 2 years ago)
- Last Synced: 2025-01-31T03:26:49.064Z (10 months ago)
- Topics: dataclasses, python, qt
- Language: Python
- Homepage: https://dawiq.readthedocs.io/
- Size: 390 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DaWiQ - Dataclass Widget with Qt
[](https://badge.fury.io/py/DaWiQ)
[](https://pypi.org/project/dawiq/)
[](https://github.com/JSS95/dawiq/actions/workflows/ci.yml)
[](https://dawiq.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/JSS95/dawiq/blob/master/LICENSE)
DaWiQ is a Python package to generate Qt widget from dataclass.
It provides:
- Dynamic construction of widget from dataclass
- Customizing widget for user-defined type
- Delegate and mapper for dataclass widget
The following Qt bindings are supported:
- [PySide6](https://pypi.org/project/PySide6/)
- [PySide2](https://pypi.org/project/PySide2/)
- [PyQt6](https://pypi.org/project/PyQt6/)
- [PyQt5](https://pypi.org/project/PyQt5/)
# Usage
Here is a simple dataclass:
```python
from dataclasses import dataclass
@dataclass
class DataClass:
x: int
y: bool
```
DaWiQ can build a widget from this dataclass. For PySide6 example,
```python
from PySide6.QtWidgets import QApplication
from dawiq import dataclass2Widget
import sys
app = QApplication(sys.argv)
dataWidget = dataclass2Widget(DataClass)
dataWidget.show()
app.exec()
app.quit()
```
This widget can be mapped to item model for storing the data.
More examples are provided in the documentation.
# Installation
DaWiQ can be installed from `PyPI`.
```
$ pip install dawiq
```
To install from GitHub source, clone the repository with `git` and install with `pip`.
```
$ git clone https://github.com/JSS95/dawiq.git
$ cd dawiq
$ pip install .
```
DaWiQ does not specify the Qt binding requirement, therefore you must manually install one.
# Documentation
DaWiQ is documented with [Sphinx](https://pypi.org/project/Sphinx/). Documentation can be found on Read the Docs:
> https://dawiq.readthedocs.io/
If you want to build the document yourself, get the source code and install with `[doc]` option.
Then go to `doc` directory and build the document.
```
$ pip install .[doc]
$ cd doc
$ make html
```
Document will be generated in `build/html` directory. Open `index.html` to see the central page.