mirror of
https://github.com/LonamiWebs/Telethon.git
synced 2025-10-30 23:47:33 +03:00
b716c4fe67
- Made the documentation even more friendly towards newbies. - Eased the usage of methods like get history which now set a default empty message for message actions and vice versa. - Fixed some docstring documentations too. - Updated the old normal docs/ to link back and forth RTD. - Fixed the version of the documentation, now auto-loaded.
73 lines
1.9 KiB
ReStructuredText
73 lines
1.9 KiB
ReStructuredText
.. _getting-started:
|
|
|
|
|
|
===============
|
|
Getting Started
|
|
===============
|
|
|
|
|
|
Simple Installation
|
|
*******************
|
|
|
|
``pip3 install telethon``
|
|
|
|
**More details**: :ref:`installation`
|
|
|
|
|
|
Creating a client
|
|
*****************
|
|
|
|
.. code-block:: python
|
|
|
|
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)
|
|
client.start()
|
|
|
|
**More details**: :ref:`creating-a-client`
|
|
|
|
|
|
Basic Usage
|
|
***********
|
|
|
|
.. code-block:: python
|
|
|
|
# Getting information about yourself
|
|
print(client.get_me().stringify())
|
|
|
|
# Sending a message (you can use 'me' or 'self' to message yourself)
|
|
client.send_message('username', 'Hello World from Telethon!')
|
|
|
|
# Sending a file
|
|
client.send_file('username', '/home/myself/Pictures/holidays.jpg')
|
|
|
|
# Retrieving messages from a chat
|
|
from telethon import utils
|
|
for message in client.get_message_history('username', limit=10):
|
|
print(utils.get_display_name(message.sender), message.message)
|
|
|
|
# Listing all the dialogs (conversations you have open)
|
|
for dialog in client.get_dialogs(limit=10):
|
|
print(utils.get_display_name(dialog.entity), dialog.draft.message)
|
|
|
|
# Downloading profile photos (default path is the working directory)
|
|
client.download_profile_photo('username')
|
|
|
|
# Once you have a message with .media (if message.media)
|
|
# you can download it using client.download_media():
|
|
messages = client.get_message_history('username')
|
|
client.download_media(messages[0])
|
|
|
|
**More details**: :ref:`telegram-client`
|
|
|
|
|
|
----------
|
|
|
|
You can continue by clicking on the "More details" link below each
|
|
snippet of code or the "Next" button at the bottom of the page.
|