Pure Python 3 MTProto API Telegram client library, for bots too!
Go to file
2017-12-28 16:25:41 +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 Make exception types correspond to Python docs 2017-12-28 09:48:02 +10:00
readthedocs Fix typo in sessions.rst (#491) 2017-12-14 12:16:57 +01:00
telethon Fix session table may be empty if no DC switch 2017-12-28 14:58:42 +01:00
telethon_examples Clear up confusing error and trailing brace (closes #429) 2017-11-14 09:48:40 +01:00
telethon_generator Support more types to represent a date 2017-12-28 12:32:16 +01:00
telethon_tests Save dc_id instead layer and salt in the session file 2017-12-28 01:06:27 +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
README.rst Update README.rst 2017-12-28 16:25:41 +01:00
run_tests.py Make lint happier 2017-09-04 17:10:04 +02:00
setup.py Assert that module was generated correctly on setup.py pypi 2017-11-29 12:34:15 +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. Remember to use **pip3** to install!

Installing
----------

.. code:: sh

  pip 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'
  phone = '+34600000000'

  client = TelegramClient('session_name', api_id, api_hash)
  client.connect()

  # If you already have a previous 'session_name.session' file, skip this.
  client.sign_in(phone=phone)
  me = client.sign_in(code=77777)  # Put whatever code you received here.


Doing stuff
-----------

.. code:: python

  print(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 the
`wiki over GitHub <https://github.com/LonamiWebs/Telethon/wiki>`_ for a
more in-depth explanation, with examples, troubleshooting issues, and more
useful information.