Metadata-Version: 2.1
Name: notify-function
Version: 1.0.4
Summary: Notify you when a function finished with option to send a email
Home-page: https://github.com/enmanuel-mag/notify_function
Author: Enmanuel Magallanes Pinargote
Author-email: enmanuelmag@cardor.dev
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: py-notifier

# Notifier Function Status
This library use a decorator to show a toast in your screen.

## Requeriments

Please install this packages by yourself depending you OS:

- Windows: ```pip3 install win10toast```
- Ubuntu: ```apt-get install libnotify-bin``` (if don't work try searching how install notify-send for your distro of Linux)

## Usage

All that you need is use a decorator and specific some parameters, next explain it:

Import: `import notify`

Decorator to use: `@notify()`

### Parameters

- **title**: the title of toast notification, by defult is: Function finished.
- **email**: the email of user, 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.
  - critial.

Made with ❤️ by [Enmanuel Magallanes](https://cardor.dev)


