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

Add more and clearer examples in the Usage.rst page

Browse Source
This commit is contained in:
Dan 2018-10-14 11:59:33 +02:00
parent 3659ea82fb
commit d03f04a560
1 changed files with 44 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

87
docs/source/start/Usage.rst
View File

@ -10,25 +10,36 @@ High-level API
The easiest and recommended way to interact with Telegram is via the high-level Pyrogram methods_ and types_, which are The easiest and recommended way to interact with Telegram is via the high-level Pyrogram methods_ and types_, which are
named after the `Telegram Bot API`_. named after the `Telegram Bot API`_.
Examples (more on `GitHub <https://github.com/pyrogram/pyrogram/tree/develop/examples>`_): Here's a simple example:
- Get information about the authorized user:
.. code-block:: python .. code-block:: python
from pyrogram import Client
app = Client("my_account")
app.start()
print(app.get_me()) print(app.get_me())
app.send_message("me", "Hi there! I'm using **Pyrogram**")
app.send_location("me", 51.500729, -0.124583)
- Send a message to yourself (Saved Messages): app.stop()
You can also use the Client instance in a context manager with the ``with`` statement:
.. code-block:: python .. code-block:: python
app.send_message("me", "Hi there! I'm using Pyrogram") from pyrogram import Client
- Upload a new photo (with caption): app = Client("my_account")
.. code-block:: python with app:
print(app.get_me())
app.send_message("me", "Hi there! I'm using **Pyrogram**")
app.send_location("me", 51.500729, -0.124583)
app.send_photo("me", "/home/dan/perla.jpg", "Cute!") More examples on `GitHub <https://github.com/pyrogram/pyrogram/tree/develop/examples>`_.
Raw Functions Raw Functions
------------- -------------
@ -38,7 +49,9 @@ you have to use the raw :mod:`functions <pyrogram.api.functions>` and :mod:`type
``pyrogram.api`` package and call any Telegram API method you wish using the :meth:`send() <pyrogram.Client.send>` ``pyrogram.api`` package and call any Telegram API method you wish using the :meth:`send() <pyrogram.Client.send>`
method provided by the Client class. method provided by the Client class.
.. hint:: Every high-level method mentioned in the section above is built on top of these raw functions. .. hint::
Every high-level method mentioned in the section above is built on top of these raw functions.
Nothing stops you from using the raw functions only, but they are rather complex and `plenty of them`_ are already Nothing stops you from using the raw functions only, but they are rather complex and `plenty of them`_ are already
re-implemented by providing a much simpler and cleaner interface which is very similar to the Bot API. re-implemented by providing a much simpler and cleaner interface which is very similar to the Bot API.
@ -54,17 +67,13 @@ Examples (more on `GitHub <https://github.com/pyrogram/pyrogram/tree/develop/exa
from pyrogram import Client from pyrogram import Client
from pyrogram.api import functions from pyrogram.api import functions
app = Client("my_account") with Client("my_account") as app:
app.start() app.send(
functions.account.UpdateProfile(
app.send( first_name="Dan", last_name="Tès",
functions.account.UpdateProfile( about="Bio written from Pyrogram"
first_name="Dan", last_name="Tès", )
about="Bio written from Pyrogram"
) )
)
app.stop()
- Share your Last Seen time only with your contacts: - Share your Last Seen time only with your contacts:
@ -73,17 +82,13 @@ Examples (more on `GitHub <https://github.com/pyrogram/pyrogram/tree/develop/exa
from pyrogram import Client from pyrogram import Client
from pyrogram.api import functions, types from pyrogram.api import functions, types
app = Client("my_account") with Client("my_account") as app:
app.start() app.send(
functions.account.SetPrivacy(
app.send( key=types.InputPrivacyKeyStatusTimestamp(),
functions.account.SetPrivacy( rules=[types.InputPrivacyValueAllowContacts()]
key=types.InputPrivacyKeyStatusTimestamp(), )
rules=[types.InputPrivacyValueAllowContacts()]
) )
)
app.stop()
- Invite users to your channel/supergroup: - Invite users to your channel/supergroup:
@ -92,21 +97,17 @@ Examples (more on `GitHub <https://github.com/pyrogram/pyrogram/tree/develop/exa
from pyrogram import Client from pyrogram import Client
from pyrogram.api import functions, types from pyrogram.api import functions, types
app = Client("my_account") with Client("my_account") as app:
app.start() app.send(
functions.channels.InviteToChannel(
app.send( channel=app.resolve_peer(123456789), # ID or Username
functions.channels.InviteToChannel( users=[ # The users you want to invite
channel=app.resolve_peer(123456789), # ID or Username app.resolve_peer(23456789), # By ID
users=[ # The users you want to invite app.resolve_peer("username"), # By username
app.resolve_peer(23456789), # By ID app.resolve_peer("393281234567"), # By phone number
app.resolve_peer("username"), # By username ]
app.resolve_peer("393281234567"), # By phone number )
]
) )
)
app.stop()
.. _methods: ../pyrogram/Client.html#messages .. _methods: ../pyrogram/Client.html#messages
.. _plenty of them: ../pyrogram/Client.html#messages .. _plenty of them: ../pyrogram/Client.html#messages