atomicshop 3.3.3__py3-none-any.whl → 3.3.4__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__ = '3.3.3'
+__version__ = '3.3.4'

atomicshop/wrappers/githubw.py

@@ -78,7 +78,7 @@ class GitHubWrapper:
         Usage to download the latest release where the file name is 'test_file.zip':
             git_wrapper = GitHubWrapper(user_name='user_name', repo_name='repo_name')
             git_wrapper.download_and_extract_latest_release(
-                target_directory='target_directory', string_pattern='test_*.zip')
+                target_directory='target_directory', asset_pattern='test_*.zip')
         ================================================================================================================
         Usage to get the latest release json:
             git_wrapper = GitHubWrapper(user_name='user_name', repo_name='repo_name')
@@ -116,6 +116,10 @@ class GitHubWrapper:
         self.commits_url: str = str()
         self.contents_url: str = str()
 
+        self.releases_url: str = str()
+        self.releases_per_page: int = 100
+        self.releases_starting_page: int = 1
+
         if self.user_name and self.repo_name and not self.repo_url:
             self.build_links_from_user_and_repo()
 
@@ -143,6 +147,7 @@ class GitHubWrapper:
         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.releases_url: str = f'{self.api_url}/releases'
         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}'
@@ -272,21 +277,133 @@ class GitHubWrapper:
 
             download_directory(self.path, current_target_directory, headers)
 
+    def get_releases_json(
+            self,
+            asset_pattern: str = None,
+            latest: bool = False,
+            per_page: int = None,
+            starting_page: int = None,
+            all_assets: bool = False,
+    ):
+        """
+        This function will get the releases json.
+        :param asset_pattern: str, the string pattern to search in the asset names of releases. Wildcards can be used.
+            If there is a match, the release will be added to the result list.
+        :param latest: bool, if True, will get only the latest release.
+            If 'asset_pattern' is provided, 'latest' will find the latest release matching the pattern.
+            Of course if you want to get it from all releases, you must set 'all_assets' to True.
+        :param per_page: int, the number of releases per page. Default is 100.
+        :param starting_page: int, the starting page number. Default is 1.
+        :param all_assets: bool, if True, will get all releases matching the pattern across all pages
+            OR all assets if no pattern is provided.
+        :return:
+        """
+
+        # If 'latest' is True and no 'asset_pattern' is provided, we only need to get 1 release from page 1.
+        # No need to get more assets than the first one.
+        if latest and not asset_pattern:
+            per_page = 1
+            starting_page = 1
+            all_assets = False
+        # In all other cases, get the releases according to the provided parameters or defaults.
+        else:
+            if not per_page:
+                per_page = self.releases_per_page
+
+            if not starting_page:
+                starting_page = self.releases_starting_page
+
+        headers: dict = self._get_headers()
+
+        params: dict = {
+            'per_page': per_page,
+            'page': starting_page
+        }
+
+        all_releases = []
+        while True:
+            response = requests.get(self.releases_url, headers=headers, params=params)
+            releases = response.json()
+            # If no releases found on current page, there will be none on the next as well, break the loop.
+            if not releases:
+                break
+
+            # If 'asset_pattern' is provided, filter releases to only those that have matching assets.
+            if asset_pattern:
+                for release in releases:
+                    assets = release.get('assets', [])
+                    matching_assets = [asset for asset in assets if fnmatch.fnmatch(asset.get('name', ''), asset_pattern)]
+                    if matching_assets:
+                        all_releases.append(release)
+
+                        if latest:
+                            return all_releases
+            else:
+                all_releases.extend(releases)
+
+            if not all_assets:
+                break
+
+            params['page'] += 1
+
+        return all_releases
+
+    def get_latest_release_json(
+            self,
+            asset_pattern: str = None
+    ) -> dict:
+        """
+        This function will get the latest releases json.
+        :param asset_pattern: str, the string pattern to search in the asset names of releases. Wildcards can be used.
+            If there is a match, the release will be added to the result list.
+        :return: dict, the latest release json.
+        """
+
+        if asset_pattern:
+            releases = self.get_releases_json(
+                asset_pattern=asset_pattern,
+                latest=True,
+                all_assets=True
+            )
+        else:
+            releases = self.get_releases_json(latest=True)
+
+        if not releases:
+            return {}
+        else:
+            return releases[0]
+
+    def get_latest_release_version(
+            self,
+            asset_pattern: str = None
+    ) -> str:
+        """
+        This function will get the latest release version number.
+
+        :param asset_pattern: str, the string pattern to search in the asset names of releases. Wildcards can be used.
+            If there is a match, the release will be added to the result list.
+        :return: str, the latest release version number.
+        """
+
+        latest_release_json: dict = self.get_latest_release_json(asset_pattern=asset_pattern)
+        latest_release_version: str = latest_release_json['tag_name']
+        return latest_release_version
+
     def get_latest_release_url(
             self,
-            string_pattern: str,
-            exclude_string: str = None,
+            asset_pattern: str,
+            exclude_pattern: str = None,
             **kwargs):
         """
         This function will return the latest release url.
-        :param string_pattern: str, the string pattern to search in the latest release. Wildcards can be used.
-        :param exclude_string: str, the string to exclude from the search. No wildcards can be used.
+        :param asset_pattern: str, the string pattern to search in the latest release. Wildcards can be used.
+        :param exclude_pattern: str, the string to exclude from the search. No wildcards can be used.
         :param kwargs: dict, the print arguments for the 'print_api' function.
         :return: str, the latest release url.
         """
 
         # Get the 'assets' key of the latest release json.
