DatGuy1 / Windows-Toasts

Python library used to send toast notifications on Windows machines
Apache License 2.0
106 stars 6 forks source link

Windows-Toasts


PyPI version readthedocs.io Supported Python versions Downloads codecov Code Style: Black

Windows-Toasts is a Python library used to send toast notifications on Windows machines. Check out the documentation.

Installation

Windows-Toasts supports Windows 10 and 11. While toast notifications do work on Windows 8.1 and below, Microsoft added features in Windows 10 that were never backported.

Windows-Toasts is available through PyPI:

$ python -m pip install windows-toasts

Usage

Simple usage:

>>> from windows_toasts import Toast, WindowsToaster
>>> toaster = WindowsToaster('Python')
>>> newToast = Toast()
>>> newToast.text_fields = ['Hello, world!']
>>> newToast.on_activated = lambda _: print('Toast clicked!')
>>> toaster.show_toast(newToast)

Full documentation is available at readthedocs.io

But I already saw this package three times on PyPI!

I created this library since the other Windows toast notification libraries were all but abandoned, lacked features, and were using pywin32 bindings.

Using WinRT may come with its own limitations. However, the only issue I've encountered compared to using pywin32 bindings is not being able to select the duration in seconds, but rather as short/long.

Credits

The code is adapted from mohabouje's wonderful C++ WinToasts library

Big thanks to dlech for his recently created winrt fork