Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/5yutan5/pyqtdarktheme
A flat dark theme for PySide and PyQt.
https://github.com/5yutan5/pyqtdarktheme
dark-theme darktheme pyqt pyqt5 pyqt6 pyside pyside2 pyside6 python qdarkstyle qt style stylesheet theme
Last synced: 6 days ago
JSON representation
A flat dark theme for PySide and PyQt.
- Host: GitHub
- URL: https://github.com/5yutan5/pyqtdarktheme
- Owner: 5yutan5
- License: mit
- Created: 2021-08-06T19:48:01.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-23T20:56:38.000Z (29 days ago)
- Last Synced: 2025-01-09T11:02:53.277Z (13 days ago)
- Topics: dark-theme, darktheme, pyqt, pyqt5, pyqt6, pyside, pyside2, pyside6, python, qdarkstyle, qt, style, stylesheet, theme
- Language: Python
- Homepage: https://pyqtdarktheme.readthedocs.io
- Size: 113 MB
- Stars: 590
- Watchers: 9
- Forks: 91
- Open Issues: 40
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# PyQtDarkTheme
PyQtDarkTheme applies a flat dark theme to QtWidgets application. There's a light theme too. Color balanced from the dark theme for easy viewing in daylight.
Check out the [complete documentation](https://pyqtdarktheme.readthedocs.io).
**Project status**
[](https://pypi.org/project/pyqtdarktheme/)
[](https://www.python.org/downloads/)
[](https://www.qt.io/qt-for-python)
[](https://github.com/5yutan5/PyQtDarkTheme/blob/main/LICENSE.txt/)
**Tests**
[](https://results.pre-commit.ci/latest/github/5yutan5/PyQtDarkTheme/main)
[](https://codecov.io/gh/5yutan5/PyQtDarkTheme)
[](https://pyqtdarktheme.readthedocs.io/en/latest/?badge=latest)
## Features
- A flat dark and light theme
- Support PySide and PyQt
- Sync with OS's theme and accent (Mac, Windows, Linux)
- Resolve the style differences between Qt versions
- Provide dark/light theme QPalette
- Override Qt old standard icons
## Themes
### Dark Theme
### Light Theme
## Requirements
- [Python 3.7+](https://www.python.org/downloads/)
- Qt 5.15+
- PySide6, PyQt6, PyQt5 or PySide2
## Installation Method
- Last released version
```plaintext
pip install pyqtdarktheme
```
- Latest development version
```plaintext
pip install git+https://github.com/5yutan5/PyQtDarkTheme.git@main
```
## Usage
```Python
import sys
from PySide6.QtWidgets import QApplication, QMainWindow, QPushButton
import qdarktheme
app = QApplication(sys.argv)
# Apply the complete dark theme to your Qt App.
qdarktheme.setup_theme()
main_win = QMainWindow()
push_button = QPushButton("PyQtDarkTheme!!")
main_win.setCentralWidget(push_button)
main_win.show()
app.exec()
```
Further information can be found in our docs:
- [Usage Guide](https://pyqtdarktheme.readthedocs.io/en/latest/how_to_use.html)
### Enable HiDPI
```Python
# enable_hi_dpi() must be called before the instantiation of QApplication.
qdarktheme.enable_hi_dpi()
app = QApplication(sys.argv)
qdarktheme.setup_theme()
```
For Qt6 bindings, HiDPI “just works” without using this function.
### Light theme
```Python
qdarktheme.setup_theme("light")
```
### Sync with OS's theme and accent
```Python
qdarktheme.setup_theme("auto")
```
On macOS, qdarktheme also syncs with accent colors.
### Customizing colors
You can customize the theme color.
```python
# Customize accent color.
qdarktheme.setup_theme(custom_colors={"primary": "#D0BCFF"})
```
For a list of all customizable colors, see the Theme Color Reference:
- [Theme Color](https://pyqtdarktheme.readthedocs.io/en/latest/reference/theme_color.html)
### Sharp frame
You can change the corner style.
```python
# Default is "rounded".
stylesheet = qdarktheme.setup_theme(corner_shape="sharp")
```
### QPalette and stylesheet
You can also only load QPalette and stylesheet. `qdarktheme.setup_theme` uses the following functions internally.
```Python
palette = qdarktheme.load_palette(theme="dark")
stylesheet = qdarktheme.load_stylesheet(theme="dark")
```
## Example
To check all Qt widgets, run:
```plaintext
python -m qdarktheme.widget_gallery
```
## License
The svg files for the PyQtDarkTheme are derived [Material design icons](https://fonts.google.com/icons)(Apache License Version 2.0). Qt stylesheets are originally fork of [QDarkStyleSheet](https://github.com/ColinDuquesnoy/QDarkStyleSheet)(MIT License). Other files are covered by PyQtDarkTheme's MIT license. The accent detector(qdarktheme/_os_appearance/_accent/_mac_detect) is inspired by [darkdetect](https://github.com/albertosottile/darkdetect)(3-clause BSD License).
## Contributing
All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. You can get started by reading this:
- [Contributing Guide](https://pyqtdarktheme.readthedocs.io/en/latest/contributing.html)
## Change log
See [Releases](https://github.com/5yutan5/PyQtDarkTheme/releases).