Add force_unzip, progress bar during unzip, unzip_path. Updated README.

Author: loribonna

.gitignore

@@ -3,4 +3,6 @@ __pycache__
 *.pyc
 .pypirc
 .vscode
-dist
+dist
+build
+onedrivedownloader.egg-info

README.md

@@ -6,6 +6,10 @@
 
 First stable release: `1.0.0`
 
+Current: `1.0.2`
+
+*Do not require authentication.*
+
 ### Requires
 - `tqdm`: for nice progress bar
 - `requests`: fetch data from OneDrive

onedrivedownloader/main.py

@@ -26,7 +26,7 @@ def _create_if_not_exists(path: str, remove=True) -> None:
 
     os.makedirs(path, exist_ok=True)
 
-def download(url: str, filename: str, unzip=False, unzip_path: str = None, force_download=False, clean=False) -> None:
+def download(url: str, filename: str, unzip=False, unzip_path: str = None, force_download=False, force_unzip=False, clean=False) -> None:
     """
     Download a file from a OneDrive url.
 
@@ -36,6 +36,7 @@ def download(url: str, filename: str, unzip=False, unzip_path: str = None, force
     :param unzip: Whether to unzip the file.
     :param unzip_path: The path to unzip the file to. Default is current path.
     :param force_download: Whether to force download the file even if it already exists.
+    :param force_unzip: Whether to force unzip and overwrite the file even if it already exists.
     :param clean: Whether to clean the unzipped files after unzipping.
     """
 
@@ -49,9 +50,6 @@ def download(url: str, filename: str, unzip=False, unzip_path: str = None, force
         progress_bar = tqdm(total=total_size_in_bytes, unit='iB', unit_scale=True) if total_size_in_bytes > 1024 else None
         block_size = 1024
 
-        # parent if filename has a path else current path
-        parent_path = os.path.split(filename)[0] if os.path.split(filename)[0] != '' else os.getcwd()
-
         if not os.path.exists(filename) or force_download:
             _create_if_not_exists(filename)
 
@@ -72,13 +70,18 @@ def download(url: str, filename: str, unzip=False, unzip_path: str = None, force
         if unzip:
             assert filename.endswith(".zip"), "ERROR: file is not a zip file!"
 
-            clean_unzip_path = unzip_path is not None and os.path.realpath(unzip_path) not in os.path.realpath(filename)
+            unzip_path = unzip_path if unzip_path is not None else os.path.split(filename)[0]
+            clean_unzip_path = force_unzip and os.path.realpath(unzip_path) not in os.path.realpath(filename)
 
-            print("Extracting files...")
-
             _create_if_not_exists(unzip_path, remove=clean_unzip_path)
+
+            if force_unzip:
+                print("Warning: overwriting existing files!")
+
             with zipfile.ZipFile(filename, 'r') as zip_ref:
-                zip_ref.extractall(unzip_path)
+                for file in tqdm(iterable=zip_ref.namelist(), total=len(zip_ref.namelist()), desc="Extracting files"):
+                    if not os.path.exists(os.path.join(unzip_path, file)) or force_unzip:
+                        zip_ref.extract(member=file, path=unzip_path)
 
             if clean:
                 os.remove(filename)

setup.py

@@ -1,19 +1,24 @@
-from distutils.core import setup
+from setuptools import setup, find_packages
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+with open("requirements.txt", "r", encoding="utf-8") as fh:
+    requirements = fh.read()
+
 setup(
     name='onedrivedownloader',
-    packages=['onedrivedownloader'],
-    version='1.0.1',
+    packages=find_packages(),
+    version='1.0.2',
     license='MIT',
     description='Python utility to download files through OneDrive',
+    long_description=long_description,
+    long_description_content_type="text/markdown",
     author='Lorenzo Bonicelli',
     author_email='[email protected]',
     url='https://github.com/loribonna/onedrivedownloader',
-    download_url='https://github.com/loribonna/onedrivedownloader/archive/refs/tags/v1.0.1.zip',
-    keywords=['onedrive', 'downloader', 'python', 'utility'],
-    install_requires=[
-        'requests',
-        'tqdm'
-    ],
+    download_url='https://github.com/loribonna/onedrivedownloader/archive/refs/tags/v1.0.2.zip',
+    keywords=['onedrive', 'downloader', 'download', 'python', 'utility'],
+    install_requires=[requirements],
     classifiers=[
         'Development Status :: 3 - Alpha',
         'Intended Audience :: Developers',