Merge pull request #23 from NonProjects/indev

Merge Indev (0.4) to Main

Author: NotStatilko

.gitignore

@@ -128,9 +128,8 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
-# Vim
-*.swp
-*.swo
+# VIM
+*.sw*
 
 # User defined
 *.hidden

README.rst

@@ -1,22 +1,32 @@
 TGBOX: encrypted cloud storage based on Telegram API
 ====================================================
+.. image:: https://readthedocs.org/projects/tgbox/badge/?version=latest
 
 .. code-block:: python
 
-        from tgbox import loop
-
         from tgbox.api import (
             TelegramAccount, 
             make_remote_box,
             make_local_box
         )
-        from tgbox.keys import make_basekey
+        from tgbox.keys import make_basekey, Phrase
+        from asyncio import get_event_loop
         from getpass import getpass 
 
+        PHONE_NUMBER = input('Your phone number: ')
+
+        API_ID = 1234567 # https://my.telegram.org
+        API_HASH = '00000000000000000000000000000000'
+        
+        # We will use it to encrypt all data in Box
+        box_phrase = Phrase.generate()
+        print(box_phrase, '- phrase to your Box')
 
         async def main():
             ta = TelegramAccount(
-                phone_number = input('Phone: ')
+                phone_number = PHONE_NUMBER,
+                api_id = API_ID, 
+                api_hash = API_HASH
             )
             await ta.connect()
             await ta.send_code_request()
@@ -25,7 +35,7 @@ TGBOX: encrypted cloud storage based on Telegram API
                 code = int(input('Code: ')),
                 password = getpass('Pass: ')
             )
-            basekey = make_basekey(b'very_bad_phrase')
+            basekey = make_basekey(box_phrase)
 
             erb = await make_remote_box(ta)
             dlb = await make_local_box(erb, ta, basekey)
@@ -37,9 +47,10 @@ TGBOX: encrypted cloud storage based on Telegram API
                 comment = b'Cats are cool B-)',
                 foldername = b'Pictures/Kitties' 
             )
-            drbfi = await drb.push_file(ff)
-            await drbfi.download()
-
+            drbfi = await drb.push_file(ff) # Upload file
+            await drbfi.download() # Download it back
+        
+        loop = get_event_loop()
         loop.run_until_complete(main()) 
 
 Motivation
@@ -55,7 +66,7 @@ This library targets to be a PoC of **encrypted file storage** inside Telegram,
 Abstract
 --------
 
-We name *"encrypted cloud storage"* as **Box** and the API to it as **Tgbox**. There is **two** of boxes: the **RemoteBox** and the **LocalBox**. They define a basic primitives. You can share your Box and separate Files with other people absolutely secure - only You and someone you want will have decryption key, even through insecure communication canals (`e2e <https://en.wikipedia.org/wiki/End-to-end_encryption>`_). You can make unlimited amount of Boxes, upload speed equals to vanilla Telegram and maximum filesize is ``~2GB-2MB``.
+We name *"encrypted cloud storage"* as **Box** and the API to it as **Tgbox**. There is **two** of boxes: the **RemoteBox** and the **LocalBox**. They define a basic primitives. You can share your Box and separate Files with other people absolutely secure - only You and someone you want will have decryption key, even through insecure communication canals (`e2e <https://en.wikipedia.org/wiki/End-to-end_encryption>`_). You can make unlimited amount of Boxes, Upload & Download speed is **faster** than in official Telegram clients and maximum filesize is around **2GB** *minus* **2MB**.
 
 Documentation
 -------------
@@ -67,8 +78,8 @@ You can also build docs from the source
 .. code-block:: console
 
    git clone https://github.com/NonProject/tgbox --branch=main
-   cd tgbox; python3 -m pip install -r requirements.txt
-   cd docs; make html; <your-browser> _build/html/index.html
+   cd tgbox & python3 -m pip install .[fast] # Install TGBOX
+   cd docs & make html & <your-browser> _build/html/index.html
 
 Third party & thanks to
 -----------------------
@@ -81,5 +92,3 @@ Third party & thanks to
 - `Filetype <https://github.com/h2non/filetype.py>`_ (`MIT <https://github.com/h2non/filetype.py/blob/master/LICENSE>`_)
 - `Cryptg <https://github.com/cher-nov/cryptg>`_ (`LICENSE <https://github.com/cher-nov/cryptg/blob/master/LICENSE.txt>`_)
 - `Pycryptodome <https://github.com/Legrandin/pycryptodome>`_ (`LICENSE <https://github.com/Legrandin/pycryptodome/blob/master/LICENSE.rst>`_)
