Pure Python 3 MTProto API Telegram client library, for bots too!
Go to file
Lonami Exo f8264abb5a Clean-up client's __init__ and remove entity cache
Entity cache uses are removed. It was a source of ever-growing memory
usage that has to be reworked. This affects everything that tried to
obtain an input entity, input sender or input chat (such as the
SenderGetter or calls to _get_entity_pair). Input entities need to be
reworked in any case.

Its removal also affects the automatic cache of any raw API request.

Raise last error parameter is removed, and its behaviour made default.

The connection type parameter has been removed, since users really have
no need to change it.

A few more attributes have been made private, since users should not
mess with those.
2022-01-18 12:56:17 +01:00
.github Bump minimum required Python version to 3.7 2022-01-09 13:00:45 +01:00
readthedocs Clean-up client's __init__ and remove entity cache 2022-01-18 12:56:17 +01:00
telethon Clean-up client's __init__ and remove entity cache 2022-01-18 12:56:17 +01:00
telethon_examples Get rid of client.loop 2022-01-16 13:51:23 +01:00
telethon_generator Document new known errors 2022-01-16 12:01:18 +01:00
tests Fix imports 2021-09-12 13:27:13 +02:00
.coveragerc Add example unit test and config for testing 2019-12-07 04:23:27 +01:00
.gitignore Completely overhaul errors to be generated dynamically 2021-09-24 20:12:00 +02:00
.pre-commit-config.yaml Add pre-commit hooks configuration 2016-11-30 00:29:05 +03:00
dev-requirements.txt Add example unit test and config for testing 2019-12-07 04:23:27 +01:00
LICENSE Update proxy docs and license year 2021-02-12 17:56:46 +01:00
logo.svg Use better practices for logo's svg 2018-06-26 10:12:00 +02:00
optional-requirements.txt Replace PySocks with python-socks for Python >= 3.6 2020-11-09 19:59:54 +01:00
pyproject.toml Bump minimum required Python version to 3.7 2022-01-09 13:00:45 +01:00
README.rst Remove sync hack 2021-09-11 14:06:36 +02:00
requirements.txt Use a proper markdown parser 2021-09-25 20:33:25 +02:00
setup.py Bump minimum required Python version to 3.7 2022-01-09 13:00:45 +01:00
update-docs.sh Add set -e to update-docs.sh 2020-10-01 12:23:38 +02:00

Telethon
========
.. epigraph::

  ⭐️ Thanks **everyone** who has starred the project, it means a lot!

|logo| **Telethon** is an asyncio_ **Python 3**
MTProto_ library to interact with Telegram_'s API
as a user or through a bot account (bot API alternative).

.. important::

    If you have code using Telethon before its 1.0 version, you must
    read `Compatibility and Convenience`_ to learn how to migrate.

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.


Installing
----------

.. code-block:: sh

  pip3 install telethon


Creating a client
-----------------

.. code-block:: python

    import asyncio
    from telethon import TelegramClient, events

    # These example values won't work. You must get your own api_id and
    # api_hash from https://my.telegram.org, under API Development.
    api_id = 12345
    api_hash = '0123456789abcdef0123456789abcdef'

    async def main():
      client = TelegramClient('session_name', api_id, api_hash)
      await client.start()

    asyncio.run(main())


Doing stuff
-----------

.. code-block:: python

    print((await client.get_me()).stringify())

    await client.send_message('username', 'Hello! Talking to you from Telethon')
    await client.send_file('username', '/home/myself/Pictures/holidays.jpg')

    await client.download_profile_photo('me')
    messages = await client.get_messages('username')
    await messages[0].download_media()

    @client.on(events.NewMessage(pattern='(?i)hi|hello'))
    async def handler(event):
        await event.respond('Hey!')


Next steps
----------

Do you like how Telethon looks? Check out `Read The Docs`_ for a more
in-depth explanation, with examples, troubleshooting issues, and more
useful information.

.. _asyncio: https://docs.python.org/3/library/asyncio.html
.. _MTProto: https://core.telegram.org/mtproto
.. _Telegram: https://telegram.org
.. _Compatibility and Convenience: https://docs.telethon.dev/en/latest/misc/compatibility-and-convenience.html
.. _Read The Docs: https://docs.telethon.dev

.. |logo| image:: logo.svg
    :width: 24pt
    :height: 24pt