2
0
mirror of https://github.com/pyrogram/pyrogram synced 2025-09-01 06:45:39 +00:00

Update docs

This commit is contained in:
Dan
2018-04-12 13:43:16 +02:00
parent 70cd0500de
commit 1ccda820c1
4 changed files with 67 additions and 35 deletions

View File

@@ -11,7 +11,7 @@ Simple API Access
The easiest way to interact with the Telegram API is via the :class:`Client <pyrogram.Client>` class,
which exposes bot-like_ methods. The purpose of this Client class is to make it even simpler to work with the
API by abstracting the raw functions listed in the scheme.
API by abstracting the raw functions listed in the schema.
The result is a much cleaner interface that allows you to:

View File

@@ -21,28 +21,28 @@ Configuration
There are two ways to configure a Pyrogram application project, and you can choose the one that fits better for you:
- Create a new ``config.ini`` file at the root of your working directory, copy-paste the following and replace the
**api_id** and **api_hash** values with `your own <#api-keys>`_. This is the preferred method because allows you
to keep your credentials out of your code without having to deal with how to load them:
Create a new ``config.ini`` file at the root of your working directory, copy-paste the following and replace the
**api_id** and **api_hash** values with `your own <#api-keys>`_. This is the preferred method because allows you
to keep your credentials out of your code without having to deal with how to load them:
.. code-block:: ini
.. code-block:: ini
[pyrogram]
api_id = 12345
api_hash = 0123456789abcdef0123456789abcdef
[pyrogram]
api_id = 12345
api_hash = 0123456789abcdef0123456789abcdef
- Alternatively, you can pass your API key to Pyrogram by simply using the *api_id* and *api_hash*
parameters of the Client class. This way you can have full control on how to store and load your credentials:
Alternatively, you can pass your API key to Pyrogram by simply using the *api_id* and *api_hash*
parameters of the Client class. This way you can have full control on how to store and load your credentials:
.. code-block:: python
.. code-block:: python
from pyrogram import Client
from pyrogram import Client
client = Client(
session_name="example",
api_id=12345
api_hash="0123456789abcdef0123456789abcdef"
)
client = Client(
session_name="example",
api_id=12345
api_hash="0123456789abcdef0123456789abcdef"
)
.. note:: The examples below assume you have created a ``config.ini`` file, thus they won't show the *api_id*
and *api_hash* parameters usage.
@@ -53,7 +53,7 @@ User Authorization
In order to use the API, Telegram requires that Users be authorized via their phone numbers.
Pyrogram automatically manages this access, all you need to do is create an instance of
the :class:`Client <pyrogram.Client>` class by passing to it a ``<session_name>`` of your choice
(e.g.: "my_account") and call the :meth:`start <pyrogram.Client.start>` method:
(e.g.: "my_account") and call the :meth:`start() <pyrogram.Client.start>` method:
.. code-block:: python
@@ -81,7 +81,9 @@ Bot Authorization
-----------------
Being written entirely from the ground up, Pyrogram is also able to authorize Bots.
This means that you can use Pyrogram to execute API calls with a Bot identity.
Bots are a special kind of users which also make use of MTProto. This means that you can use Pyrogram to
execute API calls with a Bot identity.
Instead of phone numbers, Bots are authorized via their tokens which are created by BotFather_:
.. code-block:: python
@@ -91,6 +93,8 @@ Instead of phone numbers, Bots are authorized via their tokens which are created
client = Client("123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11")
client.start()
That's all, no further action is needed. The session file created will be named after the Bot user_id, which is
``123456.session`` in the example above.
.. _`Country Code`: https://en.wikipedia.org/wiki/List_of_country_calling_codes
.. _BotFather: https://t.me/botfather