send telegram notification using a bot
Project description
telegram-coffee-break
It's time to take a coffee break! your python code is running, and you'll be notified through telegram when you will have your results.
Goal
Create a telegram bot that will send you notifications on your phone to follow your code progress.
Installation
pip install telegram-coffee-break
Preparation
First: You will need to create a new telegram bot as follow:
Go to the BotFather (if you open it in desktop, make sure you have the Telegram app), then create new bot by sending the /newbot command. Follow the steps until you get the username and token for your bot. You can go to your bot by accessing this URL: https://telegram.me/YOUR_BOT_USERNAME and your token should looks like this.
7044NNNNN:AAEtcZ*************
Keep the token safe in a file and set your bot.
Next: You need to find your telegram ID
https://support.bigonechina.com/hc/en-us/articles/360008014894-How-to-get-the-Telegram-user-ID-
Go to the userinfobot and send /start. He will give you your personal ID.
Id: 871NNNNN
First: lol
Last: lolilol
Lang: en
Usage example
Simple example where you simply receive a notification at a certain point in the progress of the code.
from telegrambotalarm import TelegramBot
TOKEN = 'NNNNNNNNNN:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
MYID = 'NNNNNNNNN'
bot = TelegramBot(TOKEN, MYID)
bot.send_message('Your code is running')
... do modeling etc ...
message = {
train accuracy : train_acc,
test accuracy : test_acc
}
bot.send_message(message)
bot.send_image('decision_tree.png', caption=message)
Best example where you are informed if an error occurs during the execution of a piece of code.
def train_model():
## do something ##
results = {
'train accuracy' : train_acc,
'test accuracy' : test_acc
}
return results
from telegrambotalarm import TelegramBot
import traceback
TOKEN = 'nnnnnnnnnn:xxxxxxxxxxxxxxxxxxxxx'
MYID = 'nnnnnnnn'
bot = TelegramBot(TOKEN, MYID)
# Run this
try:
results = train_model()
# If error occurs, send the error with its trace
except Exception as e:
print(traceback.format_exc())
bot.send_error_message(traceback.format_exc())
bot.send_message(results)
bot.send_image('decision_tree.png', caption=message)
Project details
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 telegram-coffee-break-0.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9f9ee534b41f89d27d2ba0eb8d35c10351d2b5d75d268d87193cb08267738d1b |
|
MD5 | 1513117c1d5ba01398c1957f3c4a0268 |
|
BLAKE2b-256 | 6e10d83191612adc177da224f3b18f223ea9e878068c634646b056c75b4ae17f |
Hashes for telegram_coffee_break-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e27944ccd73e3f877f81a9680319fbed9ea3025028b0f619138675d4105dfbb5 |
|
MD5 | f417de99fafdb23f10db4c9088f9a7b5 |
|
BLAKE2b-256 | 3873560600a639aaccb9b0f4ffd3cf5523b760371f9d4c93ac21214f709dd37e |