Skip to main content

Elegant, modern and asynchronous Telegram MTProto API framework in Python for users and bots

Project description

wzgram

PyPI Python Downloads License Documentation

Elegant, modern and asynchronous Telegram MTProto API framework in Python for users and bots

wzgram is a drop-in replacement for Pyrogram — your existing from pyrogram import ... code works without changes, with access to the latest Telegram features including Gifts, Stories, Topics, Business Accounts, and more.

from pyrogram import Client, filters

app = Client("my_account")


@app.on_message(filters.private)
async def hello(client, message):
    await message.reply("Hello from wzgram!")


app.run()

wzgram is a modern, elegant and asynchronous MTProto API framework. It enables you to easily interact with the main Telegram API through a user account (custom client) or a bot identity (bot API alternative) using Python.

Key Features

  • Drop-in Replacement — Use from pyrogram import ...; existing codebases migrate with zero import changes.
  • Up-to-Date — Supports Gifts, Stories, Topics, Business Accounts, Giveaways, and the latest Telegram layer.
  • Async Natively — Fully async/await throughout. Also usable synchronously via app.run() for convenience.
  • Type-hinted — Every type and method is annotated for excellent editor support.
  • Fast — Boosted by WarpCrypto, a high-performance cryptography library written in Rust.
  • Powerful — Full access to Telegram's API for any official client action and more.

Example with Inline Keyboard

from pyrogram import Client, filters
from pyrogram.types import InlineKeyboardMarkup, InlineKeyboardButton

app = Client("my_bot")


@app.on_message(filters.command("start"))
async def start(client, message):
    await message.reply(
        "Choose an option:",
        reply_markup=InlineKeyboardMarkup([
            [
                InlineKeyboardButton("Website", url="https://example.com"),
                InlineKeyboardButton("Help", callback_data="help"),
            ],
            [InlineKeyboardButton("About", callback_data="about")],
        ])
    )


app.run()

Installing

pip install wzgram

For better performance:

pip install wzgram[fast]

Development

# Clone the repo
git clone https://github.com/rjriajul/wzgram
cd wzgram

# Install uv (if not already)
pip install uv

# Create virtual environment with dev dependencies
uv sync --frozen --extra dev

# Generate TL API types
uv run poe api

# Run tests
uv run poe test

Documentation

Full documentation at https://rjriajul.github.io/wzgram

Resources

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

wzgram-3.0.19.tar.gz (657.6 kB view details)

Uploaded Source

Built Distribution

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

wzgram-3.0.19-py3-none-any.whl (5.7 MB view details)

Uploaded Python 3

File details

Details for the file wzgram-3.0.19.tar.gz.

File metadata

  • Download URL: wzgram-3.0.19.tar.gz
  • Upload date:
  • Size: 657.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for wzgram-3.0.19.tar.gz
Algorithm Hash digest
SHA256 b0babbaf53f4e69f1b419c4fdbdac1c8cb3346d3dcc6348ccc9f98731ac9f8f5
MD5 b26b0b795b8ab8bf504419060d62a6b9
BLAKE2b-256 eacb40a0d264369b779777a0695b65e40b1ff3a76e4e79aae1a15929437f12fb

See more details on using hashes here.

File details

Details for the file wzgram-3.0.19-py3-none-any.whl.

File metadata

  • Download URL: wzgram-3.0.19-py3-none-any.whl
  • Upload date:
  • Size: 5.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for wzgram-3.0.19-py3-none-any.whl
Algorithm Hash digest
SHA256 5c467d2b8280c402961456e01469d80505f0af4ea707974d202e8be1a67899f4
MD5 15e56140b0f9e1d3421b0d3571327978
BLAKE2b-256 babc24119001f98f474fe9969b557a7695769143c838c5f1a004ec95b7504e59

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