LonamiWebs/Telethon
1
1
Fork 0
mirror of https://github.com/LonamiWebs/Telethon.git synced 2024-09-21 03:08:49 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Lonami Exo 2017-03-20 17:34:51 +01:00
parent 350c11d66f
commit 3f24cb17c3
1 changed files with 24 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.rst
View File

@ -85,6 +85,21 @@ corresponding values (your ``api_id``, ``api_hash`` and phone number in internat
Then, simply run ``python3 try_telethon.py`` to start the interactive example. Then, simply run ``python3 try_telethon.py`` to start the interactive example.
Using Telethon
==============
If you really want to learn how to use Telethon, it is **highly adviced** that
you take a look to the
`InteractiveTelegramClient <telethon/interactive_telegram_client.py>`_ file
and check how it works. This file contains everything you'll need to build
your own application, since it shows, among other things:
1. Authorizing the user for the first time.
2. Support to enter the 2-steps-verification code.
3. Retrieving dialogs (chats) and the messages history.
4. Sending messages and files.
5. Downloading files.
6. Updates thread.
Advanced uses Advanced uses
============= =============
@ -166,24 +181,25 @@ Updating the ``scheme.tl``
-------------------------- --------------------------
Have you found a more updated version of the ``scheme.tl`` file? Those are great news! Updating is as simple Have you found a more updated version of the ``scheme.tl`` file? Those are great news! Updating is as simple
as grabbing the as grabbing the
`latest version <https://github.com/telegramdesktop/tdesktop/blob/dev/Telegram/SourceFiles/mtproto/scheme.tl>`_ `latest version <https://github.com/telegramdesktop/tdesktop/blob/dev/Telegram/Resources/scheme.tl>`_
and replacing the one you can find in this same directory by the updated one. and replacing the one you can find in this same directory by the updated one.
Don't forget to run ``python3 tl_generator.py``. Don't forget to run ``python3 tl_generator.py``.
If the changes weren't too big, everything should still work the same way as it did before; but with extra features. If the changes weren't too big, everything should still work the same way as it did before; but with extra features.
Using proxy Using a proxy
----------- -------------
If you want to use Telethon via proxy, you have to install If you want to use Telethon via proxy, you have to install
`PySocks (via pip or manual) <https://github.com/Anorov/PySocks#installation>`_ `PySocks (via pip or manual) <https://github.com/Anorov/PySocks#installation>`_.
and pass proxy settings to ``TelegramClient()`` like Once this is done, pass the proxy settings to the ``TelegramClient`` constructor:
.. code:: python .. code:: python
>>> from telethon import InteractiveTelegramClient >>> from telethon import InteractiveTelegramClient
>>> import socks >>> import socks
>>> client = InteractiveTelegramClient('sessionid', '+34600000000', >>> client = InteractiveTelegramClient('sessionid', '+34600000000',
... api_id=12345, api_hash='0123456789abcdef0123456789abcdef', proxy=(socks.SOCKS5, "localhost", 4444)) ... api_id=12345, api_hash='0123456789abcdef0123456789abcdef',
... proxy=(socks.SOCKS5, 'localhost', 4444))
``proxy`` accept a tuple, which contains exactly the same parameters as The ``proxy=`` parameter should be a tuple consisting of
`what a set_proxy method accepts <https://github.com/Anorov/PySocks#sockssocksocket>`_. ``(type, 'ip address', port)``, as described `here <https://github.com/Anorov/PySocks#sockssocksocket>`_.