mirror of
https://github.com/LonamiWebs/Telethon.git
synced 2026-09-06 00:42:02 +00:00
Rewrite the first part of the docs for asyncio
This commit is contained in:
+29
-20
@@ -4,8 +4,11 @@ Telethon
|
||||
|
||||
⭐️ Thanks **everyone** who has starred the project, it means a lot!
|
||||
|
||||
**Telethon** is Telegram client implementation in **Python 3** which uses
|
||||
the latest available API of Telegram.
|
||||
**Telethon** is an `asyncio <https://docs.python.org/3/library/asyncio.html>`_
|
||||
**Python 3** library to interact with Telegram's API.
|
||||
|
||||
If you don't like ``asyncio``, you can still use `a simpler version
|
||||
<https://github.com/LonamiWebs/Telethon/tree/sync>`_ that uses threads instead.
|
||||
|
||||
|
||||
What is this?
|
||||
@@ -22,7 +25,7 @@ Installing
|
||||
|
||||
.. code:: sh
|
||||
|
||||
pip3 install telethon
|
||||
pip3 install telethon-aio
|
||||
|
||||
|
||||
Creating a client
|
||||
@@ -30,15 +33,18 @@ Creating a client
|
||||
|
||||
.. code:: python
|
||||
|
||||
from telethon import TelegramClient
|
||||
import asyncio
|
||||
loop = asyncio.get_event_loop()
|
||||
|
||||
# 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'
|
||||
from telethon import TelegramClient
|
||||
|
||||
client = TelegramClient('session_name', api_id, api_hash)
|
||||
client.start()
|
||||
# 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)
|
||||
loop.run_until_complete(client.start())
|
||||
|
||||
|
||||
Doing stuff
|
||||
@@ -46,20 +52,23 @@ Doing stuff
|
||||
|
||||
.. code:: python
|
||||
|
||||
print(client.get_me().stringify())
|
||||
async def main():
|
||||
me = await client.get_me()
|
||||
print(me.stringify())
|
||||
|
||||
client.send_message('username', 'Hello! Talking to you from Telethon')
|
||||
client.send_file('username', '/home/myself/Pictures/holidays.jpg')
|
||||
await client.send_message('username', 'Hello! Talking to you from Telethon')
|
||||
await client.send_file('username', '/home/myself/Pictures/holidays.jpg')
|
||||
|
||||
client.download_profile_photo('me')
|
||||
messages = client.get_messages('username')
|
||||
client.download_media(messages[0])
|
||||
await client.download_profile_photo('me')
|
||||
messages = await client.get_messages('username')
|
||||
await messages[0].download_media()
|
||||
|
||||
loop.run_until_complete(main())
|
||||
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
Reference in New Issue
Block a user