atomicshop 2.19.11__py3-none-any.whl → 2.19.12__py3-none-any.whl

atomicshop/__init__.py

@@ -1,4 +1,4 @@
 """Atomic Basic functions and classes to make developer life easier"""
 
 __author__ = "Den Kras"
-__version__ = '2.19.11'
+__version__ = '2.19.12'

atomicshop/console_user_response.py

@@ -1,11 +1,12 @@
-# v1.0.2 - 26.03.2023 20:40
 import sys
 
 
-def query_positive_negative(question_string: str,
-                            add_first_values_to_question: bool = True,
-                            positive_answers: list = None,
-                            negative_answers: list = None) -> bool:
+def query_positive_negative(
+        question_string: str,
+        add_first_values_to_question: bool = True,
+        positive_answers: list = None,
+        negative_answers: list = None
+) -> bool:
     """
     Ask for "yes" / "no" input to a question that is passed as a "question_string".
     Returns 'True' for 'positive' answers and 'False' for 'negative' answers.
@@ -31,10 +32,8 @@ def query_positive_negative(question_string: str,
     if add_first_values_to_question:
         question_string = f'{question_string} [{positive_answers[0]}/{negative_answers[0]}]'
 
-    # Defining variable as False for While loop to run
-    right_answer = False
     # As long as "right_answer" is False the loop will execute again
-    while not right_answer:
+    while True:
         # Print the passed question
         print(question_string)
         # Get the input from the console in lowercase
@@ -42,22 +41,16 @@ def query_positive_negative(question_string: str,
 
         # If the gathered value is in "Yes" answers array
         if choice in positive_answers:
-            # "right_answer" variable is True, so the loop will not execute again
-            right_answer = True
             # Function will return True
             return True
         # Else If the gathered value is in "No" answers array
         elif choice in negative_answers:
-            # "right_answer" variable is True, so the loop will not execute again
-            right_answer = True
             # Function will return False
             return False
         # If the gathered input is not in the arrays
         else:
             # Then output to console the message
             print("Please respond with either:", positive_answers, negative_answers)
-            # "right_answer" variable stays False, so the loop will execute again
-            right_answer = False
 
 
 def do_you_want_to_continue_yn(message: str) -> None:

atomicshop/versioning.py

@@ -0,0 +1,27 @@
+from typing import Union
+
+
+def is_target_newer(
+        base_version: Union[str, tuple],
+        target_version: Union[str, tuple]
+):
+    """
+    Check if the target version is newer than the base version.
+    Example: is_target_newer('1.0.0', '1.0.1') -> True
+    Example: is_target_newer('1.0.0', '1.0.0') -> False
+    Example: is_target_newer('1.0.1', '1.0.0') -> False
+    Example: is_target_newer('1.0.1', '1.0.2') -> True
+    Example: is_target_newer((1,0,1), (1,1,0)) -> True
+
+    :param base_version: The base version to compare against.
+    :param target_version: The target version to compare.
+    """
+
+    # Convert string to tuple if string was passed.
+    if isinstance(base_version, str):
+        base_version = tuple(map(int, base_version.split('.')))
+    if isinstance(target_version, str):
+        target_version = tuple(map(int, target_version.split('.')))
+
+    # Compare the versions.
+    return target_version > base_version

atomicshop/web.py

@@ -233,6 +233,8 @@ def download(
 
     if aggregated_bytes_int == file_size_bytes_int:
         print_api.print_api(f'Successfully Downloaded to: {file_path}', color="green", **kwargs)
+    elif file_size_bytes_int is None:
+        pass
     else:
         message = f'Download failed: {aggregated_bytes_int} / {file_size_bytes_int}. File: {file_path}'
         print_api.print_api(

atomicshop/wrappers/githubw.py

@@ -1,7 +1,10 @@
 import requests
 import fnmatch
+import os
+import tempfile
+from typing import Literal
 
-from .. import web, urls
+from .. import web, urls, filesystem
 from ..print_api import print_api
 
 
@@ -21,7 +24,9 @@ class GitHubWrapper:
             branch: str = 'master',
             path: str = None,
             pat: str = None,
-            branch_file_extension: str = '.zip'
+            branch_file_extension: Literal[
+                'zip',
+                'tar.gz'] = 'zip'
     ):
         """
         This class is a wrapper for GitHub repositories. It can download the branch file from the repository and extract
@@ -37,8 +42,8 @@ class GitHubWrapper:
         :param path: str, the path to the file/folder inside the repo that we'll do certain actions on.
              Actions example: get_latest_commit_comment, download_path_from_branch.
         :param pat: str, the personal access token to the repo.
