Telethon README

The project's README from github.com/LonamiWebs/Telethon. As one markdown file: README.md.

Moved to https://codeberg.org/Lonami/Telethon. The GitHub repository may be deleted in the future.

Telethon

.. epigraph::

⭐️ Thanks everyone who has starred the project, it means a lot!

|logo| Telethon is an asyncio_ Python 3 MTProto_ library to interact with Telegram_'s API as a user or through a bot account (bot API alternative).

.. important::

If you have code using Telethon before its 1.0 version, you must
read `Compatibility and Convenience`_ to learn how to migrate.
As with any third-party library for Telegram, be careful not to
break `Telegram's ToS`_ or `Telegram can ban the account`_.

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-block:: sh

pip3 install telethon

Creating a client

.. code-block:: python

from telethon import TelegramClient, events, sync

# 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)
client.start()

Doing stuff

.. code-block:: python

print(client.get_me().stringify())

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

client.download_profile_photo('me')
messages = client.get_messages('username')
messages[0].download_media()

@client.on(events.NewMessage(pattern='(?i)hi|hello'))
async def handler(event):
    await event.respond('Hey!')

Next steps

Do you like how Telethon looks? Check out Read The Docs_ for a more in-depth explanation, with examples, troubleshooting issues, and more useful information.

.. _asyncio: https://docs.python.org/3/library/asyncio.html .. _MTProto: https://core.telegram.org/mtproto .. _Telegram: https://telegram.org .. _Compatibility and Convenience: https://docs.telethon.dev/en/stable/misc/compatibility-and-convenience.html .. _Telegram's ToS: https://core.telegram.org/api/terms .. _Telegram can ban the account: https://docs.telethon.dev/en/stable/quick-references/faq.html#my-account-was-deleted-limited-when-using-the-library .. _Read The Docs: https://docs.telethon.dev

.. |logo| image:: logo.svg :width: 24pt :height: 24pt

Telethon (LonamiWebs/Telethon)

Searching Database…

12.1K ·GitHub
Telethon
archived
Что это?Telethon — это библиотека MTProto для Python 3 на основе asyncio, которая позволяет напрямую работать с API Telegram, действуя как полноценный аккаунт пользователя или как бот.
Это обёртка над Bot API от Telegram или что-то другое?Библиотека работает напрямую с нативным протоколом Telegram MTProto, а не оборачивает официальный Bot API. Работу с протоколом она берёт на себя, так что можно просто писать обычную программу на Python.
Как установить и запустить клиент?Установите командой 'pip3 install telethon', затем создайте TelegramClient с именем сессии, а также вашими api_id и api_hash, и вызовите client.start().
Нужны ли мне API ID и hash от Telegram, чтобы начать?Да, нужны собственные api_id и api_hash со страницы API Development от Telegram; примеры значений из README не будут работать.
Проект всё ещё поддерживается?Нет, репозиторий архивирован, а в README сказано, что проект переехал и в будущем может быть удалён, поэтому не ждите здесь исправлений и обновлений.
Может ли Telethon входить и как обычный пользователь, и как бот?Да, он может авторизоваться как полноценный аккаунт пользователя Telegram или как аккаунт бота, предоставляя доступ к большему, чем официальный Bot API.
Поддерживается ли обработка событий через async/await?Да, библиотека построена на asyncio и позволяет писать асинхронные обработчики, например, оформив функцию декоратором @client.on(events.NewMessage(pattern=...)), чтобы реагировать на входящие сообщения.
Есть ли риск блокировки моего аккаунта?Да, поскольку это сторонний клиент, неправильное использование может нарушать Условия использования Telegram и привести к блокировке аккаунта.
Что он умеет из коробки?Отправлять и получать сообщения, отправлять и скачивать файлы и медиа, получать фото профиля и читать историю сообщений всего в несколько строк кода.
What are similar projects?python-telegram-bot, ItChat, wxpy, discord.py, fragment-api-dev, whatsapp-web.js, httpx, botkit
Which topics is it in?mtproto, asyncio, client, api-client, bot, python3, messaging, python-library, telegram, chatbot, deprecated, sdk
Creator
LonamiWebs
Size
9.6 MB
Stars
12.1K
Updated
CommitFeb 21
Age
10y
Commits · 90 Days