Notify you when a function finished with option to send a email, telegram message or message to discord channel
Project description
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:
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 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. - 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:
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 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. - webhook_url: the url of webhook to send message to discord channel, by defult is:
None
.
Made with ❤️ by Enmanuel Magallanes
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for notify_function-1.5.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 577cb9b82852dabc3659533de54a35b07e1fd55cc76ae3d67d5129b6a7b4243a |
|
MD5 | c6df6ffd54b3cd5f708c9b132412b3b0 |
|
BLAKE2b-256 | 2c85ae0f66ef0b24b8c832132655bf7a7050bd142b862ad72f53dca07f322e86 |