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

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

**Telethon** is Telegram client implementation in **Python 3** which uses
the latest available API of Telegram.


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:: sh

  pip3 install telethon


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

.. code:: python

  from telethon import TelegramClient

  # 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:: python

  # Getting information about yourself
  print(client.get_me().stringify())

  # Sending a message (you can use 'me' or 'self' to message yourself)
  client.send_message('username', 'Hello World from Telethon!')

  # Sending a file
  client.send_file('username', '/home/myself/Pictures/holidays.jpg')

  # Retrieving messages from a chat
  from telethon import utils
  for message in client.get_message_history('username', limit=10):
      print(utils.get_display_name(message.sender), message.message)

  # Listing all the dialogs (conversations you have open)
  for dialog in client.get_dialogs(limit=10):
      print(utils.get_display_name(dialog.entity), dialog.draft.message)

  # Downloading profile photos (default path is the working directory)
  client.download_profile_photo('username')

  # Once you have a message with .media (if message.media)
  # you can download it using client.download_media():
  messages = client.get_message_history('username')
  client.download_media(messages[0])


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

Do you like how Telethon looks? Check out
`Read The Docs <http://telethon.rtfd.io/>`_
for a more in-depth explanation, with examples,
troubleshooting issues, and more useful information.