114 lines
3.4 KiB
Plaintext
114 lines
3.4 KiB
Plaintext
|
Metadata-Version: 2.1
|
||
|
|
Name: Telethon
|
||
|
|
Version: 1.36.0
|
||
|
|
Summary: Full-featured Telegram client library for Python 3
|
||
|
|
Home-page: https://github.com/LonamiWebs/Telethon
|
||
|
|
Download-URL: https://github.com/LonamiWebs/Telethon/releases
|
||
|
|
Author: Lonami Exo
|
||
|
|
Author-email: totufals@hotmail.com
|
||
|
|
License: MIT
|
||
|
|
Keywords: telegram api chat client library messaging mtproto
|
||
|
|
Classifier: Development Status :: 5 - Production/Stable
|
||
|
|
Classifier: Intended Audience :: Developers
|
||
|
|
Classifier: Topic :: Communications :: Chat
|
||
|
|
Classifier: License :: OSI Approved :: MIT License
|
||
|
|
Classifier: Programming Language :: Python :: 3
|
||
|
|
Classifier: Programming Language :: Python :: 3.5
|
||
|
|
Classifier: Programming Language :: Python :: 3.6
|
||
|
|
Classifier: Programming Language :: Python :: 3.7
|
||
|
|
Classifier: Programming Language :: Python :: 3.8
|
||
|
|
Requires-Python: >=3.5
|
||
|
|
License-File: LICENSE
|
||
|
|
Requires-Dist: pyaes
|
||
|
|
Requires-Dist: rsa
|
||
|
|
Provides-Extra: cryptg
|
||
|
|
Requires-Dist: cryptg ; extra == 'cryptg'
|
||
|
|
|
||
|
|
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
|