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_aio 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.0.3.tar.gz (718.5 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.0.3-py3-none-any.whl (269.7 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for Telethon-aio-0.18.0.3.tar.gz
Algorithm Hash digest
SHA256 6595cf2d74963b6aa1ca9509dc9c85d0e7172cb7efc39f7e992315e310773680
MD5 ae199eac214c654542190d843ed185a9
BLAKE2b-256 81d5bb2c3e1b6ce244bd859f9989d3685411fce0dadab701bd7673ef51942735

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Telethon_aio-0.18.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f8bb18abf29a9bcf2e3c5ce299ea7cd6bd17a307e49d3fcea445047d4c64e4ea
MD5 0c5c4f8c0bbe356137d745648b18bfb7
BLAKE2b-256 1ee883dc5aa409a1c8fa53cef42c3c2524e2c547aa307c2640bd90c54afd5cf5

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