Skip to main content

Send a notification to a Telegram user or group.

Project description

telegram_notifier_bot - v1.0.0

A simple package to send notifications to a Telegram user or group.

E.g.

  • Send notifications triggered by some event
    • in a monitoring system
    • an IoT device
    • a service

Installation

From PyPI

(venv) $ pip install telegram-notifier-bot
(venv) $

From GitHub

(venv) $ pip install git+https://github.com/p4irin/telegram_notifier_bot.git
(venv) $

Verify

(venv) $ python
Python 3.8.10 (default, Jun  2 2021, 10:49:15) 
[GCC 9.4.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import telegram_notifier_bot
>>> telegram_notifier_bot.__version__
'0.0.1'
>>>

Usage

Prerequisite

Create a new Telegram bot

Send a notification

(venv) $ export TELEGRAM_BOT_TOKEN=<Your Telegram bot token>
(venv) $ export TELEGRAM_CHAT_ID=<Recipient(s) chat or group id>
(venv) $ export TELEGRAM_PATH_TO_PHOTO=<File system path to photo>
(venv) $ python
Python 3.8.10 (default, Jun  2 2021, 10:49:15) 
[GCC 9.4.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import os
>>> from telegram_notifier_bot import Notifier
>>> token = os.getenv('TELEGRAM_BOT_TOKEN')
>>> chat_id = os.getenv('TELEGRAM_CHAT_ID')
>>> photo = os.getenv('TELEGRAM_PATH_TO_PHOTO')
>>> notifier = Notifier(token)
>>> notifier.send("We're out of coffee! Please fix ASAP!", chat_id)
>>> notifier.send_photo(photo, chat_id)
>>>

Reference

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

telegram_notifier_bot-1.0.0.tar.gz (4.6 kB view hashes)

Uploaded Source

Built Distribution

telegram_notifier_bot-1.0.0-py3-none-any.whl (4.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page