UGithubDownloader + some functions and methods for downloading files and folders from repo or downloading all repo.

requirements.txt

@@ -0,0 +1 @@
+requests~=2.31.0

setup.py

@@ -6,14 +6,17 @@
     long_description = mdf.read()
 
 install_requires = [
-
+    'requests~=2.31.0',
 ]
 
 organization_name = 'honey-team'
 author, author_email = 'bleudev', '[email protected]'
 project_name = 'ufpy'
 github_url = f'https://github.com/{organization_name}/{project_name}'
 
+def package(name: str) -> str:
+    return f'{project_name}.{name}'
+
 setup(
     name=project_name,
     version=__version__,
@@ -24,7 +27,11 @@
     long_description=long_description,
     long_description_content_type='text/markdown',
     url=github_url,
-    packages=[project_name, f'{project_name}.typ'],
+    packages=[
+        project_name,
+        package('typ'),
+        package('github'),
+    ],
     classifiers=[
         'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3.12',

ufpy/__init__.py

@@ -1,12 +1,20 @@
 __version__ = '0.1.2'
 
-# Typing package
-from ufpy import typ
 from ufpy.cmp import *
 from ufpy.math_op import *
 from ufpy.path_tools import *
-from ufpy.typ.protocols import *
-from ufpy.typ.type_alias import *
 from ufpy.udict import *
 from ufpy.ustack import *
 from ufpy.utils import *
+
+# Typing package
+__typ_version__ = '0.1'
+from ufpy import typ
+from ufpy.typ.protocols import *
+from ufpy.typ.type_alias import *
+
+# Github package
+__github_version__ = '0.1'
+from ufpy import github
+from ufpy.github.download import UGithubDownloader
+from ufpy.github import download_file, download_folder, download_repo, download

ufpy/github/__init__.py

@@ -0,0 +1,3 @@
+from .download import file as download_file
+from .download import folder as download_folder
+from .download import repo as download_repo

ufpy/github/download.py

@@ -0,0 +1,91 @@
+import os
+from shutil import copy, copytree, rmtree
+from zipfile import ZipFile
+
+from requests import get
+
+__all__ = (
+    'file',
+    'folder',
+    'repo',
+    'UGithubDownloader',
+)
+
+def file(repo: str, file_path: str, download_path: str, branch_name: str = 'main'):
+    file_path = file_path.replace('\\', '/')
+
+    url = f'https://raw.githubusercontent.com/{repo}/{branch_name}/{file_path}'
+    r = get(url)
+
+    download_path = download_path.replace('\\', '/')
+    path = f'{download_path}/{file_path}'
+
+    directory = '/'.join(path.split('/')[:-1])
+
+    if not os.path.exists(directory):
+        os.makedirs(directory)
+
+    with open(path, 'w+') as f:
+        f.write(r.text)
+
+def folder(repo: str, folder_path: str, download_path: str, branch_name: str = 'main'):
+    ...
+
+def repo(repo: str, download_path: str, branch_name: str = 'main'):
+    filename = f'{download_path}/repo_temp.zip'
+    url = f'https://github.com/{repo}/archive/{branch_name}.zip'
+
+    r = get(url)
+
+    with open(filename, 'wb') as f:
+        f.write(r.content)
+
+    repo_name = repo.split('/')[-1]
+    main_directory_name = f'{repo_name}-{branch_name}'
+
+    with ZipFile(filename) as archive:
+        for file in archive.namelist():
+            if file.startswith(main_directory_name):
+                archive.extract(file, download_path)
+
+    if os.path.exists(filename):
+        os.remove(filename)
+
+    repo_dir = f'{download_path}/{main_directory_name}'
+    for file in os.listdir(repo_dir):
+        file_path = f'{repo_dir}/{file}'
+        new_file_path = f'{download_path}/{file}'
+        if os.path.isdir(file_path):
+            if os.path.exists(new_file_path):
+                print(
+                    f"Warning ({new_file_path}): Currently we don't support editing recursive folders if it's exists"
+                    "when repo directory was downloaded. Sorry, you can just delete all folders with same name as in"
+                    "repo before you use this function instead."
+                )
+                continue
+            copytree(file_path, new_file_path)
+        else:
+            if os.path.exists(new_file_path):
+                with open(new_file_path, 'w') as nf:
+                    with open(file_path, 'r') as f:
+                        nf.write(f.read())
+            else:
+                copy(file_path, new_file_path)
+
+    if os.path.exists(f'{download_path}/{main_directory_name}'):
+        rmtree(f'{download_path}/{main_directory_name}')
+
+
+class UGithubDownloader:
+    def __init__(self, repo: str, branch_name: str = 'main'):
+        self.__repo = repo
+        self.__branch = branch_name
+
+    def download_file(self, file_path: str, download_path: str):
+        file(self.__repo, file_path, download_path, self.__branch)
+
+    def download_folder(self, folder_path: str, download_path: str):
+        folder(self.__repo, folder_path, download_path, self.__branch)
+
+    def download_repo(self, download_path: str):
+        repo(self.__repo, download_path, self.__branch)