https://github.com/enmanuelmag/notify_function
Library to show a pop-up native notification when your function has finished
https://github.com/enmanuelmag/notify_function
discord email-sender notifications python3 telegram-bot toast
Last synced: 9 months ago
JSON representation
Library to show a pop-up native notification when your function has finished
- Host: GitHub
- URL: https://github.com/enmanuelmag/notify_function
- Owner: enmanuelmag
- License: mit
- Created: 2020-05-17T17:55:28.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-07-13T08:50:07.000Z (over 3 years ago)
- Last Synced: 2025-03-05T08:16:20.903Z (10 months ago)
- Topics: discord, email-sender, notifications, python3, telegram-bot, toast
- Language: Python
- Homepage: https://pypi.org/project/notify-function/#description
- Size: 104 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Notifier Function Status
This library uses a decorator to show a toast in your screen or send you a email, telegram message or message to discord channel or use a Telegram bot to send you a message when your function has finished.
## Usage
There are to methods to use this library:
### Decorator
All that you need to do is use a decorator and some specific parameters, like in the following example:
```python
from notifier import notify
@notify(email='enmanuelmag@cardor.dev')
def your_function():
print('Hello World!')
```
#### Parameters
- **title**: the title of toast notification, by defult is: `Function finished`.
- **email**: the email of user, by defult is: `None`.
- **api_token**: the api token of your Telegram bot, by defult is: `None`. You could use [BotFather](https://t.me/botfather) to create a personal bot.
- **chat_id**: the chat id to send the message, by defult is: `None`. If you account is public you could use your username (@username), otherwise you could use the chat id, you'll find [here](https://t.me/username_to_id_bot).
- **webhook_url**: the url of webhook to send message to discord channel, by defult is: `None`.
- **msg**: the message of toast notification, by default is: `Your function has finished`.
- **duration**: the time, in seconds, that the nottications will show, by default is `8`.
- **urgency**: the urgency of the notifcation. By defualt is `normal`. The options are:
- low.
- normal.
- critical.
### Class (manual call)
In this case you need to create a class and call the instance returned by the constructor, like in the following example:
```python
from notifier import Notifier
notifier = Notifier()
notifier()
```
#### Parameters
This parameters are avaible in the class constructor and when you call the instance returned by the constructor.
- **title**: the title of notification, by defult is: `Manual notify`.
- **msg**: the message of notification, by default is: `Check your code`.
- **email**: the email of user, by defult is: `None`.
- **api_token**: the api token of your Telegram bot, by default is: `None`. You could use [BotFather](https://t.me/botfather) to create a personal bot.
- **chat_id**: the chat id to send the message, by defult is: `None`. If you account is public you could use your username (@username), otherwise you could use the chat id, you'll find [here](https://t.me/username_to_id_bot).
- **webhook_url**: the url of webhook to send message to discord channel, by defult is: `None`.
Made with ❤️ by [Enmanuel Magallanes](https://cardor.dev)