Pure Python 3 MTProto API Telegram client library, for bots too!
Go to file
Lonami Exo 559a40c7ea Fix get_input_media for InputFile
It was actually using FileLocation, which had the invalid expected
type for what was being returned. Instead it should have been this
other type.

In addition, more parameters are passed so that the method can have
all the information it needs to correctly cast the type.
2019-02-13 12:33:11 +01:00
.github Make it clearer that issues are not questions 2018-08-28 11:45:21 +02:00
readthedocs Docs: Removed mention of TcpClient from 'Project Structure' 2019-02-11 08:45:33 +10:00
telethon Fix get_input_media for InputFile 2019-02-13 12:33:11 +01:00
telethon_examples Update URLs in assistant and except message deletion errors 2019-02-12 10:48:02 +01:00
telethon_generator Further document automatic photo resizing 2019-02-13 09:58:02 +01:00
.gitignore Support async def in sessions (#1013) 2018-10-05 20:25:49 +02:00
.pre-commit-config.yaml Add pre-commit hooks configuration 2016-11-30 00:29:05 +03: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 Update documentation with takeout, add new known errors 2019-01-05 17:31:26 +01:00
requirements.txt Update to v1.3 2018-09-22 19:37:16 +02:00
setup.py Make use of pathlib nearly everywhere (breaks docs gen) 2018-12-21 13:24:16 +01: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://telethon.readthedocs.io/en/latest/extra/basic/compatibility-and-convenience.html
.. _Read The Docs: https://telethon.readthedocs.io

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