Skip to main content

Full-featured Telegram client library for Python 3, modified to work under Python's asyncio module.

Project description

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

This is the ``asyncio`` version of the library. If you don't know how
to work with it, `see here https://pypi.python.org/pypi/Telethon`__.

**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-aio

.. warning::

Be careful **not** to install ``telethon-asyncio`` or other
variants, someone else name-squatted those and are unofficial!


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'

client = TelegramClient('session_name', api_id, api_hash)
async def main():
await client.start()

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((await client.get_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.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Telethon-aio-0.18.2.3.tar.gz (602.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

Telethon_aio-0.18.2.3-py3-none-any.whl (282.7 kB view details)

Uploaded Python 3

File details

Details for the file Telethon-aio-0.18.2.3.tar.gz.

File metadata

File hashes

Hashes for Telethon-aio-0.18.2.3.tar.gz
Algorithm Hash digest
SHA256 717f1abe6921c6b0617fb101c5beff6d135c7c62594771b516615469a3c99ac6
MD5 1114ef31767100ad0c44261eb62f4e61
BLAKE2b-256 94303983196f8b5f3f1f3c6e51c520ddd4f502c8774d9383b1716671855f3ac8

See more details on using hashes here.

File details

Details for the file Telethon_aio-0.18.2.3-py3-none-any.whl.

File metadata

File hashes

Hashes for Telethon_aio-0.18.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 96b4fd2f55e56e141085ca8c4c2cce78ac658e398121cec067b3baf0a83bfcf8
MD5 1a28229ea795e47735211a99fcec733a
BLAKE2b-256 0140fb2623950574b422ecd3b5590e66660b85171c4e53100b3ee94d11fcfc71

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page