From 633bf4684ae93cd1593e3a42b3bc102b3c32bad7 Mon Sep 17 00:00:00 2001 From: Lonami Exo Date: Thu, 24 Aug 2017 19:08:21 +0200 Subject: [PATCH] Add a new super simple README.rst --- README.rst | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100755 README.rst diff --git a/README.rst b/README.rst new file mode 100755 index 00000000..7227ab74 --- /dev/null +++ b/README.rst @@ -0,0 +1,59 @@ +Telethon +======== +.. epigraph:: + + ⭐️ 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. Remember to use **pip3** to install! + +Installing +---------- + +.. code:: sh + + pip install telethon + + +Creating a client +----------------- + +.. code:: 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' + phone = '+34600000000' + + client = TelegramClient('session_name', api_id, api_hash) + client.connect() + + # If you already have a previous 'session_name.session' file, skip this. + client.send_code_request(phone) + me = client.sign_in(phone, 77777) # Put whatever code you received here. + + +Doing stuff +----------- + +.. code:: python + + print(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) + total, messages, senders = client.get_message_history('username') + client.download_media(messages[0]) + + +Next steps +---------- + +Once you've decided that you like the way Telethon looks and feel comfortable +with this code, go ahead and read the full +`README `_ :)