Pure Python 3 MTProto API Telegram client library, for bots too!
Go to file
Lonami Exo 06f3dc3053 Revert "Update to layer 117"
This reverts commit 26ff92caa9.

Layer changes only go in minor releases, and the commit history is
linear, so temporarily revert to release a new patch version.
2020-08-24 12:53:43 +02:00
.github Improve question templates with contact links 2020-01-21 16:17:03 +01:00
nix Add v1.10.1 to .nix files 2019-09-10 21:38:46 +02:00
readthedocs Remove usage of the main group username in the docs 2020-08-23 11:45:45 +02:00
telethon Fix warning when using formatted phones in start (#1532) 2020-08-24 10:53:29 +02:00
telethon_examples Avoid explicitly passing the loop to asyncio 2020-07-25 18:39:35 +02:00
telethon_generator Revert "Update to layer 117" 2020-08-24 12:53:43 +02:00
tests Avoid another MemoryError 2020-02-28 10:42:23 +01:00
.coveragerc Add example unit test and config for testing 2019-12-07 04:23:27 +01: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
dev-requirements.txt Add example unit test and config for testing 2019-12-07 04:23:27 +01: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 Add example unit test and config for testing 2019-12-07 04:23:27 +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 Remove another debug print, bump v1.10.4 2019-09-21 18:21:09 +02:00
tox.ini Whitelist instead of blacklist in flake8 2019-12-25 12:58:09 +01:00
update-docs.sh Add a script to update online documentation 2020-07-26 13:50:48 +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