Pure Python 3 MTProto API Telegram client library, for bots too!
Go to file
2018-01-05 17:59:36 +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 Clean up some more twirks on RTD and update docstrings 2018-01-05 13:30:21 +01:00
telethon Merge branch 'master' into asyncio 2018-01-05 17:59:36 +01:00
telethon_examples fix get_dialogs() return type in example 2018-01-04 12:03:29 +01:00
telethon_generator Update to layer 74 2018-01-02 00:02:31 +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 Merge branch 'master' into asyncio 2018-01-05 17:59:36 +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

  import asyncio
  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)
  async def main():
      await client.connect()
      # Skip this if you already have a previous 'session_name.session' file
      await client.sign_in(phone_number)
      me = await client.sign_in(code=input('Code: '))

  asyncio.get_event_loop().run_until_complete(main())

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

Note that this assumes you're inside an "async def" method. Check out the
`Python documentation <https://docs.python.org/3/library/asyncio-dev.html>`_
if you're new with ``asyncio``.

.. code:: python

  print(me.stringify())

  await client.send_message('username', 'Hello! Talking to you from Telethon')
  await client.send_file('username', '/home/myself/Pictures/holidays.jpg')

  await client.download_profile_photo(me)
  messages = await client.get_message_history('username')
  await 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. Note that the examples there are written for
the threaded version, not the one using asyncio. However, you just need to
await every remote call.