telememo 0.1.0

Dump Telegram channel messages to a local SQLite database for searching and archival

Telememo

Telememo is a Python CLI tool to dump Telegram channel messages to a local SQLite database for easy searching and archival.

Features

• Dump all messages from Telegram channels to SQLite
• Search messages by text content
• Incremental sync to fetch only new messages
• Built with modern Python async/await
• Lightweight and easy to use

Requirements

• Python 3.10 or higher
• Telegram API credentials (API ID and API hash from https://my.telegram.org)
• Your Telegram account (phone number) for authentication

Installation

Install from PyPI:

pip install telememo

Or as an isolated CLI tool with uv:

uv tool install telememo

From source (development)

1. Clone the repository:

git clone https://github.com/reorx/telememo
cd telememo

2. Install in editable mode:

pip install -e .

For development with testing tools:

pip install -e ".[dev]"

Configuration

Create a configuration file at ~/.config/telememo/config.py:

mkdir -p ~/.config/telememo
cp config.example.py ~/.config/telememo/config.py

Edit ~/.config/telememo/config.py with your credentials:

# Telegram API credentials (get from https://my.telegram.org)
TELEGRAM_API_ID = 12345678
TELEGRAM_API_HASH = "your_api_hash_here"

# Your phone number (optional, will be prompted if not set)
PHONE = "[phone]"

# Default channel to use when -c/--channel-name is not specified
DEFAULT_CHANNEL = "example_channel"

# Optional: Configure multiple channels
CHANNELS = {
    "tech_news": {
        "id": "@technews",
        "description": "Technology news channel"
    },
}

Getting Telegram API Credentials

1. Visit https://my.telegram.org
2. Log in with your phone number
3. Go to "API development tools"
4. Create a new application
5. Copy your api_id and api_hash

Authentication

Important: Telememo uses user authentication, not bot authentication, because Telegram bots cannot access historical channel messages.

When you run the CLI for the first time, you'll be prompted to:

1. Enter your phone number (in international format, e.g., [phone])
2. Enter the verification code sent to your Telegram app
3. Optionally enter your 2FA password if enabled

Your session will be saved locally in ~/.local/share/telememo/telethon.session so you won't need to authenticate again. This session file is shared across all channels.

Usage

Dump channel messages

Dump all messages from a channel:

telememo -c @channelname dump-messages

Or use the default channel from config:

telememo dump-messages

Dump with a limit:

telememo -c @channelname dump-messages --limit 100

Sync new messages

Fetch only new messages since last sync:

telememo -c @channelname sync

Show channel information

telememo -c @channelname info

Search messages

Search within a specific channel:

telememo -c @channelname search "search term" --limit 20

Project Structure

telememo/
├── telememo/
│   ├── __init__.py
│   ├── types.py      # Pydantic data models
│   ├── db.py         # Database operations (Peewee ORM)
│   ├── telegram.py   # Telegram client wrapper (Telethon)
│   ├── core.py       # Business logic & scraper
│   └── cli.py        # CLI commands (Click)
├── tests/
│   ├── conftest.py
│   └── test_integration.py
├── pyproject.toml
├── claude.md
└── README.md

Development

Running Tests

Run integration tests:

pytest tests/

Run with verbose output:

pytest -v tests/

Run specific test:

pytest tests/test_integration.py::test_get_channel_info_and_messages -v

Development Guidelines

See claude.md for detailed development guidelines and architecture principles.

Tech Stack

• Telethon: Telegram MTProto API client
• Peewee: Lightweight SQLite ORM
• Click: CLI framework
• Pydantic: Data validation
• pytest: Testing framework

License

MIT

Contributing

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