https://github.com/albertosottile/darkdetect
Detect OS Dark Mode from Python
https://github.com/albertosottile/darkdetect
dark dark-mode dark-syntax-theme dark-theme darkmode pyqt5 pyqt6 pyside2 pyside6 qt tkinter ubuntu windows-10
Last synced: about 2 months ago
JSON representation
Detect OS Dark Mode from Python
- Host: GitHub
- URL: https://github.com/albertosottile/darkdetect
- Owner: albertosottile
- License: other
- Created: 2019-05-13T18:45:50.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-11T06:48:12.000Z (about 1 year ago)
- Last Synced: 2025-04-04T01:11:08.427Z (2 months ago)
- Topics: dark, dark-mode, dark-syntax-theme, dark-theme, darkmode, pyqt5, pyqt6, pyside2, pyside6, qt, tkinter, ubuntu, windows-10
- Language: Python
- Homepage:
- Size: 33.2 KB
- Stars: 196
- Watchers: 8
- Forks: 19
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Darkdetect
This package allows to detect if the user is using Dark Mode on:
- [macOS 10.14+](https://support.apple.com/en-us/HT208976)
- [Windows 10 1607+](https://blogs.windows.com/windowsexperience/2016/08/08/windows-10-tip-personalize-your-pc-by-enabling-the-dark-theme/)
- Linux with [a dark GTK theme](https://www.gnome-look.org/browse/cat/135/ord/rating/?tag=dark).
The main application of this package is to detect the Dark mode from your GUI Python application (Tkinter/wx/pyqt/qt for python (pyside)/...) and apply the needed adjustments to your interface. Darkdetect is particularly useful if your GUI library **does not** provide a public API for this detection (I am looking at you, Qt). In addition, this package does not depend on other modules or packages that are not already included in standard Python distributions.
## Usage
```
import darkdetect
>>> darkdetect.theme()
'Dark'
>>> darkdetect.isDark()
True
>>> darkdetect.isLight()
False
```
It's that easy.
You can create a dark mode switch listener daemon thread with `darkdetect.listener` and pass a callback function. The function will be called with string "Dark" or "Light" when the OS switches the dark mode setting.
``` python
import threading
import darkdetect
# def listener(callback: typing.Callable[[str], None]) -> None: ...
t = threading.Thread(target=darkdetect.listener, args=(print,))
t.daemon = True
t.start()
```
## Install
The preferred channel is PyPI:
```
pip install darkdetect
```
Alternatively, you are free to vendor directly a copy of Darkdetect in your app. Further information on vendoring can be found [here](https://medium.com/underdog-io-engineering/vendoring-python-dependencies-with-pip-b9eb6078b9c0).
## Optional Installs
To enable the macOS listener, additional components are required, these can be installed via:
```bash
pip install darkdetect[macos-listener]
```
## Notes
- This software is licensed under the terms of the 3-clause BSD License.
- This package can be installed on any operative system, but it will always return `None` unless executed on a OS that supports Dark Mode, including older versions of macOS and Windows.
- On macOS, detection of the dark menu bar and dock option (available from macOS 10.10) is not supported.
- [Details](https://stackoverflow.com/questions/25207077/how-to-detect-if-os-x-is-in-dark-mode) on the detection method used on macOS.
- [Details](https://askubuntu.com/questions/1261366/detecting-dark-mode#comment2132694_1261366) on the experimental detection method used on Linux.