Pure Python 3 MTProto API Telegram client library, for bots too!
Go to file
2018-06-12 19:46:37 +02:00
.github Be more strict in the ISSUE_TEMPLATE 2018-04-26 19:00:45 +02:00
api Added custom errors, fixes to code generator 2016-09-05 18:35:12 +02:00
readthedocs Revert 9db9d1e's count and fix typo 2018-06-03 15:20:52 +02:00
telethon Fix setting Pong results 2018-06-12 19:46:37 +02:00
telethon_examples Update examples 2018-05-24 10:58:42 +02:00
telethon_generator Make TelegramBareClient able to invoke requests 2018-06-09 21:03:48 +02:00
telethon_tests Update usage of deprecated methods in the docs 2018-04-25 09:55:34 +02:00
.gitignore Fix import errors for the documentation generator 2018-04-14 21:15:58 +02: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 Remove SQLAlchemy session 2018-03-17 17:38:16 +01:00
README.rst Several documentation fixes/additions (#750) 2018-04-08 14:15:26 +02: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 Show invalid bot methods in the docs 2018-06-06 17:35:06 +02: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_messages('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.