https://github.com/licht1stein/telegram-exception-alerts

Decorator that sends exception information and traceback as Telegram message
https://github.com/licht1stein/telegram-exception-alerts

Last synced: 2 months ago
JSON representation

Decorator that sends exception information and traceback as Telegram message

• Host: GitHub
• URL: https://github.com/licht1stein/telegram-exception-alerts
• Owner: licht1stein
• Created: 2020-06-10T12:55:40.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-08-03T11:47:42.000Z (over 1 year ago)
• Last Synced: 2024-08-08T17:30:24.934Z (5 months ago)
• Language: Python
• Size: 114 KB
• Stars: 2
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![](https://telegram.org/img/t_logo.svg?1)

# Telegram Exception Alerts

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![PyPI](https://img.shields.io/pypi/v/telegram-exception-alerts)](https://pypi.org/project/telegram-exception-alerts/)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/telegram-exception-alerts)

![PyPI - Wheel](https://img.shields.io/pypi/wheel/telegram-exception-alerts)

![PyPI - Downloads](https://img.shields.io/pypi/dw/telegram-exception-alerts)

**THIS LIBRARY HAS BEEN EXTENSIVELY TESTED AND IS CONSIDERED VERY STABLE: IT WORKS FINE AND HAS NO EXTERNAL DEPENDENCIES. SO NO FUTURE UPDATES ARE EXPECTED UNLESS I HAVE SOME VERY BRIGHT IDEA ABOUT IT.**

A very lightweight library for sending exception details to Telegram using a decorator. It uses no external dependencies.

## Installation

```bash

pip install telegram-exception-alerts

```

or

```bash

poetry add telegram-exception-alerts

```

## Usage

After you initialize the alerter instance you can attach the decorator to any function. If it

raises an exception information will be send to the chat specified in `chat_id` (don't forget

that if you want to send notification to a channel you need to prepend that `chat_id` with `-100`).

### Normal initialization

```python

from telegram_exception_alerts import Alerter

tg_alert = Alerter(bot_token='YOUR_BOT_TOKEN', chat_id='YOUR_CHAT_ID')

@tg_alert

def some_func_that_can_raise_an_exception():

    raise RuntimeError('this is an exception')

```

### Initialization from environment (recommended)

You can also initialize the alerter from environment variables. **This is the recommended way**

because it will make sure you're not committing sensitive information to the repo.

* `ALERT_BOT_TOKEN` - your bot token

* `ALERT_CHAT_ID` - your chat id to receive notifications

```python

from telegram_exception_alerts import Alerter

tg_alert = Alerter.from_environment()

@tg_alert

def some_func_that_can_raise_an_exception():

    raise RuntimeError('this is an exception')

```

Here's what a telegram message from an example above looks like:



## Sending messages

You can also use the `Alerter` as a simple way to send messages to Telegram:

```python

from telegram_exception_alerts import Alerter

tg_alert = Alerter.from_environment()

tg_alert.send_message(chat_id=111222333, text='Message text')

```

For real bot programming I highly recommend the excellent [python-telegram-bot](https://python-telegram-bot.org/) library.