-- `Uvloop <https://github.com/MagicStack/uvloop>`_ (`LICENSE <https://github.com/MagicStack/uvloop/blob/master/LICENSE-APACHE>`_)
-

docs/examples.rst

@@ -6,24 +6,25 @@ Logging in & Box creation
 
 .. code-block:: python
 
-        # This is global Tgbox loop.
-        # You should use it if you
-        # want to add coroutines to
-        # the event loop.
-        from tgbox import loop
-
         from tgbox.api import (
             TelegramAccount, 
             make_remote_box,
             make_local_box
         )
+        from asyncio import get_event_loop
         from tgbox.keys import Phrase, make_basekey
         from getpass import getpass # For hidden input
+        
+        PHONE_NUMBER = input('Your phone number: ')
 
+        API_ID = 1234567 # https://my.telegram.org
+        API_HASH = '00000000000000000000000000000000' 
 
         async def main():
             ta = TelegramAccount(
-                phone_number = input('Phone: ')
+                phone_number = PHONE_NUMBER,
+                api_id = API_ID, 
+                api_hash = API_HASH
             )
             await ta.connect()
             await ta.send_code_request()
@@ -44,7 +45,8 @@ Logging in & Box creation
             erb = await make_remote_box(ta)
             # Make DecryptedLocalBox
             dlb = await make_local_box(erb, ta, basekey)
-
+        
+        loop = get_event_loop()
         loop.run_until_complete(main()) 
 
 
@@ -56,7 +58,7 @@ Synchronous
 
 .. code-block:: python
         
-        from tgbox import loop
+        from asyncio import get_event_loop
         from tgbox.api import get_local_box, get_remote_box
         from tgbox.keys import Phrase, make_basekey
 
@@ -92,7 +94,8 @@ Synchronous
             
             # Download it back.
             await drbfi.download()
-
+        
+        loop = get_event_loop()
         loop.run_until_complete(main())
 
 .. note::
@@ -103,8 +106,6 @@ Asynchronous
 
 .. code-block:: python
         
-        # We use gather() here, but 
-        # there is also tgbox.loop.create_task
         from asyncio import gather
 
         ... # some code omitted
@@ -207,12 +208,11 @@ Box clone
 
 .. code-block:: python
 
-    from tgbox import loop
-
     from tgbox.api import (
         TelegramAccount,
         get_remote_box
     )
+    from asyncio import get_event_loop
     from tgbox.keys import make_basekey
     from getpass import getpass
 
@@ -257,7 +257,8 @@ Box clone
         drb = await erb.decrypt(key=mainkey)
         # Clone and retreive DecryptedLocalBox
         dlb = await drb.clone(basekey)
-
+    
+    loop = get_event_loop()
     loop.run_until_complete(main())
 
 

docs/index.rst

@@ -14,7 +14,7 @@ This library targets to be a PoC of **encrypted file storage**, but can be used
 Abstract
 --------
 
-We name *"encrypted cloud storage"* as **Box** and the API to it as **Tgbox**. There is **two** of boxes: the **RemoteBox** and the **LocalBox**. They define a basic primitives. You can share your Box and separate Files with other people absolutely secure - only You and someone you want will have decryption key, even through insecure communication canals (`e2e <https://en.wikipedia.org/wiki/End-to-end_encryption>`_). You can make unlimited amount of Boxes, upload speed equals to vanilla Telegram and maximum filesize is ``~2GB-2MB``.
+We name *"encrypted cloud storage"* as **Box** and the API to it as **Tgbox**. There is **two** of boxes: the **RemoteBox** and the **LocalBox**. They define a basic primitives. You can share your Box and separate Files with other people absolutely secure - only You and someone you want will have decryption key, even through insecure communication canals (`e2e <https://en.wikipedia.org/wiki/End-to-end_encryption>`_). You can make unlimited amount of Boxes, Upload & Download speed is **faster** than in official Telegram clients and maximum filesize is around **2GB** *minus* **2MB**.
 
 
 .. toctree::

docs/installation.rst

