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-asyncio


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.17.4.tar.gz (362.8 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.17.4-py3-none-any.whl (267.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: Telethon-aio-0.17.4.tar.gz
  • Upload date:
  • Size: 362.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Telethon-aio-0.17.4.tar.gz
Algorithm Hash digest
SHA256 09f6047b17116ba54f740b7c51baeceb5978eb54b04e6efefe506357c7615cb9
MD5 5557863f11117582304775ec824bc17e
BLAKE2b-256 4a56be0fa69ef48882d30a74ba85e79b3f577bad51e4e99299c3251bcd52219c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Telethon_aio-0.17.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b61b79459f06f22844774052352a7ca4ca65661cd9e47a23d93b2207503f92cf
MD5 c231c21368f87382d98f000d2477a7cd
BLAKE2b-256 3914e4fda4fb4036b4954d4f94167f84eca301be3a967ee1a464352bed559877

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