Skip to main content

Modern asynchronous Telegram MTProto framework.

Project description

DryGram Logo

DryGram

Modern, fully asynchronous, production-ready Telegram MTProto v2.0 client framework built from scratch in Python.

Python Version License Badge Latest Release Downloads Documentation Badge GitHub Stars GitHub Issues Build Status PyPI Version


Introduction

DryGram is a production-grade, highly-optimized, fully asynchronous Telegram MTProto client framework built from scratch in Python 3.13+. It implements the secure MTProto v2.0 protocol and integrates the latest Telegram features natively.

Designed with architectural originality at its core, DryGram does NOT duplicate or copy Pyrogram, Telethon, or other existing wrappers. It features a decoupled structure, pluggable session stores, extensible middleware chains, and a robust update dispatcher system to achieve maximum performance and scalability.


Features

Feature Description
Authentication Support for Bot authorization, User authorization, 2FA password verification, and QR Login flows.
Sessions Pluggable, highly-concurrent database storage backends: SQLite, MongoDB, Redis, and PostgreSQL.
Stories High-level APIs for publishing stories, reacting to them, archiving stories, and adjusting story privacy.
Business Full support for Telegram Business greeting/away responses, custom business links, and short reply templates.
Premium Operations for Telegram Star payments, upgradeable gifts, collectibles, and custom Premium Emoji Statuses.
Media Chunked uploads, high-speed concurrent downloads, and representations for Photos, Videos, Documents, Audios, and VoiceNotes.
Text Formatting Built-in, high-speed parsers for Markdown and HTML messages.
Keyboards Declarative markup interfaces for Reply and Inline keyboards, callback button handlers, and interactive menus.
Plugin System & Middleware Extensible middleware pipelines, priority-based command watchers, and modular update routing.
Raw MTProto & AsyncIO Direct invocation of raw TL schema functions via async loops.

Installation

Installation Options

1. Standard Installation (No native compilers required)

Install the core package via PyPI:

pip install drygram

2. Optional Crypto Installation

Install with the optional crypto dependency group:

pip install "drygram[crypto]"

Note: Installs the required standard cryptography package without requiring native compilers or Visual Studio Build Tools.

3. Optional Voice & Calling Support

Install with integrations for voice and video calling:

pip install "drygram[calls]"

4. Optional Database Support

Install pluggable session database stores:

# MongoDB support
pip install "drygram[mongodb]"

# Redis support
pip install "drygram[redis]"

# PostgreSQL support
pip install "drygram[postgres]"

5. Development Installation

Install for library contribution and testing:

pip install "drygram[dev]"

Alternative Package Managers

Using uv:

uv pip install drygram

Using Poetry:

poetry add drygram

Installation from Source

To install the latest development code from GitHub:

git clone https://github.com/TG-BOTSNETWORK/drygram.git
cd drygram
pip install -e .

To install development and testing dependencies:

pip install -e .[dev]

Quick Start

The following is a complete runnable bot that responds to /start messages:

from drygram import (
    DryClient, filters, enums, errors, types, idle, StringSessionGenerator
)

# Initialize bot client
app = DryClient(api_id=12345, api_hash="abcdef", bot_token="YOUR_BOT_TOKEN")

# Register an update observer for /start command with filters
@app.route("/start", gate=filters.private)
async def start_handler(client, msg: types.Message):
    await msg.reply("Hello! Welcome to DryGram.")

if __name__ == "__main__":
    app.run()

Top-Level Public API Exports

DryGram provides a clean, Pyrogram/Telethon-friendly top-level import structure:

from drygram import (
    DryClient,              # Main MTProto client engine
    filters,                # Pyrogram/Telethon compatible update filter factory
    enums,                  # Telegram enumerations (ChatType, ParseMode, etc.)
    errors,                 # Framework and MTProto RPC exception module
    types,                  # Type dataclasses (Message, User, Chat, Media)
    idle,                   # Signal-safe event loop blocking helper
    StringSessionGenerator  # Tool for generating DRY1 String Sessions
)

Client Authentication Methods

DryGram supports both Bot and User authentication out of the box.

1. Bot Authentication (Recommended)

Automatically starts the client in Bot Mode. No session file is created; everything runs in memory.

