Pure Python 3 MTProto API Telegram client library, for bots too!
Go to file
Lonami Exo 7e9d19d727 Add known entities to all updates and use them in the events
This should reduce the amount of API calls made when getting the
full sender/chat on events (mostly on channels, where Telegram
seems to always send Updates instead only a normal Update).
2018-03-14 10:28:21 +01:00
.github More friendly issue template 2017-09-28 12:20:56 +02:00
api Added custom errors, fixes to code generator 2016-09-05 18:35:12 +02:00
docs Automatically redirect on documentation for exact matches 2018-03-10 11:52:31 +01:00
readthedocs Update to v0.18 2018-03-04 12:03:09 +01:00
telethon Add known entities to all updates and use them in the events 2018-03-14 10:28:21 +01:00
telethon_examples Upgrade to layer 75 2018-03-02 21:28:33 +01:00
telethon_generator Add Python type hints to attributes of TL types (#678) 2018-03-12 10:58:56 +01:00
telethon_tests Move utils.calc_msg_key into auth_key (cyclic imports py3.4) 2018-01-08 12:07:14 +01:00
.gitignore Update .gitignore to include docs/_build 2017-11-21 12:56:53 +01:00
.pre-commit-config.yaml Add pre-commit hooks configuration 2016-11-30 00:29:05 +03:00
LICENSE Updated README.md 2016-09-10 14:10:47 +02:00
MANIFEST.in Changed README.md to README.rst 2016-11-13 15:39:47 +01:00
optional-requirements.txt Add SQLAlchemy-based session 2018-03-02 13:22:30 +02:00
README.rst Avoid using undefined variable in the README.rst 2018-03-01 13:25:38 +01:00
requirements.txt Add Python type hints to attributes of TL types (#678) 2018-03-12 10:58:56 +01:00
run_tests.py Make lint happier 2017-09-04 17:10:04 +02:00
setup.py Add Python type hints to attributes of TL types (#678) 2018-03-12 10:58:56 +01:00
try_telethon.py Support configuring SOCKS proxy in the example 2017-06-17 00:17:51 +02:00

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

  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_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.