From 9bb5cfd871c493fe94a8b0b2db125c63f19029ed Mon Sep 17 00:00:00 2001 From: Lonami Exo Date: Thu, 28 Jun 2018 09:40:38 +0200 Subject: [PATCH] Mention telethon-sync --- README.rst | 5 ++++- readthedocs/extra/basic/asyncio-magic.rst | 7 ++++--- readthedocs/extra/changelog.rst | 8 +++----- 3 files changed, 11 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index 60fb0e74..0d6c28a3 100755 --- a/README.rst +++ b/README.rst @@ -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 -`_. +`_, +or ``pip install telethon-sync`` which is compatible with `synchronous code +`_. Don't forget to remove +the asynchronous version (``pip uninstall telethon``) if you do install sync. What is this? ------------- diff --git a/readthedocs/extra/basic/asyncio-magic.rst b/readthedocs/extra/basic/asyncio-magic.rst index c4129b9e..4cba2c28 100644 --- a/readthedocs/extra/basic/asyncio-magic.rst +++ b/readthedocs/extra/basic/asyncio-magic.rst @@ -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`. diff --git a/readthedocs/extra/changelog.rst b/readthedocs/extra/changelog.rst index 228fc8ab..d691bc88 100644 --- a/readthedocs/extra/changelog.rst +++ b/readthedocs/extra/changelog.rst @@ -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