from drygram import DryClient

app = DryClient(
    api_id=12345,
    api_hash="abcdef",
    bot_token="YOUR_BOT_TOKEN"  # recommended for bots, no session_name required
)

2. User Authentication

Starts the client in User Mode. Instead of saving .session files on disk, DryGram uses stateless MTProto String Sessions loaded via the session_name parameter.

from drygram import DryClient

# The session_name parameter stores the generated MTProto String Session, not a filename
app = DryClient(
    api_id=12345,
    api_hash="abcdef",
    session_name="DRY1U_..."  # generated string session
)

To export the authenticated session to a string:

import asyncio
from drygram import DryClient

async def main():
    # If starting without credentials, log in interactively or import string session
    async with DryClient(api_id=12345, api_hash="abc", session_name="DRY1U_...") as app:
        # Export the active session to a string
        sess_str = await app.export_session()
        print("Exported String Session:", sess_str)

if __name__ == "__main__":
    asyncio.run(main())

Project Structure

drygram/
├── drygram/           # Primary package source code
├── docs/              # Detailed guides and manuals
├── examples/          # Complete client usage examples
├── tests/             # Comprehensive testing suite
├── pyproject.toml     # Project metadata and configurations
└── setup.py           # Legacy installer script

Documentation

The full documentation is available under the docs/ directory, containing tutorials and details about the architecture. You can also build it locally using MkDocs:

pip install mkdocs-material
mkdocs serve

Supported Platforms

  • Windows: x86, x64, ARM64, and WSL.
  • Linux: Ubuntu, Debian, Arch Linux, Fedora, CentOS, and Alpine.
  • macOS: Intel and Apple Silicon (M1/M2/M3).
  • Containerization: Full support for Docker and Kubernetes environments.

Cryptographic Backend & Performance

DryGram dynamically manages cryptographic execution via its built-in Backend Manager:

Backend Implementation Acceleration Performance Note
Cryptography Pure Python Engine Disabled High compatibility; works out-of-the-box on any platform without compiler tools.

DryGram operates exclusively on standard Python-compatible cryptography libraries, ensuring compiled C extensions or platform-specific Visual Studio Build Tools are never required.


Optional Voice Support

Voice and video calling functionality are supported through external integrations. Users can utilize third-party WebRTC/calling libraries alongside DryClient for streaming capabilities:

  • py-tgcalls == 2.3.3
  • ntgcalls == 2.2.5

These dependencies can be installed using the optional calls extra group:

pip install "drygram[calls]"

Community


Special Thanks

  • Telegram Team for providing public MTProto documentation and protocol specifications.
  • The Python Open-Source Community for developing the underlying dependencies and testing systems that power modern async development.
  • Contributors and community members helping review code and report issues.

Credits


License

This project is licensed under the GNU General Public License v3.0.

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

drygram-1.0.13.tar.gz (80.1 kB view details)

Uploaded Source

Built Distribution

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

drygram-1.0.13-py3-none-any.whl (100.8 kB view details)

Uploaded Python 3

File details

Details for the file drygram-1.0.13.tar.gz.

File metadata

  • Download URL: drygram-1.0.13.tar.gz
  • Upload date:
  • Size: 80.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for drygram-1.0.13.tar.gz
Algorithm Hash digest
SHA256 f3b0f0d5811c15539184dd11a2f97c3fbf1675bff5df5312991c1c0d39f2f8b7
MD5 fbea95c558c6006ea85269f3f50b2fc7
BLAKE2b-256 0597c824faa35bb37d78fda6c95f1dc56a227541104827200cb29ca7d446f934

See more details on using hashes here.

File details

Details for the file drygram-1.0.13-py3-none-any.whl.

File metadata

  • Download URL: drygram-1.0.13-py3-none-any.whl
  • Upload date:
  • Size: 100.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for drygram-1.0.13-py3-none-any.whl
Algorithm Hash digest
SHA256 845a6cdbcf320049b36ec46c25bc622b0410772466b8bb7812186abcb097b8e6
MD5 b5c7791f5bf9ed500fe7cddc3efd55f6
BLAKE2b-256 018a4cb4e3ad706db13b162d42e32249fe6f6e0cd349f2dd91608ceb9700bc64

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