-        github_latest_releases_list = self.get_the_latest_release_json()['assets']
+        github_latest_releases_list = self.get_latest_release_json()['assets']
 
         # Get only download urls of the latest releases.
         download_urls: list = list()
@@ -294,13 +411,13 @@ class GitHubWrapper:
             download_urls.append(single_dict['browser_download_url'])
 
         # Exclude urls against 'exclude_string'.
-        if exclude_string:
+        if exclude_pattern:
             for download_url in download_urls:
-                if exclude_string in download_url:
+                if exclude_pattern in download_url:
                     download_urls.remove(download_url)
 
-        # Find urls against 'string_pattern'.
-        found_urls: list = fnmatch.filter(download_urls, string_pattern)
+        # Find urls against 'asset_pattern'.
+        found_urls: list = fnmatch.filter(download_urls, asset_pattern)
 
         # If more than 1 url answer the criteria, we can't download it. The user must be more specific in his input
         # strings.
@@ -317,15 +434,15 @@ class GitHubWrapper:
     def download_latest_release(
             self,
             target_directory: str,
-            string_pattern: str,
+            asset_pattern: str,
             exclude_string: str = None,
             **kwargs):
         """
         This function will download the latest release from the GitHub repository.
         :param target_directory: str, the target directory to download the file.
-        :param string_pattern: str, the string pattern to search in the latest release. Wildcards can be used.
+        :param asset_pattern: str, the string pattern to search in the latest release. Wildcards can be used.
         :param exclude_string: str, the string to exclude from the search. No wildcards can be used.
-            The 'excluded_string' will be filtered before the 'string_pattern' entries.
+            The 'excluded_string' will be filtered before the 'asset_pattern' entries.
         :param kwargs: dict, the print arguments for the 'print_api' function.
         :return:
         """
@@ -333,7 +450,7 @@ class GitHubWrapper:
         headers: dict = self._get_headers()
 
         # Get the latest release url.
-        found_url = self.get_latest_release_url(string_pattern=string_pattern, exclude_string=exclude_string, **kwargs)
+        found_url = self.get_latest_release_url(asset_pattern=asset_pattern, exclude_string=exclude_string, **kwargs)
 
         downloaded_file_path = web.download(
             file_url=found_url, target_directory=target_directory, headers=headers, **kwargs)
@@ -342,7 +459,7 @@ class GitHubWrapper:
     def download_and_extract_latest_release(
             self,
             target_directory: str,
-            string_pattern: str,
+            asset_pattern: str,
             exclude_string: str = None,
             archive_remove_first_directory: bool = False,
             **kwargs):
@@ -350,7 +467,7 @@ class GitHubWrapper:
         This function will download the latest release from the GitHub repository, extract the file and remove the file,
         leaving only the extracted folder.
         :param target_directory: str, the target directory to download and extract the file.
-        :param string_pattern: str, the string pattern to search in the latest release. Wildcards can be used.
+        :param asset_pattern: str, the string pattern to search in the latest release. Wildcards can be used.
         :param exclude_string: str, the string to exclude from the search. No wildcards can be used.
         :param archive_remove_first_directory: bool, sets if archive extract function will extract the archive
             without first directory in the archive. Check reference in the
@@ -362,7 +479,7 @@ class GitHubWrapper:
         headers: dict = self._get_headers()
 
         # Get the latest release url.
-        found_url = self.get_latest_release_url(string_pattern=string_pattern, exclude_string=exclude_string, **kwargs)
+        found_url = self.get_latest_release_url(asset_pattern=asset_pattern, exclude_string=exclude_string, **kwargs)
 
         web.download_and_extract_file(
             file_url=found_url,
@@ -371,24 +488,6 @@ class GitHubWrapper:
             headers=headers,
             **kwargs)
 
