mirror of
https://github.com/Mayuri-Chan/pyrofork.git
synced 2025-12-29 12:04:51 +00:00
538f1e3972
- Pyrogram core is now fully asynchronous - Ditched Python 3.5, welcome 3.6 as minimum version. - Moved all types to pyrogram.types - Turned the Filters class into a module (filters) - Moved all filters to pyrogram.filters - Moved all handlers to pyrogram.handlers - Moved all emoji to pyrogram.emoji - Renamed pyrogram.api to pyrogram.raw - Clock is now synced with server's time - Telegram schema updated to Layer 117 - Greatly improved the TL compiler (proper type-constructor hierarchy) - Added "do not edit" warning in generated files - Crypto parts are executed in a thread pool to avoid blocking the event loop - idle() is now a separate function (it doesn't deal with Client instances) - Async storage, async filters and async progress callback (optional, can be sync too) - Added getpass back, for hidden password inputs
75 lines
2.6 KiB
Markdown
75 lines
2.6 KiB
Markdown
<p align="center">
|
|
<a href="https://github.com/pyrogram/pyrogram">
|
|
<img src="https://i.imgur.com/BOgY9ai.png" alt="Pyrogram">
|
|
</a>
|
|
<br>
|
|
<b>Telegram MTProto API Framework for Python</b>
|
|
<br>
|
|
<a href="https://docs.pyrogram.org">
|
|
Documentation
|
|
</a>
|
|
•
|
|
<a href="https://github.com/pyrogram/pyrogram/releases">
|
|
Releases
|
|
</a>
|
|
•
|
|
<a href="https://t.me/Pyrogram">
|
|
Community
|
|
</a>
|
|
</p>
|
|
|
|
## Pyrogram
|
|
|
|
``` python
|
|
from pyrogram import Client, filters
|
|
|
|
app = Client("my_account")
|
|
|
|
|
|
@app.on_message(filters.private)
|
|
async def hello(client, message):
|
|
await message.reply_text(f"Hello {message.from_user.mention}")
|
|
|
|
|
|
app.run()
|
|
```
|
|
|
|
**Pyrogram** is a modern, elegant and easy-to-use [Telegram](https://telegram.org/) 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](https://core.telegram.org/api#telegram-api).
|
|
|
|
### 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](https://github.com/pyrogram/tgcrypto), a high-performance library
|
|
written in pure C.
|
|
- **Asynchronous**: Allows both synchronous and asynchronous usages to fit all usage needs.
|
|
- **Documented**: API methods, types and public interfaces are all [well documented](https://docs.pyrogram.org).
|
|
- **Type-hinted**: Types and methods are all type-hinted, enabling excellent editor support.
|
|
- **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
|
|
|
|
- Python 3.6 or higher.
|
|
- A [Telegram API key](https://docs.pyrogram.org/intro/setup#api-keys).
|
|
|
|
### Installing
|
|
|
|
``` bash
|
|
pip3 install pyrogram
|
|
```
|
|
|
|
### Resources
|
|
|
|
- The docs contain lots of resources to help you get started with Pyrogram: https://docs.pyrogram.org.
|
|
- Seeking extra help? Come join and ask our community: https://t.me/pyrogram.
|
|
- For other kind of inquiries, you can send a [message](https://t.me/haskell) or an [e-mail](mailto:dan@pyrogram.org).
|
|
|
|
### Copyright & License
|
|
|
|
- Copyright (C) 2017-2020 Dan <<https://github.com/delivrance>>
|
|
- Licensed under the terms of the [GNU Lesser General Public License v3 or later (LGPLv3+)](COPYING.lesser)
|