mirror of
https://github.com/TeamPGM/pyrogram.git
synced 2024-11-16 12:51:18 +00:00
116 lines
3.5 KiB
ReStructuredText
116 lines
3.5 KiB
ReStructuredText
Welcome to Pyrogram
|
|
===================
|
|
|
|
.. raw:: html
|
|
|
|
<div align="center">
|
|
<a href="https://docs.pyrogram.ml">
|
|
<div><img src="https://media.pyrogram.ml/images/icon.png" alt="Pyrogram Icon"></div>
|
|
<div><img src="https://media.pyrogram.ml/images/label.png" alt="Pyrogram Label"></div>
|
|
</a>
|
|
</div>
|
|
|
|
<p align="center">
|
|
<b>Telegram MTProto API Client Library for Python</b>
|
|
<br>
|
|
<a href="https://github.com/pyrogram/pyrogram/releases/latest">
|
|
Download
|
|
</a>
|
|
•
|
|
<a href="https://github.com/pyrogram/pyrogram">
|
|
Source code
|
|
</a>
|
|
•
|
|
<a href="https://t.me/PyrogramChat">
|
|
Community
|
|
</a>
|
|
<br><br>
|
|
<a href="https://github.com/pyrogram/pyrogram/blob/master/compiler/api/source/main_api.tl">
|
|
<img src="https://media.pyrogram.ml/images/scheme.svg"
|
|
alt="Scheme Layer 75">
|
|
</a>
|
|
<a href="https://github.com/pyrogram/tgcrypto">
|
|
<img src="https://media.pyrogram.ml/images/tgcrypto.svg"
|
|
alt="TgCrypto">
|
|
</a>
|
|
</p>
|
|
|
|
About
|
|
-----
|
|
|
|
Welcome to Pyrogram's Documentation! Here you can find resources for learning how to use the library.
|
|
Contents are organized by topic and can be accessed from the sidebar, or by following them one by one using the Next
|
|
button at the end of each page. But first, here's a brief overview of what is this all about:
|
|
|
|
**Pyrogram** is a brand new Telegram_ Client Library written from the ground up in Python and C. It can be used for building
|
|
custom Telegram applications in Python that interact with the MTProto API as both User and Bot.
|
|
|
|
.. code-block:: python
|
|
|
|
from pyrogram import Client
|
|
|
|
client = Client("example")
|
|
client.start()
|
|
|
|
client.send_message("me", "Hi there! I'm using Pyrogram")
|
|
|
|
client.stop()
|
|
|
|
Features
|
|
--------
|
|
|
|
- **Easy to setup**: Pyrogram can be easily installed using pip and requires very few lines of code to get started with.
|
|
|
|
- **Easy to use**: Pyrogram provides idiomatic, clean and readable Python code making the Telegram API simple to use.
|
|
|
|
- **High-level**: Pyrogram automatically handles all the low-level details of communication with Telegram servers.
|
|
|
|
- **Updated**: Pyrogram makes use of the latest Telegram MTProto API version, currently Layer 76.
|
|
|
|
- **Fast**: Pyrogram critical parts are boosted up by `TgCrypto`_, a high-performance Crypto Library written in pure C.
|
|
|
|
- **Documented**: Pyrogram API methods are documented and resemble the well established Telegram Bot API,
|
|
thus offering a familiar look to Bot developers.
|
|
|
|
- **Full API support**: Beside the simple Bot API-like methods, Pyrogram also provides an easy access to every single
|
|
Telegram MTProto API method allowing you to programmatically execute any action an official client is able to do, and more.
|
|
|
|
To get started, press the Next button.
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
:caption: Getting Started
|
|
|
|
start/QuickInstallation
|
|
start/ProjectSetup
|
|
start/BasicUsage
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
:caption: Resources
|
|
|
|
resources/TextFormatting
|
|
resources/UpdateHandling
|
|
resources/ErrorHandling
|
|
resources/SOCKS5Proxy
|
|
resources/AutoAuthorization
|
|
resources/TgCrypto
|
|
resources/BotsInteraction
|
|
|
|
.. 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/
|