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

Mention telethon-sync

Browse Source
This commit is contained in:
Lonami Exo 2018-06-28 09:40:38 +02:00
parent 3154575ab6
commit 9bb5cfd871
3 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.rst
View File

@ -10,7 +10,10 @@ to interact with Telegram's API.
**If you're upgrading from Telethon pre-1.0 to 1.0, please make sure to read**
`this section of the documentation
<https://telethon.readthedocs.io/en/latest/extra/basic/asyncio-magic.html>`_.
<https://telethon.readthedocs.io/en/latest/extra/basic/asyncio-magic.html>`_,
or ``pip install telethon-sync`` which is compatible with `synchronous code
<https://github.com/LonamiWebs/Telethon/tree/sync>`_. Don't forget to remove
the asynchronous version (``pip uninstall telethon``) if you do install sync.
What is this?
-------------

7
readthedocs/extra/basic/asyncio-magic.rst
View File

@ -13,9 +13,10 @@ Magic with asyncio
import telethon.sync
At the beginning of your main script and you will be good. If you do use
updates or events, keep reading, or install the latest version using
threads and Python 3.4 support with ``pip install telethon==0.19.1.6``.
At the beginning of your main script and you will be good. If you **do**
use updates or events, keep reading, or ``pip install telethon-sync``, a
branch that mimics the ``asyncio`` code with threads and should work
under Python 3.4.
You might also want to check the :ref:`changelog`.

8
readthedocs/extra/changelog.rst
View File

@ -46,11 +46,9 @@ Synchronous magic (v1.0)
If you come from Telethon pre-1.0 you **really** want to read
:ref:`asyncio-magic` to port your scripts to the new version.
If you're not ready for this, you can ``pip install telethon==0.19.1.6``.
It's the latest version of the library using threads for Python 3.4+.
If you're interested in maintaining a Telethon version that supports
Python 3.4 and uses threads, please open an issue and let me know.
If you're not ready for this, you can ``pip install telethon-sync``.
It's a synchronous branch that mimics the ``asyncio`` version with
threads and should work under Python 3.4
The library has been around for well over a year. A lot of improvements have
been made, a lot of user complaints have been fixed, and a lot of user desires