telegram-alert-bot 0.2.1

An asynchronous Telegram bot designed for sending alerts and notifications with a message queuing system.

Telegram Alert Bot

A simple asynchronous Telegram bot for sending alerts and notifications with message queuing capabilities.

Features

• Asynchronous message handling
• Message queuing system
• Error handling for Telegram API communications
• Support for mentioning other bots in messages
• Logging functionality
• Optional message merging based on a specified pattern

Installation

pip install telegram-alert-bot

Prerequisites

• Python 3.7+
• python-telegram-bot library
• A Telegram Bot Token (obtained from @BotFather)
• Your Telegram User ID

Usage

Basic Setup

from telegram_alert_bot import TelegramAlertBot
import asyncio

# Initialize the bot
bot = TelegramAlertBot(
    token="YOUR_BOT_TOKEN",
    user_id="YOUR_TELEGRAM_USER_ID"
)

# Create an async function to run your bot
async def main():
    # Start the background polling
    polling_task = asyncio.create_task(bot.background_bot_polling())
    
    # Trigger an event (send a message)
    await bot.event_trigger("Hello, World!", "mybot")
    
    # Wait for the message to be processed
    await bot.message_queue.join()
    
# Run the bot
asyncio.run(main())

API Reference

TelegramAlertBot Class

The main class for handling Telegram alerts. Implementation can be found in:

startLine: 6
endLine: 31

Methods

1. __init__(token: str, user_id: str, merge_pattern: str = None)

   • token: Your Telegram bot token
   • user_id: The Telegram user ID to send messages to
   • merge_pattern: Optional string to detect messages for merging

2. async send_telegram_message(message: str)

   • Sends a message directly to the specified user
   • Handles Telegram API errors and logs the outcome

3. async background_bot_polling()

   • Runs continuously in the background
   • Processes messages from the queue
   • Should be run in a separate task

4. async event_trigger(message: str, bot: str)

   • Queues a new message for sending
   • Automatically adds bot mention in format @bot
   • Messages are processed in FIFO order

Message Merging

The bot supports optional message merging functionality, which allows you to combine consecutive messages that match a specific pattern. This is particularly useful for status updates or repeated notifications.

Basic Message Merging Setup

from telegram_alert_bot import TelegramAlertBot
import asyncio

# Initialize bot with message merging enabled
bot = TelegramAlertBot(
    token="YOUR_BOT_TOKEN",
    user_id="YOUR_TELEGRAM_USER_ID",
    merge_pattern="No profitable items found between"
)

async def main():
    polling_task = asyncio.create_task(bot.background_bot_polling())
    
    # These messages will be merged if sent consecutively
    await bot.event_trigger(
        "No profitable items found between 2024-01-01 10:00:00 and 2024-01-01 10:15:00.",
        "status_bot"
    )
    await bot.event_trigger(
        "No profitable items found between 2024-01-01 10:15:00 and 2024-01-01 10:30:00.",
        "status_bot"
    )
    
    # Result in chat will be:
    # "No profitable items found between 2024-01-01 10:00:00 and 2024-01-01 10:30:00."
    # "@status_bot"
    
    await bot.message_queue.join()

asyncio.run(main())

Message Merging Behavior

1. Pattern Matching: Only messages that start with the specified merge_pattern will be considered for merging.

2. Consecutive Messages: Merging only occurs for consecutive messages. If other messages appear in between, the merge chain breaks.

3. Time Extraction: The bot automatically extracts and combines time ranges from messages.

Advanced Usage Examples

Custom Pattern Merging

# Initialize with custom pattern
bot = TelegramAlertBot(
    token="YOUR_BOT_TOKEN",
    user_id="YOUR_TELEGRAM_USER_ID",
    merge_pattern="Status update:"
)

async def main():
    polling_task = asyncio.create_task(bot.background_bot_polling())
    
    # These messages will be merged
    await bot.event_trigger("Status update: System check at 09:00", "system_bot")
    await bot.event_trigger("Status update: System check at 10:00", "system_bot")
    
    # This message won't be merged (different pattern)
    await bot.event_trigger("Alert: New user registered", "system_bot")
    
    await bot.message_queue.join()

Error Handling

The bot includes built-in error handling for Telegram API communications. All errors are logged using Python's logging module. Error handling implementation can be found in:

startLine: 14
endLine: 18

Logging

The bot uses Python's built-in logging module to track:

• Message sending attempts
• Successful message delivery
• Error states
• Event triggers
• Bot polling status

Version

Current version: 0.1.0

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Support

For support, please open an issue in the GitHub repository.

Authors

pudjo_jotaro https://github.com/pudjojotaro