-        :param branch_file_extension: str, the branch file extension. The default is '.zip'.
-            You also can use '.tar.gz' as extension.
+        :param branch_file_extension: str, the branch file extension. The default is 'zip'.
+            You also can use 'tar.gz' as extension.
 
         ================================================================================================================
         Usage to download the 'master' branch file:
@@ -93,13 +98,19 @@ class GitHubWrapper:
         self.branch_file_extension: str = branch_file_extension
 
         # Default variables.
-        self.archive_directory: str = 'archive'
-        self.branch_file_name: str = f'{self.branch}{self.branch_file_extension}'
+        if self.branch_file_extension == 'zip':
+            self.branch_type_directory: str = 'zipball'
+        elif self.branch_file_extension == 'tar.gz':
+            self.branch_type_directory: str = 'tarball'
+        else:
+            raise ValueError(f"Unsupported branch file extension: {self.branch_file_extension}")
+
         self.domain: str = 'github.com'
 
         # Initialize variables.
         self.branch_download_link: str = str()
         self.branch_downloaded_folder_name: str = str()
+        self.branch_file_name: str = str()
         self.api_url: str = str()
         self.latest_release_json_url: str = str()
         self.commits_url: str = str()
@@ -126,14 +137,15 @@ class GitHubWrapper:
             raise ValueError("'user_name' or 'repo_name' is empty.")
 
         self.repo_url = f'https://{self.domain}/{self.user_name}/{self.repo_name}'
-        self.branch_download_link = f'{self.repo_url}/{self.archive_directory}/{self.branch_file_name}'
         self.branch_downloaded_folder_name = f'{self.repo_name}-{self.branch}'
+        self.branch_file_name: str = f'{self.repo_name}-{self.branch}.{self.branch_file_extension}'
 
         self.api_url = f'https://api.{self.domain}/repos/{self.user_name}/{self.repo_name}'
 
         self.latest_release_json_url: str = f'{self.api_url}/releases/latest'
         self.commits_url: str = f'{self.api_url}/commits'
         self.contents_url: str = f'{self.api_url}/contents'
+        self.branch_download_link = f'{self.api_url}/{self.branch_type_directory}/{self.branch}'
 
     def build_links_from_repo_url(self, **kwargs):
         if not self.repo_url:
