Metadata-Version: 2.1
Name: winsdk-toast
Version: 0.1.0
Summary: A simple package for displaying Windows Toast Notification based on winsdk.
Home-page: https://github.com/Mo-Dabao/winsdk_toast
Author: modabao
Author-email: mo_dabao@qq.com
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.5
Description-Content-Type: text/markdown
License-File: LICENSE

# winsdk_toast

A simple package for displaying Windows Toast Notification based on [winsdk].

Sometimes, after starting my data processing python script, I may surf the Internet.
It chokes my happiness that to frequently check whether the script stops,
or suddenly realize the script has stopped for a long while.

It'll be reassuring that the script can stop with a friendly gesture.

## Features

winsdk_toast can pop up Windows Toast Notifications that contain

- [x] Text
- [x] Image
- [x] Input
  - [x] Text
  - [x] Selection
- [x] Audio
  - [x] Buit-in
  - [ ] Custom
- [x] Progress
  - [x] Still
  - [ ] Live
- [x] Group
- [x] Event

## Minimal Example

```python
from winsdk_toast import Notifier, Toast


notifier = Notifier('程序名 applicationId')
toast = Toast()
toast.add_text('第一行 1st line')
notifier.show(toast)
```

![minimal.gif](https://github.com/Mo-Dabao/winsdk_toast/blob/main/docs/source/Examples/pics/minimal.gif?raw=true)

More examples and documents are on the way.


[winsdk]: https://pypi.org/project/winsdk
