Pure Python 3 MTProto API Telegram client library, for bots too!
Go to file
Lonami Exo 9c06f29aaf Don't cache entities with min flag set, bump v1.10.2
Since layer 102, there are two access_hash. One with the min flag,
and one without it. This was causing channel invalid errors.

access_hash with min flag set can only be used to fetch files such
as profile pictures.

access_hash with min flag unset can be used under all circumstances.

Previously, the library did not distinguish between these, so it was
caching the hash that could hardly be used for anything.

With this change, only the "full" access_hash is stored, which will
work for any methods.

See also: https://core.telegram.org/api/min
2019-09-12 19:19:46 +02:00
.github/ISSUE_TEMPLATE Add RTFM issue template 2019-05-16 17:16:28 +02:00
nix Add v1.10.1 to .nix files 2019-09-10 21:38:46 +02:00
readthedocs Fix events.Album and minor docs nit, bump to v1.10.1 2019-09-09 19:21:03 +02:00
telethon Don't cache entities with min flag set, bump v1.10.2 2019-09-12 19:19:46 +02:00
telethon_examples Improve Quart example (#1229) 2019-08-01 19:15:04 +02:00
telethon_generator Add new known errors (#1265) 2019-09-10 21:09:43 +02:00
.gitignore Create Nix package expressions (#1246) 2019-07-30 15:31:53 +02:00
.pre-commit-config.yaml Add pre-commit hooks configuration 2016-11-30 00:29:05 +03:00
default.nix Add v1.10.1 to .nix files 2019-09-10 21:38:46 +02:00
LICENSE Tidy examples and update licenses 2019-01-07 15:48:25 +01:00
logo.svg Use better practices for logo's svg 2018-06-26 10:12:00 +02:00
MANIFEST.in Changed README.md to README.rst 2016-11-13 15:39:47 +01:00
optional-requirements.txt Further document automatic photo resizing 2019-02-13 09:58:02 +01:00
README.rst Point to the new domains 2019-05-22 11:29:46 +02:00
requirements.txt Remove async_generator from dependencies 2019-02-27 11:13:29 +01:00
setup.py Clean-up usage of root directory in docs generation 2019-07-17 10:11:52 +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

    from telethon import TelegramClient, events, sync

    # 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'

    client = TelegramClient('session_name', api_id, api_hash)
    client.start()


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

.. code-block:: python

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

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

    client.download_profile_photo('me')
    messages = client.get_messages('username')
    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