log2telegram
log2telegram is a CLI tool to monitor changes in a specified log file and send updates to a Telegram chat. This package allows you to stay informed about updates in critical logs or other files by sending new content as Telegram messages, with customizable options to filter color codes and timestamps.
Features
• Real-Time Monitoring: Continuously watches for changes in a log file, sending new content as Telegram messages.
• Configurable Delay: Set a custom interval for checking the file for changes.
• Filtering Options: Remove ANSI color codes and timestamps at the start of lines for cleaner messages.
• Customizable Message Splitting: Automatically splits messages if they exceed the Telegram message size limit.
• Error Handling and Logging: Logs errors if the file is unreadable, ensuring smooth operation and easy debugging.
Installation
You can install the package via PyPI:
pip install log2telegram
Setup
To use log2telegram, add the following environment variables to a .env file:
LOG2TELEGRAM_BOT_TOKEN= LOG2TELEGRAM_CHAT_ID=
• LOG2TELEGRAM_BOT_TOKEN: Your Telegram bot token, obtained from BotFather.
• LOG2TELEGRAM_CHAT_ID: The chat ID where messages will be sent.
Usage
Run the log2telegram command to monitor a file for changes. You can specify the path to the file and set optional flags for filtering.
Command-Line Arguments
log2telegram [--seconds_delay SECONDS] [--filter-color-chars] [--filter-timestamps]
• <file-path> (required): The path to the file to monitor.
• --seconds_delay (optional): Interval in seconds between each check (default: 1). Must be a positive integer.
• --filter-color-chars (optional): Removes ANSI color codes from lines before sending.
• --filter-timestamps (optional): Removes timestamps at the start of lines.
Examples
1. Basic Usage
Monitor a log file with a default polling delay of 1 second.
Example Workflow
1. Start the program to monitor the specified file.
2. Upon changes, new content is sent to the designated Telegram chat.
3. If specified, color codes and timestamps are removed from each line before sending.
Requirements
• Python 3.7+
• Dependencies managed automatically upon installation.
License
This package is licensed under the MIT License.
Contributing
Contributions are welcome! Feel free to open issues or submit pull requests for improvements.
Metadata
Release files for log2telegram 0.6.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| log2telegram-0.6.7.tar.gz | 12.2 kB | Without provenance | Details for log2telegram-0.6.7.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| log2telegram-0.6.7-py3-none-any.whl | Python 3 | none | any | Details for log2telegram-0.6.7-py3-none-any.whl |
Total release size: 23.7 kB
Release files / log2telegram-0.6.7.tar.gz
| Download URL | log2telegram-0.6.7.tar.gz |
|---|---|
| Size | 12.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f6693238cf7c603dc7751c14f7c1981c8041ed22263e7ac2da14c641a7d8382e
|
|
BLAKE2b-256 checksum How to use checksums |
c273d709df3c68f7b85db459219df82dd0e45f45259e71693316069569276c2c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.11.11
|
Release files / log2telegram-0.6.7-py3-none-any.whl
| Download URL | log2telegram-0.6.7-py3-none-any.whl |
|---|---|
| Size | 11.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fae1890e0ae077bdbe3fbf83990bef76297710bd8f54818cd710f41bd72549e1
|
|
BLAKE2b-256 checksum How to use checksums |
74fab6d3bb16809b289b39223dc35d0458173a74639cd524f2a773eba5471a92
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.11.11
|
Security for log2telegram 0.6.7
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.