Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pyrogram/pyrogram
Elegant, modern and asynchronous Telegram MTProto API framework in Python for users and bots
https://github.com/pyrogram/pyrogram
async asynchronous asyncio bot-api client framework hacktoberfest library mtproto pyrogram python python-library telegram telegram-api
Last synced: 4 days ago
JSON representation
Elegant, modern and asynchronous Telegram MTProto API framework in Python for users and bots
- Host: GitHub
- URL: https://github.com/pyrogram/pyrogram
- Owner: pyrogram
- License: lgpl-3.0
- Created: 2017-12-12T09:37:41.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-07-31T06:08:09.000Z (5 months ago)
- Last Synced: 2024-10-29T11:13:54.771Z (about 1 month ago)
- Topics: async, asynchronous, asyncio, bot-api, client, framework, hacktoberfest, library, mtproto, pyrogram, python, python-library, telegram, telegram-api
- Language: Python
- Homepage: https://pyrogram.org
- Size: 7.01 MB
- Stars: 4,398
- Watchers: 95
- Forks: 1,419
- Open Issues: 289
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: COPYING
Awesome Lists containing this project
- awesome - pyrogram/pyrogram - Elegant, modern and asynchronous Telegram MTProto API framework in Python for users and bots (Python)
- awesome - pyrogram/pyrogram - Elegant, modern and asynchronous Telegram MTProto API framework in Python for users and bots (Python)
- awesome-python-resources - Source
- awesome-telegram - pyrogram - Telegram MTProto API Python client library framework for users and bots. (Bots / Bot Libs)
- awesome-telegram - Pyrogram
- awesome-telegram - Pyrogram
README
Telegram MTProto API Framework for Python
Homepage
•
Documentation
•
Releases
•
News
## Pyrogram
> Elegant, modern and asynchronous Telegram MTProto API framework in Python for users and bots
``` python
from pyrogram import Client, filters
app = Client("my_account")
@app.on_message(filters.private)
async def hello(client, message):
await message.reply("Hello from Pyrogram!")
app.run()
```
**Pyrogram** is a modern, elegant and asynchronous [MTProto API](https://docs.pyrogram.org/topics/mtproto-vs-botapi)
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.
### Support
If you'd like to support Pyrogram, you can consider:
- [Become a GitHub sponsor](https://github.com/sponsors/delivrance).
- [Become a LiberaPay patron](https://liberapay.com/delivrance).
- [Become an OpenCollective backer](https://opencollective.com/pyrogram).
### Key Features
- **Ready**: Install Pyrogram with pip and start building your applications right away.
- **Easy**: Makes the Telegram API simple and intuitive, while still allowing advanced usages.
- **Elegant**: Low-level details are abstracted and re-presented in a more convenient way.
- **Fast**: Boosted up by [TgCrypto](https://github.com/pyrogram/tgcrypto), a high-performance cryptography library written in C.
- **Type-hinted**: Types and methods are all type-hinted, enabling excellent editor support.
- **Async**: Fully asynchronous (also usable synchronously if wanted, for convenience).
- **Powerful**: Full access to Telegram's API to execute any official client action and more.
### Installing
``` bash
pip3 install pyrogram
```
### Resources
- Check out the docs at https://docs.pyrogram.org to learn more about Pyrogram, get started right
away and discover more in-depth material for building your client applications.
- Join the official channel at https://t.me/pyrogram and stay tuned for news, updates and announcements.