-    def get_the_latest_release_json(self):
-        """
-        This function will get the latest releases json.
-        :return:
-        """
-
-        headers: dict = self._get_headers()
-
-        response = requests.get(self.latest_release_json_url, headers=headers)
-        return response.json()
-
-    def get_the_latest_release_version_number(self):
-        """
-        This function will get the latest release version number.
-        :return:
-        """
-        return self.get_the_latest_release_json()['tag_name']
-
     def get_latest_commit(self) -> dict:
         """
         This function retrieves the latest commit on the specified branch.

atomicshop/wrappers/socketw/sni.py

@@ -274,7 +274,7 @@ class SNIHandler:
 
             # Setting "server_hostname" as a domain.
             self.sni_received_parameters.ssl_socket.server_hostname = self.sni_received_parameters.destination_name
-            print_api("SNI Passed: True", color="yellow", **(print_kwargs or {}))
+            print_api("SNI Passed: True", **(print_kwargs or {}))
             message = (
                 f"SNI Handler: port {self.sni_received_parameters.ssl_socket.getsockname()[1]}: "
                 f"Incoming connection for [{self.sni_received_parameters.ssl_socket.server_hostname}]")

{atomicshop-3.3.3.dist-info → atomicshop-3.3.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: atomicshop
-Version: 3.3.3
+Version: 3.3.4
 Summary: Atomic functions and classes to make developer life easier
 Author: Denis Kras
 License-Expression: MIT

{atomicshop-3.3.3.dist-info → atomicshop-3.3.4.dist-info}/RECORD

@@ -1,4 +1,4 @@
-atomicshop/__init__.py,sha256=A47BWVHvVET6LMVlCSW87U79q8X9M4kwmxOtynSkYqA,122
+atomicshop/__init__.py,sha256=-H5JgHG0iCCH8pC2RNRvzeaxBh2DD3LjRloFS8OdaVQ,122
 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
@@ -197,7 +197,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=QEUpDn8vUvMg3ADz6-4oC2kbDNC_woDlw7C0zU7qFVM,14233
 atomicshop/wrappers/ffmpegw.py,sha256=wcq0ZnAe0yajBOuTKZCCaKI7CDBjkq7FAgdW5IsKcVE,6031
-atomicshop/wrappers/githubw.py,sha256=DrFF_oN-rulPQV1iKgVzZadCjuYuCC5eKAjZp_3YD0g,23476
+atomicshop/wrappers/githubw.py,sha256=bds_8fgyFyHXKwty6-SBS3H3Ueta2IMM5UQFpiFmgHQ,27554
 atomicshop/wrappers/msiw.py,sha256=GQLqud72nfex3kvO1bJSruNriCYTYX1_G1gSf1MPkIA,6118
 atomicshop/wrappers/netshw.py,sha256=8WE_576XiiHykwFuE-VkCx5CydMpFlztX4frlEteCtI,6350
 atomicshop/wrappers/numpyw.py,sha256=sBV4gSKyr23kXTalqAb1oqttzE_2XxBooCui66jbAqc,1025
@@ -328,7 +328,7 @@ atomicshop/wrappers/socketw/exception_wrapper.py,sha256=qW_1CKyPgGlsIt7_jusKkMV4
 atomicshop/wrappers/socketw/get_process.py,sha256=aJC-_qFUv3NgWCSUzDI72E4z8_-VTZE9NVZ0CwUoNlM,5698
 atomicshop/wrappers/socketw/receiver.py,sha256=9B3MvcDqr4C3x2fsnjG5SQognd1wRqsBgikxZa0wXG8,8243
 atomicshop/wrappers/socketw/sender.py,sha256=aX_K8l_rHjd5AWb8bi5mt8-YTkMYVRDB6DnPqK_XDUE,4754
-atomicshop/wrappers/socketw/sni.py,sha256=GaYnn-CFFmA1WcyFXqICnSLfkM2CNAeS8fTZsruLoaI,17927
+atomicshop/wrappers/socketw/sni.py,sha256=YlKavbExcPFfHFLYAJ3i3W6QorY7o4mbQp39g-DnDKA,17911
 atomicshop/wrappers/socketw/socket_client.py,sha256=McBd3DeCy787oDGCEMUEP2awWy3vdkPqr9w-aFh2fBM,22502
 atomicshop/wrappers/socketw/socket_server_tester.py,sha256=Qobmh4XV8ZxLUaw-eW4ESKAbeSLecCKn2OWFzMhadk0,6420
 atomicshop/wrappers/socketw/socket_wrapper.py,sha256=u_v0pjMMrgsdtI0iPPddiLe2wXnBoqTgNM9Y3zjGD4U,41013
@@ -337,9 +337,9 @@ atomicshop/wrappers/socketw/statistics_csv.py,sha256=_gA8bMX6Sw_UCXKi2y9wNAwlqif
 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=ih0BVNwByLvf9F_Lac4EdmDYYJA3PzMvmG0PieDZrsE,9905
-atomicshop-3.3.3.dist-info/licenses/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
-atomicshop-3.3.3.dist-info/METADATA,sha256=_zTFWmzEYji52hVTJBoGFrdrjSxlo6wS1AhAhq0qHqQ,9288
-atomicshop-3.3.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-atomicshop-3.3.3.dist-info/entry_points.txt,sha256=SJEgEP0KoFtfxuGwe5tOzKfXkjR9Dv6YYug33KNYxyY,69
-atomicshop-3.3.3.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
-atomicshop-3.3.3.dist-info/RECORD,,
+atomicshop-3.3.4.dist-info/licenses/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
+atomicshop-3.3.4.dist-info/METADATA,sha256=AA-i4jzN5U9DaSNf-Hv_TuHfoMUeOR9-53KcyzR2xik,9288
+atomicshop-3.3.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+atomicshop-3.3.4.dist-info/entry_points.txt,sha256=SJEgEP0KoFtfxuGwe5tOzKfXkjR9Dv6YYug33KNYxyY,69
+atomicshop-3.3.4.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
+atomicshop-3.3.4.dist-info/RECORD,,