Mirror of pyogram, an elegant, easy-to-use Telegram client library and framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ColinShark b74a8eba5e Add bound method for get_common_chats (#305) 3 days ago
.github Update bug_report.md 1 week ago
compiler Add get_nearby_chats method 5 days ago
docs Update PDF fonts 6 days ago
examples Update domain name references to pyrogram.org 3 months ago
pyrogram Add bound method for get_common_chats (#305) 3 days ago
.gitignore Update .gitignore with vscode and alternate docs build dir 1 month ago
COPYING Initial commit 1 year ago
COPYING.lesser Initial commit 1 year ago
MANIFEST.in Update errors prune path 1 month ago
NOTICE Update copyright year 7 months ago
README.md Drop Python 3.4 support (EOL). Bump minimum requirement to Python 3.5.3 1 week ago
requirements.txt Drop Python 3.4 support (EOL). Bump minimum requirement to Python 3.5.3 1 week ago
setup.py Drop Python 3.4 support (EOL). Bump minimum requirement to Python 3.5.3 1 week ago

README.md

Pyrogram
Telegram MTProto API Framework for Python
Documentation Releases Community

Pyrogram

from pyrogram import Client, Filters

app = Client("my_account")


@app.on_message(Filters.private)
def hello(client, message):
    message.reply_text("Hello {}".format(message.from_user.first_name))


app.run()

Pyrogram is an elegant, easy-to-use Telegram client library and framework written from the ground up in Python and C. It enables you to easily create custom apps for both user and bot identities (bot API alternative) via the MTProto API.

Pyrogram in fully-asynchronous mode is also available »

Working PoC of Telegram voice calls using Pyrogram »

Features

  • Easy: You can install Pyrogram with pip and start building your applications right away.
  • Elegant: Low-level details are abstracted and re-presented in a much nicer and easier way.
  • Fast: Crypto parts are boosted up by TgCrypto, a high-performance library written in pure C.
  • Documented: Pyrogram API methods, types and public interfaces are well documented.
  • Type-hinted: Exposed Pyrogram types and method parameters are all type-hinted.
  • Updated, to make use of the latest Telegram API version and features.
  • Bot API-like: Similar to the Bot API in its simplicity, but much more powerful and detailed.
  • Pluggable: The Smart Plugin system allows to write components with minimal boilerplate code.
  • Comprehensive: Execute any advanced action an official client is able to do, and even more.

Requirements

Installing

pip3 install pyrogram

Resources

Contributing

Pyrogram is brand new, and you are welcome to try it and help make it even better by either submitting pull requests or reporting issues/bugs as well as suggesting best practices, ideas, enhancements on both code and documentation. Any help is appreciated!

Copyright & License