121 lines
3.6 KiB
ReStructuredText
121 lines
3.6 KiB
ReStructuredText
Welcome to Pyrogram
|
|
===================
|
|
|
|
.. raw:: html
|
|
|
|
<div align="center">
|
|
<a href="https://docs.pyrogram.ml">
|
|
<div><img src="_static/logo.png" alt="Pyrogram Logo"></div>
|
|
</a>
|
|
</div>
|
|
|
|
<p align="center">
|
|
<b>Telegram MTProto API Framework for Python</b>
|
|
|
|
<br>
|
|
<a href="https://docs.pyrogram.ml">
|
|
Documentation
|
|
</a>
|
|
•
|
|
<a href="https://github.com/pyrogram/pyrogram/releases">
|
|
Changelog
|
|
</a>
|
|
•
|
|
<a href="https://t.me/PyrogramChat">
|
|
Community
|
|
</a>
|
|
<br>
|
|
<a href="compiler/api/source/main_api.tl">
|
|
<img src="https://img.shields.io/badge/schema-layer%2091-eda738.svg?longCache=true&colorA=262b30"
|
|
alt="Schema Layer">
|
|
</a>
|
|
<a href="https://github.com/pyrogram/tgcrypto">
|
|
<img src="https://img.shields.io/badge/tgcrypto-v1.1.1-eda738.svg?longCache=true&colorA=262b30"
|
|
alt="TgCrypto Version">
|
|
</a>
|
|
</p>
|
|
|
|
.. code-block:: python
|
|
|
|
from pyrogram import Client, Filters
|
|
|
|
app = Client("my_account")
|
|
|
|
|
|
@app.on_message(Filters.private)
|
|
def hello(client, message):
|
|
message.reply("Hello {}".format(message.from_user.first_name))
|
|
|
|
|
|
app.run()
|
|
|
|
Welcome to Pyrogram's Documentation! Here you can find resources for learning how to use the framework.
|
|
Contents are organized into self-contained topics and can be accessed from the sidebar, or by following them in order
|
|
using the Next button at the end of each page. But first, here's a brief overview of what is this all about.
|
|
|
|
About
|
|
-----
|
|
|
|
**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 using both user and bot identities (bot API alternative) via the `MTProto 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_, 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 the latest Telegram API version, currently Layer 91 on top of `MTProto 2.0`_.
|
|
- **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.
|
|
|
|
To get started, press the Next button.
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
:caption: Quick Start
|
|
|
|
start/Installation
|
|
start/Setup
|
|
start/Usage
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
:caption: Resources
|
|
|
|
resources/UpdateHandling
|
|
resources/UsingFilters
|
|
resources/MoreOnUpdates
|
|
resources/ConfigurationFile
|
|
resources/SmartPlugins
|
|
resources/AutoAuthorization
|
|
resources/CustomizeSessions
|
|
resources/TgCrypto
|
|
resources/TextFormatting
|
|
resources/SOCKS5Proxy
|
|
resources/BotsInteraction
|
|
resources/ErrorHandling
|
|
resources/TestServers
|
|
resources/AdvancedUsage
|
|
resources/VoiceCalls
|
|
resources/Changelog
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
:caption: Main Package
|
|
|
|
pyrogram/index
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
:caption: Telegram API
|
|
|
|
functions/index
|
|
types/index
|
|
|
|
.. _`Telegram`: https://telegram.org/
|
|
.. _TgCrypto: https://docs.pyrogram.ml/resources/TgCrypto/
|
|
.. _`MTProto API`: https://core.telegram.org/api#telegram-api
|
|
.. _`MTProto 2.0`: https://core.telegram.org/mtproto |