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_messages('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.19.0.6.tar.gz (749.8 kB view details)

Uploaded Source

Built Distribution

Telethon_aio-0.19.0.6-py3-none-any.whl (304.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for Telethon-aio-0.19.0.6.tar.gz
Algorithm Hash digest
SHA256 293fcbcf5ed48ebf43ddbe3d1c110845c3989504b98968dae86ac929ec1d04ac
MD5 0cd70087292068d1ed2da0458f1554a7
BLAKE2b-256 612bc75c3aef7769b3fd90cde82f01c77a632883bb21415c19ec15468d5c2c82

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Telethon_aio-0.19.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 0a27f18dbae8abc00c704f6db2e4580324ec4f28c486abf812f1cdd02f663336
MD5 52924e066bf3bcf97ed3f0a604e07208
BLAKE2b-256 f343278511ce232177024cc5863229c8fa816e873362e2f7661301d94b84e5e7

See more details on using hashes here.

Supported by

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