@@ -178,48 +190,88 @@ class GitHubWrapper:
         :return:
         """
 
-        headers: dict = self._get_headers()
+        def download_file(file_url: str, target_dir: str, file_name: str, current_headers: dict) -> None:
+            os.makedirs(target_dir, exist_ok=True)
 
-        if not download_each_file:
-            # Download the repo to current working directory, extract and remove the archive.
-            web.download_and_extract_file(
-                file_url=self.branch_download_link,
-                target_directory=target_directory,
-                archive_remove_first_directory=archive_remove_first_directory,
-                headers=headers,
-                **kwargs)
-        else:
-            # Build the URL for the contents API
-            contents_url = f"{self.contents_url}/{self.path}"
+            web.download(
+                file_url=file_url,
+                target_directory=target_dir,
+                file_name=file_name,
+                headers=current_headers
+            )
+
+        def download_directory(folder_path: str, target_dir: str, current_headers: dict) -> None:
+            # Construct the API URL for the current folder.
+            contents_url = f"{self.contents_url}/{folder_path}"
             params = {'ref': self.branch}
 
-            response = requests.get(contents_url, headers=headers, params=params)
+            response = requests.get(contents_url, headers=current_headers, params=params)
             response.raise_for_status()
 
+            # Get the list of items (files and subdirectories) in the folder.
             items = response.json()
 
-            # Ensure the target directory exists.
-            os.makedirs(target_directory, exist_ok=True)
+            # Ensure the local target directory exists.
+            os.makedirs(target_dir, exist_ok=True)
 
+            # Process each item.
             for item in items:
-                item_path = os.path.join(target_directory, item['name'])
+                local_item_path = os.path.join(target_dir, item['name'])
                 if item['type'] == 'file':
-                    # Download the file using the provided download URL.
-                    file_url = item['download_url']
-                    # You can reuse your download function here, passing the headers.
-                    download(
-                        file_url=file_url,
-                        target_directory=target_directory,
+                    download_file(
+                        file_url=item['download_url'],
+                        target_dir=target_dir,
                         file_name=item['name'],
-                        headers=headers
+                        current_headers=current_headers
                     )
                 elif item['type'] == 'dir':
                     # Recursively download subdirectories.
-                    self.download_folder_contents(
-                        folder_path=os.path.join(folder_path, item['name']),
-                        target_directory=item_path
+                    download_directory(
+                        folder_path=f"{folder_path}/{item['name']}",
+                        target_dir=local_item_path,
+                        current_headers=current_headers
                     )
 
+        headers: dict = self._get_headers()
+
+        if not download_each_file:
+            if self.path:
+                download_target_directory = tempfile.mkdtemp()
+                current_archive_remove_first_directory = True
+            else:
+                download_target_directory = target_directory
+                current_archive_remove_first_directory = archive_remove_first_directory
+
+            # Download the repo to current working directory, extract and remove the archive.
+            web.download_and_extract_file(
+                file_url=self.branch_download_link,
+                file_name=self.branch_file_name,
+                target_directory=download_target_directory,
+                archive_remove_first_directory=current_archive_remove_first_directory,
+                headers=headers,
+                **kwargs)
+
+            if self.path:
+                source_path: str = f"{download_target_directory}{os.sep}{self.path}"
+
+                if not archive_remove_first_directory:
+                    target_directory = os.path.join(target_directory, self.path)
+                filesystem.create_directory(target_directory)
+
+                # Move the path to the target directory.
+                filesystem.move_folder_contents_to_folder(
+                    source_path, target_directory)
+
+                # Remove the downloaded branch directory.
+                filesystem.remove_directory(download_target_directory)
+        else:
+            if archive_remove_first_directory:
+                current_target_directory = target_directory
+            else:
+                current_target_directory = os.path.join(target_directory, self.path)
+
+            download_directory(self.path, current_target_directory, headers)
+
     def get_latest_release_url(
             self,
             string_pattern: str,
@@ -430,8 +482,7 @@ def github_wrapper_main(
 
     if download_branch:
         git_wrapper.download_and_extract_branch(
-            target_directory=target_directory, download_each_file=True, download_branch_and_extract=False,
-            archive_remove_first_directory=True)
+            target_directory=target_directory, download_each_file=False, archive_remove_first_directory=True)
 
         return 0
 
@@ -445,5 +496,6 @@ def github_wrapper_main_with_args():
         path=args.path,
         target_directory=args.target_directory,
         pat=args.pat,
-        get_latest_commit_comment=args.get_latest_commit_comment
+        get_latest_commit_comment=args.get_latest_commit_comment,
+        download_branch=args.download_branch
     )

{atomicshop-2.19.11.dist-info → atomicshop-2.19.12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: atomicshop
-Version: 2.19.11
+Version: 2.19.12
 Summary: Atomic functions and classes to make developer life easier
 Author: Denis Kras
 License: MIT License

{atomicshop-2.19.11.dist-info → atomicshop-2.19.12.dist-info}/RECORD

@@ -1,4 +1,4 @@
-atomicshop/__init__.py,sha256=mHi1iDugkcLgj5LyCc_4EL-QVNq95QCoQWv522BGF1c,124
+atomicshop/__init__.py,sha256=XtGdtCQBXBDdG8_6wWA54tuzPJ5IE_hCw_e_N2FoXLM,124
 atomicshop/_basics_temp.py,sha256=6cu2dd6r2dLrd1BRNcVDKTHlsHs_26Gpw8QS6v32lQ0,3699
 atomicshop/_create_pdf_demo.py,sha256=Yi-PGZuMg0RKvQmLqVeLIZYadqEZwUm-4A9JxBl_vYA,3713
 atomicshop/_patch_import.py,sha256=ENp55sKVJ0e6-4lBvZnpz9PQCt3Otbur7F6aXDlyje4,6334
@@ -7,7 +7,7 @@ atomicshop/certificates.py,sha256=MEGj7t3Nt2CHE7yzXrvFTLCOKZG9tJ6Ok5JC2BsFRis,76
 atomicshop/command_line_processing.py,sha256=u5yT9Ger_cu7ni5ID0VFlRbVD46ARHeNC9tRM-_YXrQ,1038
 atomicshop/config_init.py,sha256=50kD2lXP8sgwPekcmAbfADcY46YvXkF-6XIdA7W_638,2501
 atomicshop/console_output.py,sha256=AOSJjrRryE97PAGtgDL03IBtWSi02aNol8noDnW3k6M,4667
-atomicshop/console_user_response.py,sha256=31HIy9QGXa7f-GVR8MzJauQ79E_ZqAeagF3Ks4GGdDU,3234
+atomicshop/console_user_response.py,sha256=OHcjuzWAys6WmfRnMIU_nkJA634kKmJh6T8w1VtUTJM,2714
 atomicshop/datetimes.py,sha256=IQZ66lmta-ZqxYbyHzm_9eugbJFSilXK1e0kfMgoXGg,18371
 atomicshop/diff_check.py,sha256=vxTDccVbGZHEge6Ja9_ArLWwslOUgIoJAdYPylh4cZg,27176
 atomicshop/dns.py,sha256=5Gimq_WY2arqg7BeGmR7P--fGfnH0Dsh8lrOt_H0jRY,6817
@@ -44,8 +44,9 @@ atomicshop/timer.py,sha256=7Zw1KRV0acHCRATMnanyX2MLBb63Hc-6us3rCZ9dNlY,2345
 atomicshop/urls.py,sha256=aJ0NGS9qqaKeqjkkWBs80jaBBg6MYBiPuLIyPGxscVc,1557
 atomicshop/uuids.py,sha256=JSQdm3ZTJiwPQ1gYe6kU0TKS_7suwVrHc8JZDGYlydM,2214
 atomicshop/venvs.py,sha256=D9lwOoObkYoRx-weuoAmbvN-RdSHhVm4DE9TVl-utAs,903
+atomicshop/versioning.py,sha256=e5W6m9AF3__M5nntqI9CqNAeHqkwY9JhlnpYeZ1CEus,970
 atomicshop/virtualization.py,sha256=LPP4vjE0Vr10R6DA4lqhfX_WaNdDGRAZUW0Am6VeGco,494
-atomicshop/web.py,sha256=No3hExQis7cmMay0GdHULG67RMLd5txg-3a-C7CWMd0,12052
+atomicshop/web.py,sha256=uIYt1WHXllc2wwnsW4AOI_IrAEm9j89qAQa4v3nR8Wk,12105
 atomicshop/websocket_parse.py,sha256=aLHWyKqaYqEn_MRBWm2L6rIl6QPmqbVrjEXE_rBzwCw,16711
 atomicshop/a_installs/ubuntu/docker_rootless.py,sha256=9IPNtGZYjfy1_n6ZRt7gWz9KZgR6XCgevjqq02xk-o0,281
 atomicshop/a_installs/ubuntu/docker_sudo.py,sha256=JzayxeyKDtiuT4Icp2L2LyFRbx4wvpyN_bHLfZ-yX5E,281
@@ -192,7 +193,7 @@ atomicshop/wrappers/astw.py,sha256=VkYfkfyc_PJLIOxByT6L7B8uUmKY6-I8XGZl4t_z828,4
 atomicshop/wrappers/configparserw.py,sha256=JwDTPjZoSrv44YKwIRcjyUnpN-FjgXVfMqMK_tJuSgU,22800
 atomicshop/wrappers/cryptographyw.py,sha256=LfzTnwvJE03G6WZryOOf43VKhhnyMakzHpn8DPPCoy4,13252
 atomicshop/wrappers/ffmpegw.py,sha256=wcq0ZnAe0yajBOuTKZCCaKI7CDBjkq7FAgdW5IsKcVE,6031
-atomicshop/wrappers/githubw.py,sha256=razdRRkO-f00-E0cZs7LE8qoLd-Mm8hLOWlqKR3Ng0U,20343
+atomicshop/wrappers/githubw.py,sha256=vaVQg0pkHY63_TfIbCoWmHDPtI2rDPAqMYwsOl3GN78,22559
 atomicshop/wrappers/msiw.py,sha256=GQLqud72nfex3kvO1bJSruNriCYTYX1_G1gSf1MPkIA,6118
 atomicshop/wrappers/numpyw.py,sha256=sBV4gSKyr23kXTalqAb1oqttzE_2XxBooCui66jbAqc,1025
 atomicshop/wrappers/olefilew.py,sha256=biD5m58rogifCYmYhJBrAFb9O_Bn_spLek_9HofLeYE,2051
@@ -328,8 +329,8 @@ atomicshop/wrappers/socketw/statistics_csv.py,sha256=fgMzDXI0cybwUEqAxprRmY3lqbh
 atomicshop/wrappers/winregw/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/wrappers/winregw/winreg_installed_software.py,sha256=Qzmyktvob1qp6Tjk2DjLfAqr_yXV0sgWzdMW_9kwNjY,2345
 atomicshop/wrappers/winregw/winreg_network.py,sha256=AENV88H1qDidrcpyM9OwEZxX5svfi-Jb4N6FkS1xtqA,8851
-atomicshop-2.19.11.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
-atomicshop-2.19.11.dist-info/METADATA,sha256=tSnPcFSBceRSRX3c335xVMPu5zruA6fmE8ifV12MW-8,10631
-atomicshop-2.19.11.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-atomicshop-2.19.11.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
-atomicshop-2.19.11.dist-info/RECORD,,
+atomicshop-2.19.12.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
+atomicshop-2.19.12.dist-info/METADATA,sha256=IjBkWX6cc09byHYWcjX8hdW_eEmXddbKu1h0hNYUybM,10631
+atomicshop-2.19.12.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+atomicshop-2.19.12.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
+atomicshop-2.19.12.dist-info/RECORD,,