Skip to main content

Simple Interface for Telegram read and listen

Project description

TelegramManager

A Python CLI tool and module for fetching and monitoring Telegram messages from public channels and groups. Built with Telethon for reliable Telegram API integration.

Installation

Install TelegramManager using pip:

pip install .

For development installation:

pip install -e .[dev]

Configuration

Environment Configuration

Create a .env file in your project root directory:

TELEGRAM_API_ID=your_api_id
TELEGRAM_API_HASH=your_api_hash
TELEGRAM_PHONE_NUMBER=+1234567890

The default TelegramManager() constructor automatically loads these environment variables.

Manual Configuration

For programmatic usage without environment files:

from telegram_manager.controller import TelegramManager

tg = TelegramManager(
    api_id=123456,
    api_hash="your_api_hash_here",
    phone_number="+1234567890"
)

Command Line Interface

The tm command provides two primary operations:

Fetch Messages

Retrieve historical messages from a channel or group:

tm fetch <channel> [--min-id <id>] [--limit <n>] [--since <relative-time>] [--search <text>] [--json] [--verbose]

Options:

  • --min-id: Minimum message ID to fetch from.
  • --limit: Maximum number of messages to retrieve.
  • --since: Filter messages newer than a relative time expression.
  • --search: Filter messages containing the given search string.
  • --json: Output each message in JSON format.
  • --verbose: Print detailed metadata per message.

Supported --since formats:

  • mo: months (e.g. 1mo)
  • w: weeks (e.g. 2w)
  • d: days (e.g. 3d)
  • h: hours (e.g. 4h)
  • m: minutes (e.g. 30m)

You can combine units:

tm fetch @openai --since "1mo 2w 3d 4h 30m" --search GPT --verbose

Listen for Messages

Monitor channels for new messages in real-time:

tm listen <channel>

Example:

tm listen "Some Group Chat"

Verbose Mode

When --verbose is enabled in fetch, each message will include:

  • Message ID
  • Date in local time and UTC
  • Sender username and ID
  • Message type (text, photo, document, video)
  • Reply-to message ID (if any)
  • Raw text content

A final summary is also printed, including:

  • Total messages
  • Unique user count
  • Breakdown by media type
  • Minimum message ID fetched

JSON Output

Use --json to emit each message as a structured JSON object. This is useful for piping into other programs or saving to file.

Python API

Basic Usage

from telegram_manager import TelegramManager

tg = TelegramManager()

Fetching Messages

tg.fetch_messages(
    chat_identifier="@somechannel",
    message_processor=lambda m: print(m.id, m.raw_text),
    limit=5
)

Real-time Message Monitoring

tg.listen("@somechannel", message_handler=lambda m: print(f"New: {m.message}"))

Supported Input Formats

TelegramManager accepts multiple channel identifier formats:

  • Telegram URLs: https://t.me/channelname
  • Username format: @channelname
  • Dialog names: "Channel Display Name"

Authentication

  • Session files are created locally to maintain authentication across sessions
  • First-time usage requires verification code entry
  • Authentication state persists between program runs

Requirements

  • Python 3.7 or higher
  • Valid Telegram API credentials
  • Network connectivity for Telegram API access

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

telegrammanager-0.1.12.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

telegrammanager-0.1.12-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

Details for the file telegrammanager-0.1.12.tar.gz.

File metadata

  • Download URL: telegrammanager-0.1.12.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for telegrammanager-0.1.12.tar.gz
Algorithm Hash digest
SHA256 38ef3d4ae0aa737a678544cc67636b241f4fa8630a218fa0f1d0f139fbe22967
MD5 ff5eca9aa1d508e1a0972e48fc7d9e46
BLAKE2b-256 3fa25ee7b1f60a447e886f283e84a4c60ceca200a2575b158f547a860c982e39

See more details on using hashes here.

File details

Details for the file telegrammanager-0.1.12-py3-none-any.whl.

File metadata

File hashes

Hashes for telegrammanager-0.1.12-py3-none-any.whl
Algorithm Hash digest
SHA256 c9d42a4b1edf4f639671fa017a78d55990dce2d9c1bfff0468ebf75b56764426
MD5 32febc5b534f09c89534a179f9d3bd81
BLAKE2b-256 15cc1dccf163b02e05e2c8ec654376259453101ee743b92ac95f39f7b56bab8c

See more details on using hashes here.

Supported by

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