mir/pyrogram
2
0
Fork 0
mirror of https://github.com/pyrogram/pyrogram synced 2025-08-29 13:27:47 +00:00
Code Issues Releases Wiki Activity

Update README.rst

Browse Source
This commit is contained in:
Dan 2019-02-04 13:04:57 +01:00 committed by GitHub
parent c213118a74
commit aa47b72155
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.rst
View File

@ -3,8 +3,6 @@
Pyrogram Pyrogram
======== ========
`A fully asynchronous variant is also available! <https://github.com/pyrogram/pyrogram/issues/181>`_
.. code-block:: python .. code-block:: python
from pyrogram import Client, Filters from pyrogram import Client, Filters
@ -20,17 +18,19 @@ Pyrogram
app.run() app.run()
**Pyrogram** is an elegant, easy-to-use Telegram_ client library and framework written from the ground up in Python and C. **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 build custom Telegram applications that interact with the MTProto API as both user and bot. It enables you to easily create custom apps using both user and bot identities (bot API alternative) via the `MTProto API`_.
`A fully-asynchronous variant is also available » <https://github.com/pyrogram/pyrogram/issues/181>`_
Features Features
-------- --------
- **Easy**: You can install Pyrogram with pip and start building your app right away. - **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. - **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. - **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. - **Documented**: Pyrogram API methods, types and public interfaces are well documented.
- **Type-hinted**: Exposed Pyrogram types and method parameters are all type-hinted. - **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. - **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. - **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. - **Comprehensive**: Execute any advanced action an official client is able to do, and even more.
@ -47,8 +47,8 @@ Installing
pip3 install pyrogram pip3 install pyrogram
Getting Started Resources
--------------- ---------
- The Docs contain lots of resources to help you getting started with Pyrogram: https://docs.pyrogram.ml. - The Docs contain lots of resources to help you getting started with Pyrogram: https://docs.pyrogram.ml.
- Reading `Examples in this repository`_ is also a good way for learning how Pyrogram works. - Reading `Examples in this repository`_ is also a good way for learning how Pyrogram works.
@ -69,6 +69,7 @@ Copyright & License
- Licensed under the terms of the `GNU Lesser General Public License v3 or later (LGPLv3+)`_ - Licensed under the terms of the `GNU Lesser General Public License v3 or later (LGPLv3+)`_
.. _`Telegram`: https://telegram.org/ .. _`Telegram`: https://telegram.org/
.. _`MTProto API`: https://core.telegram.org/api#telegram-api
.. _`Telegram API key`: https://docs.pyrogram.ml/start/ProjectSetup#api-keys .. _`Telegram API key`: https://docs.pyrogram.ml/start/ProjectSetup#api-keys
.. _`Community`: https://t.me/PyrogramChat .. _`Community`: https://t.me/PyrogramChat
.. _`Examples in this repository`: https://github.com/pyrogram/pyrogram/tree/master/examples .. _`Examples in this repository`: https://github.com/pyrogram/pyrogram/tree/master/examples
@ -76,6 +77,7 @@ Copyright & License
.. _`Email`: admin@pyrogram.ml .. _`Email`: admin@pyrogram.ml
.. _`Message`: https://t.me/haskell .. _`Message`: https://t.me/haskell
.. _TgCrypto: https://github.com/pyrogram/tgcrypto .. _TgCrypto: https://github.com/pyrogram/tgcrypto
.. _`MTProto 2.0`: https://core.telegram.org/mtproto
.. _`GNU Lesser General Public License v3 or later (LGPLv3+)`: COPYING.lesser .. _`GNU Lesser General Public License v3 or later (LGPLv3+)`: COPYING.lesser
.. |header| raw:: html .. |header| raw:: html