@@ -6,16 +6,16 @@ PyPI (pip)
 
 .. code-block:: console
 
-   python3 -m pip install tgbox
-
+   python3 -m pip install tgbox # Pure Python (very slow)
+   python3 -m pip install tgbox[fast] # With C libraries
 
 Clone from GitHub
 -----------------
 
 .. code-block:: console
 
-   git clone https://github.com/NonProject/tgbox --branch=<branch>
-   cd tgbox; python3 -m pip install -r requirements.txt
+   git clone https://github.com/NonProjects/tgbox --branch=main
+   cd tgbox & python3 -m pip install .[fast]
 
 Optional dependencies
 ---------------------

requirements.txt

@@ -1,39 +1,39 @@
-from sys import version_info, platform
 from setuptools import setup
 
-requirements = [
-    'aiosqlite==0.17.0',
-    'telethon==1.24.0',
-    'ecdsa==0.16.1',
-    'filetype==1.0.8',
-    'cryptg==0.2.post2',
-    'pycryptodome==3.10.1',
-    'sphinx-rtd-theme==1.0.0', 
-    'regex==2021.11.10'
-]
-if version_info > (3, 7) and platform not in ('win32', 'cygwin', 'cli'):
-    requirements.append('uvloop==0.16.0')
-
 setup(
     name             = 'tgbox',
     packages         = ['tgbox'],
-    version          = '0.3.3',
+    version          = '0.4',
     license          = 'LGPL-2.1',
     description      = 'Encrypted cloud storage based on Telegram API',
     author           = 'NonProjects',
+    author_email     = 'thenonproton@pm.me',
     url              = 'https://github.com/NonProjects/tgbox',
-    download_url     = 'https://github.com/NonProjects/tgbox/archive/refs/tags/indev%230.3.2.tar.gz',
+    download_url     = 'https://github.com/NonProjects/tgbox/archive/refs/tags/main%23{VERSION}.tar.gz',
 
     package_data = {
         'tgbox': ['tgbox/other'],
     },
     include_package_data = True,
-    install_requires = requirements,
-
+    
+    install_requires = [
+        'aiosqlite==0.17.0',
+        'telethon==1.24.0',
+        'ecdsa==0.16.1',
+        'filetype==1.0.8',
+        'sphinx-rtd-theme==1.0.0'
+    ],
     keywords = [
-        'Telegram', 'Cloud-Storage', 
+        'Telegram', 'Cloud-Storage', 'Cloud',
         'API', 'Asyncio', 'Non-official'
     ],
+    extras_require = {
+        'fast': [
+            'pycryptodome==3.12.0',
+            'cryptg==0.2.post4',
+            'regex==2021.11.10'
+        ]
+    },
     classifiers = [
         'Development Status :: 4 - Beta',
         'Intended Audience :: Developers',
@@ -42,8 +42,6 @@
         'Topic :: Software Development :: Libraries :: Python Modules',
         'Topic :: System :: Archiving :: Backup',
         'License :: OSI Approved :: GNU General Public License v2 (GPLv2)',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3.9'

setup.py

@@ -1,19 +1,7 @@
-from asyncio import (
-    new_event_loop, 
-    set_event_loop
-)
-try:
-    # We can use uvloop as event loop
-    # on Linux systems, it's around 2x
-    # faster than Python's default.
-    from uvloop import new_event_loop
-    FAST_EVENT_LOOP = True
-except ModuleNotFoundError:
-    FAST_EVENT_LOOP = False
+__version__ = '0.4'
 
-# Define and set global event loop
-loop = new_event_loop()
-set_event_loop(loop)
+from asyncio import get_event_loop
+from typing import Coroutine
 
 from . import api
 from . import constants
@@ -23,7 +11,6 @@
 from . import keys
 from . import tools
 
-from typing import Coroutine
 
 __all__ = [
     'api',
@@ -33,15 +20,12 @@
     'errors',
     'keys',
     'tools',
-    'loop',
     'sync',
-    'new_event_loop',
-    'FAST_EVENT_LOOP'
 ]
-
 def sync(coroutine: Coroutine):
     """
-    Will call asynchronous function
-    in ``tgbox.loop`` and return result.
+    Will call asynchronous function in
+    current asyncio loop and return result.
     """
+    loop = get_event_loop()
     return loop.run_until_complete(coroutine)