2017-11-19 19:56:05 +03:00
|
|
|
.. Telethon documentation master file, created by
|
|
|
|
|
sphinx-quickstart on Fri Nov 17 15:36:11 2017.
|
|
|
|
|
You can adapt this file completely to your liking, but it should at least
|
|
|
|
|
contain the root `toctree` directive.
|
|
|
|
|
|
2018-01-05 02:59:53 +03:00
|
|
|
====================================
|
2017-11-19 19:56:05 +03:00
|
|
|
Welcome to Telethon's documentation!
|
|
|
|
|
====================================
|
|
|
|
|
|
|
|
|
|
|
2018-01-05 02:59:53 +03:00
|
|
|
Pure Python 3 Telegram client library.
|
|
|
|
|
Official Site `here <https://lonamiwebs.github.io/Telethon>`_.
|
2018-01-20 13:47:17 +03:00
|
|
|
Please follow the links on the index below to navigate from here,
|
|
|
|
|
or use the menu on the left. Remember to read the :ref:`changelog`
|
|
|
|
|
when you upgrade!
|
|
|
|
|
|
|
|
|
|
.. important::
|
2018-06-25 22:14:58 +03:00
|
|
|
If you're new here, you want to read :ref:`getting-started`. If you're
|
|
|
|
|
looking for the method reference, you should check :ref:`telethon-client`.
|
2017-11-19 19:56:05 +03:00
|
|
|
|
2018-06-25 22:14:58 +03:00
|
|
|
The mentioned :ref:`telethon-client` is an important section and it
|
|
|
|
|
contains the friendly methods that **you should use** most of the time.
|
2018-05-17 13:00:22 +03:00
|
|
|
|
2017-11-19 19:56:05 +03:00
|
|
|
|
2018-06-21 22:54:54 +03:00
|
|
|
.. note::
|
2018-06-25 22:14:58 +03:00
|
|
|
The library uses `asyncio <https://docs.python.org/3/library/asyncio.html>`_
|
|
|
|
|
under the hood, but you don't need to know anything about it unless you're
|
|
|
|
|
going to work with updates! If you're an user of Telethon pre-1.0 and you
|
|
|
|
|
aren't ready to convert your event handlers into ``async``, you can use
|
|
|
|
|
`a simpler version <https://github.com/LonamiWebs/Telethon/tree/sync>`_
|
|
|
|
|
(select the "sync" version in ``readthedocs``' bottom left corner).
|
2018-06-21 22:54:54 +03:00
|
|
|
|
2018-06-25 22:14:58 +03:00
|
|
|
If you used Telethon pre-1.0 but your scripts don't use updates or threads,
|
|
|
|
|
running ``import telethon.sync`` should make them Just Work. Otherwise,
|
|
|
|
|
we have :ref:`asyncio-magic` to teach you why ``asyncio`` is good and
|
|
|
|
|
how to use it.
|
2018-06-21 22:54:54 +03:00
|
|
|
|
|
|
|
|
|
2018-01-09 20:04:51 +03:00
|
|
|
What is this?
|
|
|
|
|
*************
|
|
|
|
|
|
|
|
|
|
Telegram is a popular messaging application. This library is meant
|
|
|
|
|
to make it easy for you to write Python programs that can interact
|
|
|
|
|
with Telegram. Think of it as a wrapper that has already done the
|
|
|
|
|
heavy job for you, so you can focus on developing an application.
|
|
|
|
|
|
|
|
|
|
|
2017-11-20 07:12:31 +03:00
|
|
|
.. _installation-and-usage:
|
|
|
|
|
|
2017-11-19 19:56:05 +03:00
|
|
|
.. toctree::
|
2017-11-20 07:12:31 +03:00
|
|
|
:maxdepth: 2
|
|
|
|
|
:caption: Installation and Simple Usage
|
|
|
|
|
|
|
|
|
|
extra/basic/getting-started
|
|
|
|
|
extra/basic/installation
|
|
|
|
|
extra/basic/creating-a-client
|
2018-01-05 02:59:53 +03:00
|
|
|
extra/basic/telegram-client
|
|
|
|
|
extra/basic/entities
|
2018-06-25 22:14:58 +03:00
|
|
|
extra/basic/asyncio-magic
|
2017-11-20 07:12:31 +03:00
|
|
|
extra/basic/working-with-updates
|
|
|
|
|
|
2017-11-19 19:56:05 +03:00
|
|
|
|
2017-11-20 07:12:31 +03:00
|
|
|
.. _Advanced-usage:
|
2017-11-19 19:56:05 +03:00
|
|
|
|
|
|
|
|
.. toctree::
|
2017-11-20 07:12:31 +03:00
|
|
|
:maxdepth: 2
|
|
|
|
|
:caption: Advanced Usage
|
2017-11-19 19:56:05 +03:00
|
|
|
|
2018-01-05 02:59:53 +03:00
|
|
|
extra/advanced-usage/accessing-the-full-api
|
|
|
|
|
extra/advanced-usage/sessions
|
2018-02-09 18:41:23 +03:00
|
|
|
extra/advanced-usage/update-modes
|
2018-01-05 02:59:53 +03:00
|
|
|
|
|
|
|
|
|
|
|
|
|
.. _Examples:
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
:caption: Examples
|
|
|
|
|
|
2018-07-10 22:07:21 +03:00
|
|
|
extra/examples/telegram-client
|
2018-01-05 02:59:53 +03:00
|
|
|
extra/examples/working-with-messages
|
|
|
|
|
extra/examples/chats-and-channels
|
2018-04-15 15:04:58 +03:00
|
|
|
extra/examples/users
|
2018-01-05 02:59:53 +03:00
|
|
|
extra/examples/bots
|
2018-04-06 20:00:21 +03:00
|
|
|
extra/examples/projects-using-telethon
|
2017-11-20 07:12:31 +03:00
|
|
|
|
|
|
|
|
|
|
|
|
|
.. _Troubleshooting:
|
2017-11-19 19:56:05 +03:00
|
|
|
|
|
|
|
|
.. toctree::
|
2017-11-20 07:12:31 +03:00
|
|
|
:maxdepth: 2
|
|
|
|
|
:caption: Troubleshooting
|
|
|
|
|
|
|
|
|
|
extra/troubleshooting/enable-logging
|
|
|
|
|
extra/troubleshooting/deleted-limited-or-deactivated-accounts
|
|
|
|
|
extra/troubleshooting/rpc-errors
|
|
|
|
|
|
|
|
|
|
|
2018-01-05 02:59:53 +03:00
|
|
|
.. _Developing:
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
:caption: Developing
|
|
|
|
|
|
|
|
|
|
extra/developing/philosophy.rst
|
|
|
|
|
extra/developing/api-status.rst
|
|
|
|
|
extra/developing/test-servers.rst
|
|
|
|
|
extra/developing/project-structure.rst
|
|
|
|
|
extra/developing/coding-style.rst
|
|
|
|
|
extra/developing/understanding-the-type-language.rst
|
|
|
|
|
extra/developing/tips-for-porting-the-project.rst
|
|
|
|
|
extra/developing/telegram-api-in-other-languages.rst
|
|
|
|
|
|
|
|
|
|
|
2018-01-20 13:47:17 +03:00
|
|
|
.. _More:
|
2018-01-05 02:59:53 +03:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
2018-01-20 13:47:17 +03:00
|
|
|
:caption: More
|
2018-01-05 02:59:53 +03:00
|
|
|
|
2018-01-20 13:47:17 +03:00
|
|
|
extra/changelog
|
2018-01-05 02:59:53 +03:00
|
|
|
extra/wall-of-shame.rst
|
|
|
|
|
|
2017-11-20 07:12:31 +03:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:caption: Telethon modules
|
|
|
|
|
|
2018-01-20 13:47:17 +03:00
|
|
|
modules
|
2017-11-19 19:56:05 +03:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Indices and tables
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
|
* :ref:`modindex`
|
|
|
|
|
* :ref:`search`
|
