Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rexdivakar/Notifly
Notifly is an AI Model tracking system designed to monitor the metrics and hardware resources during training the model in real-time alerts over various social networks like Telegram, discord, slack.
https://github.com/rexdivakar/Notifly
notification-service telegram-bot telegram-client telegram-notifications
Last synced: 9 days ago
JSON representation
Notifly is an AI Model tracking system designed to monitor the metrics and hardware resources during training the model in real-time alerts over various social networks like Telegram, discord, slack.
- Host: GitHub
- URL: https://github.com/rexdivakar/Notifly
- Owner: rexdivakar
- License: mit
- Created: 2020-10-17T03:57:54.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-24T09:59:17.000Z (19 days ago)
- Last Synced: 2024-11-29T08:46:17.210Z (14 days ago)
- Topics: notification-service, telegram-bot, telegram-client, telegram-notifications
- Language: Python
- Homepage: https://pypi.org/project/notifly/
- Size: 8.82 MB
- Stars: 36
- Watchers: 5
- Forks: 12
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.txt
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - rexdivakar/Notifly - Notifly is an AI Model tracking system designed to monitor the metrics and hardware resources during training the model in real-time alerts over various social networks like Telegram, discord, slack. (Python)
README
# Notifly
### [Code Usage](https://rexdivakar.github.io/Notifly/)
## Table of Contents
* [About the package](#about-the-package)
* [Built With](#built-with)
* [Prerequisites for install](#prerequisites)
* [Install the package](#install-the-package)
* [Working of the tool](#working-of-the-tool)
* [Telegram](#telegram)
* [Discord](#discord)
* [Slack](#slack)
* [Contributing](#contributing)
## About the package
Simple Bots to push notifications during an event trigger.
[](https://telegram.org/)
wrapper to send messages, images, files over the bot using API.
[](https://discord.com/)
wrapper to send message, images, files to the channel using Webhooks.
[](https://slack.com)
wrapper to send message, images, files to the channel using API.
### Built With
* [Python 3][1]
## Prerequisites
* Python
It is preinstalled in Ubuntu 20.04. To check the version use command :
```
python3 --version
```
If it is not preinstalled for some reason, proceed [here][4] and download as per requirement.
Run the following command in terminal to download the required packags for running the tool locally :
* Using requirements file :
```
pip3 install -r requirements.txt
```
* Directly download packages:
```
pip3 install requests==2.24.0
pip3 install matplotlib==3.2.2
pip3 install slackclient==2.9.3
```
## Install the package
Run the following terminal commands to install the package on the given distros.
* Termux :
```
pkg install python3
```
```
pip3 install notifly
```
* Ubuntu/Debian
```
sudo apt install python3-pip
```
```
pip3 install notifly
```
* Arch
```
sudo pacman -S python3-pip
```
```
pip3 install notifly
```
***This may take a while depending on the network speed.***
## Working of the tool
### Telegram
To see how the tool works,
1. Create the [telegram bot][2].
2. Getting the bot API token
1. Search and go to ```_@Botfather_``` .
1. Message ```/mybots``` .
1. Select the bot.
1. Select the _API token_ displayed in message.
1. Copy and use in sample code.
```python
from notifly import telegram #import the package
x = telegram.Notifier('bot API token') #create object of class Notifier
x.send_message('message') #send message
x.send_image("image address") #send image(.jpg or .png format)
x.send_file("file address") #send document
x.session_dump() #creates folder named 'downloads' in local folder, downloads/saves message,chat details for current session in 'sessio_dump.json' file
```
3. Run sample code.
### Discord
To see how the tool works,
1. Create server.
2. Create and copy server [webhook][5] and use in sample code.
```python
from notifly import discord
x = discord.Notifier(r'webhook') #create object of class Notifier
x.send_message('message') #send message
x.send_file("file address") #send file
x.send_file("image address") #send image
```
3. Run sample code.
### Slack
To see how the tool works,
1. Create app. Follow these steps,
1. Go [here][6].
2. Go to ```Create an App``` .
3. Enter _App Name_ and select workspace. Click ```Create App```.
4. Under **Add features and functionality** select ```Incoming Webhooks``` and **Activate Incoming Webhooks**.
5. Scroll down, select ```Add New Webhook to Workspace``` and select a channel from the drop down.This channel name is used as an argument in the sample code. Click ```Allow```.
6. Select **OAuth & Permissions** from left-sidebar.
7. Under **Scopes** > **Bot Token Scopes** click ```Add an OAuth Scope``` and add the following scopes,
```chat:write``` ```chat:write.public``` ```files:write``` ```users:write```
8. Scroll up, under **OAuth Tokens for Your Team** copy the *Bot User OAuth Access Token* to use in sample code.
9. Click ```Reinstall to Workspace```, select channel and click ```Allow```.
2. Write sample code.
```python
from notifly import slack
x= slack.Notifier('token', channel='channel-name') #create object of class Notiflier
x.send_message('message') #send message
x.send_file("image or file address") #send image/file
```
3. Run sample code.
### Tensorflow Integration
Plug and play feature for your tensorflow callbacks
```python
# create your notifier using above methods
from notifly import discord
notifier = discord.Notifier(r'webhook')
class MyNotifierCallback:
@notifier.notify_on_epoch_begin(epoch_interval=1, graph_interval=1, hardware_stats_interval=1)
def on_epoch_begin(self, epoch, logs=None):
pass
@notifier.notify_on_epoch_end(epoch_interval=1, graph_interval=1, hardware_stats_interval=1)
def on_epoch_end(self, epoch, logs=None):
pass
@notifier.notify_on_train_begin()
def on_train_begin(self, logs=None):
pass
@notifier.notify_on_train_end()
def on_train_end(self, logs=None):
pass
model.fit(callbacks=[MyNotifierCallback()])
```
## Learn more about Notifly ✨
Read the [wiki pages](https://github.com/rexdivakar/Notifly/wiki) which has all the above steps in great detail with some examples as well 🤩🎉.
## Contributing
1. Fork the Project
1. Create your Feature Branch
>git checkout -b feature/mybranch
1. Commit your Changes
>git commit -m 'Add something'
1. Push to the Branch
>git push origin feature/mybranch
1. Open a Pull Request
Follow the given commands or use the amazing ***GitHub GUI***
**Happy Contributing**
[contributors-shield]: https://img.shields.io/github/contributors/rexdivakar/Telegram-Notifly.svg?style=flat-square
[contributors-url]: https://github.com/rexdivakar/Telegram-Notifly/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/rexdivakar/Telegram-Notifly.svg?style=flat-square
[forks-url]: https://github.com/rexdivakar/Telegram-Notifly/network/members
[stars-shield]: https://img.shields.io/github/stars/rexdivakar/Telegram-Notifly.svg?style=flat-square
[stars-url]: https://github.com/rexdivakar/Telegram-Notifly/stargazers
[issues-shield]: https://img.shields.io/github/issues/rexdivakar/Telegram-Notifly.svg?style=flat-square
[issues-url]: https://github.com/rexdivakar/Telegram-Notifly/issues
[license-shield]: https://img.shields.io/github/license/rexdivakar/Telegram-Notifly.svg?style=flat-square
[license-url]: https://github.com/rexdivakar/Telegram-Notifly/blob/master/LICENSE.txt
[1]:https://www.python.org/
[2]:https://telegram.org/blog/bot-revolution
[4]:https://www.python.org/downloads/
[5]:https://discordjs.guide/popular-topics/webhooks.html#fetching-all-webhooks-of-a-guild
[6]:https://api.slack.com/