mirror of
https://github.com/LonamiWebs/Telethon.git
synced 2024-11-22 17:36:34 +03:00
133 lines
3.3 KiB
ReStructuredText
133 lines
3.3 KiB
ReStructuredText
.. 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.
|
|
|
|
====================================
|
|
Welcome to Telethon's documentation!
|
|
====================================
|
|
|
|
|
|
Pure Python 3 Telegram client library.
|
|
Official Site `here <https://lonamiwebs.github.io/Telethon>`_.
|
|
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::
|
|
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`.
|
|
|
|
The mentioned :ref:`telethon-client` is an important section and it
|
|
contains the friendly methods that **you should use** most of the time.
|
|
|
|
|
|
.. note::
|
|
The library uses `asyncio <https://docs.python.org/3/library/asyncio.html>`_
|
|
by default, but you if you don't know how to use ``asyncio`` you can use
|
|
`a simpler version <https://github.com/LonamiWebs/Telethon/tree/sync>`_
|
|
(select the "sync" version in ``readthedocs``' bottom left corner).
|
|
|
|
However, **you are encouraged to use asyncio**, it will make your scripts
|
|
faster and more powerful. :ref:`asyncio-crash-course` will teach you why
|
|
``asyncio`` is good and how to use it.
|
|
|
|
|
|
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.
|
|
|
|
|
|
.. _installation-and-usage:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Installation and Simple Usage
|
|
|
|
extra/basic/getting-started
|
|
extra/basic/installation
|
|
extra/basic/asyncio-crash-course
|
|
extra/basic/creating-a-client
|
|
extra/basic/telegram-client
|
|
extra/basic/entities
|
|
extra/basic/working-with-updates
|
|
|
|
|
|
.. _Advanced-usage:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Advanced Usage
|
|
|
|
extra/advanced-usage/accessing-the-full-api
|
|
extra/advanced-usage/sessions
|
|
extra/advanced-usage/update-modes
|
|
|
|
|
|
.. _Examples:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Examples
|
|
|
|
extra/examples/working-with-messages
|
|
extra/examples/chats-and-channels
|
|
extra/examples/users
|
|
extra/examples/bots
|
|
extra/examples/projects-using-telethon
|
|
|
|
|
|
.. _Troubleshooting:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Troubleshooting
|
|
|
|
extra/troubleshooting/enable-logging
|
|
extra/troubleshooting/deleted-limited-or-deactivated-accounts
|
|
extra/troubleshooting/rpc-errors
|
|
|
|
|
|
.. _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
|
|
|
|
|
|
.. _More:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: More
|
|
|
|
extra/changelog
|
|
extra/wall-of-shame.rst
|
|
|
|
|
|
.. toctree::
|
|
:caption: Telethon modules
|
|
|
|
modules
|
|
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|