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
Raw data
{
"_id": null,
"home_page": "https://github.com/LonamiWebs/Telethon",
"name": "telethon-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": null,
"keywords": "telegram api chat client library messaging mtproto",
"author": "Lonami Exo",
"author_email": "danilka.khuyevich@mail.ru",
"download_url": "https://files.pythonhosted.org/packages/d5/8b/dad590c3125169851ea7021014eaa891a9138dabd85d7d18a789b25a7b68/telethon_api-1.35.0.tar.gz",
"platform": null,
"description": "Telethon\r\n========\r\n.. epigraph::\r\n\r\n \u2b50\ufe0f Thanks **everyone** who has starred the project, it means a lot!\r\n\r\n|logo| **Telethon** is an asyncio_ **Python 3**\r\nMTProto_ library to interact with Telegram_'s API\r\nas a user or through a bot account (bot API alternative).\r\n\r\n.. important::\r\n\r\n If you have code using Telethon before its 1.0 version, you must\r\n read `Compatibility and Convenience`_ to learn how to migrate.\r\n As with any third-party library for Telegram, be careful not to\r\n break `Telegram's ToS`_ or `Telegram can ban the account`_.\r\n\r\nWhat is this?\r\n-------------\r\n\r\nTelegram is a popular messaging application. This library is meant\r\nto make it easy for you to write Python programs that can interact\r\nwith Telegram. Think of it as a wrapper that has already done the\r\nheavy job for you, so you can focus on developing an application.\r\n\r\n\r\nInstalling\r\n----------\r\n\r\n.. code-block:: sh\r\n\r\n pip3 install telethon\r\n\r\n\r\nCreating a client\r\n-----------------\r\n\r\n.. code-block:: python\r\n\r\n from telethon import TelegramClient, events, sync\r\n\r\n # These example values won't work. You must get your own api_id and\r\n # api_hash from https://my.telegram.org, under API Development.\r\n api_id = 12345\r\n api_hash = '0123456789abcdef0123456789abcdef'\r\n\r\n client = TelegramClient('session_name', api_id, api_hash)\r\n client.start()\r\n\r\n\r\nDoing stuff\r\n-----------\r\n\r\n.. code-block:: python\r\n\r\n print(client.get_me().stringify())\r\n\r\n client.send_message('username', 'Hello! Talking to you from Telethon')\r\n client.send_file('username', '/home/myself/Pictures/holidays.jpg')\r\n\r\n client.download_profile_photo('me')\r\n messages = client.get_messages('username')\r\n messages[0].download_media()\r\n\r\n @client.on(events.NewMessage(pattern='(?i)hi|hello'))\r\n async def handler(event):\r\n await event.respond('Hey!')\r\n\r\n\r\nNext steps\r\n----------\r\n\r\nDo you like how Telethon looks? Check out `Read The Docs`_ for a more\r\nin-depth explanation, with examples, troubleshooting issues, and more\r\nuseful information.\r\n\r\n.. _asyncio: https://docs.python.org/3/library/asyncio.html\r\n.. _MTProto: https://core.telegram.org/mtproto\r\n.. _Telegram: https://telegram.org\r\n.. _Compatibility and Convenience: https://docs.telethon.dev/en/stable/misc/compatibility-and-convenience.html\r\n.. _Telegram's ToS: https://core.telegram.org/api/terms\r\n.. _Telegram can ban the account: https://docs.telethon.dev/en/stable/quick-references/faq.html#my-account-was-deleted-limited-when-using-the-library\r\n.. _Read The Docs: https://docs.telethon.dev\r\n\r\n.. |logo| image:: logo.svg\r\n :width: 24pt\r\n :height: 24pt\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Full-featured Telegram client library for Python 3",
"version": "1.35.0",
"project_urls": {
"Download": "https://github.com/LonamiWebs/Telethon/releases",
"Homepage": "https://github.com/LonamiWebs/Telethon"
},
"split_keywords": [
"telegram",
"api",
"chat",
"client",
"library",
"messaging",
"mtproto"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d58bdad590c3125169851ea7021014eaa891a9138dabd85d7d18a789b25a7b68",
"md5": "77e97445cf595342006c956b5a0bcc83",
"sha256": "5bebbe3fb6a0572f7b7aee05c2be4af967c88fd95cb6f5ab2f6fbbeb4d173712"
},
"downloads": -1,
"filename": "telethon_api-1.35.0.tar.gz",
"has_sig": false,
"md5_digest": "77e97445cf595342006c956b5a0bcc83",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 609868,
"upload_time": "2024-05-16T11:38:25",
"upload_time_iso_8601": "2024-05-16T11:38:25.251979Z",
"url": "https://files.pythonhosted.org/packages/d5/8b/dad590c3125169851ea7021014eaa891a9138dabd85d7d18a789b25a7b68/telethon_api-1.35.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-16 11:38:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "LonamiWebs",
"github_project": "Telethon",
"travis_ci": false,
"coveralls": true,
"github_actions": false,
"requirements": [
{
"name": "pyaes",
"specs": []
},
{
"name": "rsa",
"specs": []
}
],
"lcname": "telethon-api"
}
JSON
