LonamiWebs/Telethon
1
1
Fork 0
mirror of https://github.com/LonamiWebs/Telethon.git synced 2024-11-21 17:06:36 +03:00
Code Issues Packages Projects Releases Wiki Activity

Docs at RTD

Lonami 2018-06-24 19:35:26 +02:00
parent 3fb676a531
commit e37a11afc0
1 changed files with 3 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
Home.md

@ -1,34 +1,5 @@
Welcome to the wiki! This place hosts all the information you need in order to work with this library. **Telethon** is a Telegram client implementation in **Python** which uses the latest available API of Telegram. Check the links on the sidebar for more!
Welcome to the wiki! This place is maintained **by users like you**, and you can use it to share your findings. How to update your account, send a message, use events, etc. all can be put here.
Before opening an issue about how to use the library, **please** make sure you've investigated and read the wiki enough! Issues lacking of any sense at all end on the [Wall of Shame](https://github.com/LonamiWebs/Telethon/wiki/Wall-of-Shame).
Share your discoveries and help document the vast amount of methods Telegram has!
Also please make sure to **read the change log** (over [Releases](https://github.com/LonamiWebs/Telethon/releases)) when you update the library through `pip install --upgrade telethon`, since the library, although has been around for quite a while, may still introduce some breaking changes from time to time which will be listed there.
The library will by default report RPC errors to `rpc.pwrtelegram.xyz`. For more information, please check the [API Status](API-Status) wiki page.
## Why Telethon?
> Why should I bother with Telethon? There are more mature projects already, such as [`telegram-cli`](https://github.com/vysheng/tg) with even (limited) Python support. And we have the [official](https://github.com/telegramdesktop/tdesktop>) [clients](https://github.com/DrKLO/Telegram>)!
With Telethon you don't really need to know anything before using it. Create a client with your settings.
Connect. You're ready to go.
Being written **entirely** on Python, Telethon can run as a script under any environment you wish, (yes,
[Android too](https://f-droid.org/repository/browse/?fdfilter=termux&fdid=com.termux>)). You can schedule it,
or use it in any other script you have. Want to send a message to someone when you're available? Write a script.
Do you want check for new messages at a given time and find relevant ones? Write a script.
**It is very important** that your system time is [on sync](https://time.is/)! The library will do its best as long as the current time is not behind 30 seconds in the past, and 300 in the future, but the server may not reply at all for larger differences, thanks [@danog](https://github.com/danog) for the information. This will most likely be the cause for the following errors:
```
BlockingIOError: [Errno 11] Resource temporarily unavailable
BlockingIOError: [Errno 35] Resource temporarily unavailable
TimeoutError: The read operation exceeded the timeout.
```
Please check this out before opening an issue. Thanks to [issue 172](https://github.com/LonamiWebs/Telethon/issues/172) for the debug level log.
The online documentation for all available requests, types and constructors is available online at https://lonamiwebs.github.io/Telethon/.
## Possible problems
If you ever receive a `PEER_FLOOD` error or aren't able to perform certain requests, it might mean that your account is limited, and there's not much Telethon can do about this. Talk to [@SpamBot](https://t.me/SpamBot) for more information, or refer to the [spam FAQ](https://www.telegram.org/faq_spam).
You can access the official documentation at https://telethon.rtfd.io.