winaccent 1.0.1

A simple and lightweight Python module for getting Windows' accent color or a shade of it. Works on both Windows 10 and 11 and doesn't require additional dependencies.

winaccent

A simple and lightweight Python module for getting Windows' accent color or a shade of it. Works on both Windows 10 and 11 and doesn't require additional dependencies.

📦 Installation

Run this command in your terminal:

pip install winaccent

To update the module, run this command:

pip install --upgrade winaccent

📜 Documentation

[!IMPORTANT] This is a Windows-only module. Trying to import this module on a OS other than Windows or a Windows version older than 10 will raise a winaccent.UnsupportedPlatformException exception. When using this module in cross-platform applications, you should only import and use winaccent on Windows systems to avoid errors. Here's an example:

import sys

if sys.platform == "win32": 
    # The program is running on Windows

    import winaccent
    print(winaccent.accent_light_mode)

---

Get a specific accent color

[!NOTE] The color values and previews shown here are for Windows 11's default accent color (blue). If you have a different accent color, you'll get the color values based on your accent color.

For simplicity, you can get a specific accent color from one of the following variables:

Variable	Color	Preview
accent_dark_mode	#4CC2FF
accent_normal	#0078D4
accent_light_mode	#0067C0

If you need a different shade, you can get it from one of these variables:

Variable	Color	Preview
accent_light_3	#99EBFF
accent_light_2	#4CC2FF
accent_light_1	#0091F8
accent_normal	#0078D4
accent_dark_1	#0067C0
accent_dark_2	#003E92
accent_dark_3	#001A68

[!TIP] accent_dark_mode is the same thing as accent_light which is the same thing as accent_light_2.

Also, accent_light_mode is the same thing as accent_dark which is the same thing as accent_dark_1.

Example:

import winaccent

print(winaccent.accent_light_mode) # Prints the light mode accent color

You may want to take a look at Microsoft's accent color guidelines. You can do that here.

---

Update accent color values

The accent colors can be updated manually using the update_accent_colors() function. This function will retrieve the values again.

---

Accent color change listener

This module allows you to add a listener that will call a specific function when the accent color changes. Here's how you can add it:

import winaccent, threading

# Replace `callback` with the function that you want to be called
thread = threading.Thread(target = lambda: winaccent.on_accent_changed_listener(callback), daemon = True)
thread.start()

[!NOTE] If you added the listener, there's no need to call update_accent_colors() because it will be called automatically every time the accent color changes.

Here's a demo:

https://github.com/user-attachments/assets/8e5bdec8-d7d7-40a3-b8d0-a9782ecbd0fb

💻 Demo

To see a demo, run the following command in your terminal (winaccent must be installed):

python -m winaccent

This command has an optional --mode argument. It can take the following values:

Value	Info
gui	Shows a GUI demo. The GUI demo responds to accent color changes.
console	Shows a console demo. The console demo does not respond to accent color changes.
auto	If tkinter is installed and works correctly, a GUI demo will be shown. If that's not the case, a console demo will be shown.

Example usage:

python -m winaccent --mode gui

The command will run with --mode set to auto by default.

Here's a GUI demo with 6 different accent colors:

Blue	Dark green	Red
Gold	Iris pastel	Camouflage desert

A console demo looks like this (for default blue accent color):

Accent palette
==============

accent_light_3:    #99EBFF
accent_light_2:    #4CC2FF
accent_light_1:    #0091F8
accent_normal:     #0078D4
accent_dark_1:     #0067C0
accent_dark_2:     #003E92
accent_dark_3:     #001A68

🤩 Feedback

If you found a bug or want to make a suggestion, open a new issue. If you're ready to add a new feature or fix a bug, pull requests are welcome.

If you find this module useful, you can consider starring this repository.

📋 To do

• Add an accent color change listener
• Add color shades
• Do some research about a weird color (see line 42 in winaccent/__init__.py)