https://github.com/j-city/tinywintoast
Tiny library to show windows toast
https://github.com/j-city/tinywintoast
Last synced: 4 months ago
JSON representation
Tiny library to show windows toast
- Host: GitHub
- URL: https://github.com/j-city/tinywintoast
- Owner: J-CITY
- License: mit
- Created: 2019-07-18T11:56:52.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-02-28T10:06:25.000Z (5 months ago)
- Last Synced: 2025-03-18T18:57:37.670Z (4 months ago)
- Language: Python
- Size: 1.2 MB
- Stars: 25
- Watchers: 2
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TinyWinToast
:email: Tiny library to show windows toast
# Description
I want use notification in my console player, but I want more powerful toast then in [win10toast](https://github.com/jithurjacob/Windows-10-Toast-Notifications "win10toast"),
so I write this lib.
# Installation
pip install tinyWinToast
# Examples:
See source code to get more information
Simple start:
To create simple toast:
```python
getToast("Title", "Message", 'icon.jpg', crop="circle", duration="short", appId="MyApp", isMute=True).show()
```
Or you can create toast object
New# Button and Inputs callback (WIP)
TODO: Need way run PS1 script and not close the process
```python
# Load PoshWinRT.dll for catch events from toasts
# Init supporn get info from toast actions (if param is True)
# Init PowerShell process
ToastInit(True)
toast = Toast()
# Set that if want get information from toast acction
toast.config.USE_ACTIONS_CALLBACK = True
toast.setTitle("TITLE", maxLines=1)
toast.setMessage("MESSAGE", maxLines=1)
toast.addButton(
Button(content="Button", activationType=ACTION_TYPE_BACKGROUND,
arguments="Button", pendingUpdate=False))
toast.addInput(Input(inputId="Text", intype=INPUT_TEXT, placeHolderContent="Input text..."))
toast.addInput(Input(inputId="Select", intype=INPUT_SELECTION, selections = [("1","Yes"), ("2","No"), ("3","Maybe")], defaultInput="1"))
toast.show()
time.sleep(9)
# Get toasts actions as string list
print(toast.getEventListenerOutput())
# Deinit all
ToastDeinit()
```
0# Simple toast
```python
ToastInit(False)
toast = Toast()
toast.setTitle("TITLE", maxLines=2)
toast.setMessage("MESSAGE", maxLines=2)
toast.setIcon('image.png', crop=CROP_NONE)
toast.show()
ToastDeinit()
```
1# More text and circle crop
```python
ToastInit(False)
toast = Toast()
toast.setTitle("TITLE", maxLines=1)
toast.setMessage("MESSAGE", maxLines=1)
toast.addText("MORE TEXT", maxLines=1)
toast.setIcon('image.png', crop=CROP_CIRCLE)
toast.show()
ToastDeinit()
```
2# Add hero image
```python
ToastInit(False)
toast = Toast()
toast.setTitle("TITLE", maxLines=1)
toast.setMessage("MESSAGE", maxLines=1)
toast.addText("MORE TEXT", maxLines=1)
toast.setIcon('icon.jpg', crop=CROP_CIRCLE)
toast.setHeroImage("heroimage.jpg")
toast.show()
ToastDeinit()
```
3# Add image
```python
ToastInit(False)
toast = Toast()
toast.setTitle("TITLE", maxLines=1)
toast.setMessage("MESSAGE", maxLines=1)
toast.addText("MORE TEXT", maxLines=1)
toast.setIcon('icon.jpg', crop=CROP_CIRCLE)
toast.setImage("image.jpg")
toast.show()
ToastDeinit()
```
4# More images
```python
ToastInit(False)
toast = Toast()
toast.setTitle("TITLE", maxLines=1)
toast.setMessage("MESSAGE", maxLines=1)
toast.addText("MORE TEXT", maxLines=1)
toast.setIcon('image.jpg', crop=CROP_CIRCLE)
toast.addImage("image.jpg")
toast.addImage("image.jpg")
toast.addImage("image.jpg")
toast.addImage("image.jpg")
toast.show()
ToastDeinit()
```
5# Text attribute
```python
ToastInit(False)
toast = Toast()
toast.setTitle("TITLE", maxLines=1)
toast.setMessage("MESSAGE", maxLines=1)
toast.addText("from email", placement="attribution", maxLines=1)
toast.setIcon('icon.jpg', crop=CROP_CIRCLE)
toast.show()
ToastDeinit()
```
6# Toast time
```python
ToastInit(False)
toast = Toast()
toast.setTitle("TITLE", maxLines=1)
toast.setMessage("MESSAGE", maxLines=1)
toast.setTime("2019-07-13T18:49:37.00Z")
toast.setIcon('icon.jpg', crop=CROP_CIRCLE)
toast.show()
ToastDeinit()
```
7# Add group text
```python
ToastInit(False)
toast = Toast()
toast.setTitle("TITLE", maxLines=1)
toast.setMessage("MESSAGE", maxLines=1)
toast.addGroupText("Message", maxLines=1, style=TEXT_STYLE_BASE, align=TEXT_ALIGN_LEFT)
toast.addGroupText("Message", maxLines=1, style=TEXT_STYLE_CAPTION_SUBTLE, align=TEXT_ALIGN_LEFT)
toast.addGroupText("Message", maxLines=1, style=TEXT_STYLE_BASE, align=TEXT_ALIGN_RIGHT)
toast.setIcon('icon.jpg', crop=CROP_CIRCLE)
toast.show()
ToastDeinit()
```
8# Toast progress
```python
ToastInit(False)
toast = Toast()
toast.setTitle("TITLE", maxLines=1)
toast.setMessage("MESSAGE", maxLines=1)
toast.addProgress(Progress(title="Title", value="0.6", valueStringOverride="15/20", status="Save..."))
toast.setIcon('icon.jpg', crop=CROP_CIRCLE)
toast.show()
ToastDeinit()
```
Update toast data
```puthon
ToastInit(False)
toast = Toast()
toast.setTitle("TITLE", maxLines=1)
toast.setMessage("MESSAGE", maxLines=1)
toast.setTag("mytag")
toast.setGroup("mygroup")
toast.setProgress(Progress(title="Title", value="0.2", valueStringOverride="15/20", status="Save..."))
toast.setIcon('icon.jpg', crop=CROP_NONE)
toast.show()
time.sleep(6)
toast.setProgress(Progress(title="Title", value="0.9", valueStringOverride="19/20", status="Save..."))
d = {'progressValue': "0.9", 'progressValueString': "19/20"}
#toast.show() # if you wand update all toast
toast.update(200, d)
ToastDeinit()
```
9# Buttons and inputs
```python
ToastInit(False)
toast = Toast()
toast.setTitle("TITLE", maxLines=1)
toast.setMessage("MESSAGE", maxLines=1)
toast.addInput(Input(inputId="111", intype=INPUT_TEXT, placeHolderContent="Input text..."))
toast.addInput(Input(inputId="112", intype=INPUT_SELECTION, selections = [("1","Yes"), ("2","No"), ("3","Maybe")], defaultInput="1"))
toast.addButton(Button(content="Play", activationType=ACTION_TYPE_BACKGROUND, arguments="dismiss", pendingUpdate=False))
toast.addButton(Button(content="Pause", activationType=ACTION_TYPE_BACKGROUND, arguments="http://www.google.com", pendingUpdate=False))
toast.setIcon('icon.jpg', crop=CROP_CIRCLE)
toast.show()
ToastDeinit()
```
Also, you can load toast from script, or xml
```python
ToastInit(False)
toast.showFromXml("APP_ID", "XML_STRING")
toast.startFromScript(path_to_script.ps1)
toast.updateFromScript(path_to_script.ps1)
ToastDeinit()
```
Also you can creage Config() and set some params
```python
ToastInit(False)
config = Config()
config.APP_ID = "myApp"
config.DURATION = DURATION_LONG
...
toast = Toast(config)
ToastDeinit()
```
or
```python
ToastInit(False)
config = Config()
config.APP_ID = "myApp"
config.DURATION = DURATION_LONG
...
toast = Toast()
toast.setConfig(config)
ToastDeinit()
```