atomicshop 2.15.11__py3-none-any.whl → 3.10.5__py3-none-any.whl

atomicshop/wrappers/githubw.py

@@ -1,20 +1,32 @@
 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
-from ..basics import strings
+
+
+class MoreThanOneReleaseFoundError(Exception):
+    pass
+
+class NoReleaseFoundError(Exception):
+    pass
 
 
 class GitHubWrapper:
-    # You also can use '.tar.gz' as extension.
     def __init__(
             self,
             user_name: str = None,
             repo_name: str = None,
             repo_url: str = None,
-            branch: str = 'master',
-            branch_file_extension: str = '.zip'
+            branch: str = 'main',
+            path: str = None,
+            pat: str = None,
+            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
@@ -27,7 +39,11 @@ class GitHubWrapper:
             You can provide the full url to the repository directly and then extract the user_name and repo_name from it
             with the 'build_links_from_repo_url' function.
         :param branch: str, the branch name. The default is 'master'.
-        :param branch_file_extension: str, the branch file extension. The default is '.zip'.
+        :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.
 
         ================================================================================================================
         Usage to download the 'master' branch file:
@@ -62,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')
@@ -77,17 +93,32 @@ class GitHubWrapper:
         self.repo_name: str = repo_name
         self.repo_url: str = repo_url
         self.branch: str = branch
+        self.path: str = path
+        self.pat: str = pat
         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()
+        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()
@@ -95,21 +126,35 @@ class GitHubWrapper:
         if self.repo_url and not self.user_name and not self.repo_name:
             self.build_links_from_repo_url()
 
+    def _get_headers(self) -> dict:
+        """
+        Returns headers for the GitHub API requests. If a personal access token (PAT) is provided, it adds the
+        'Authorization' header.
+        """
+        headers = {}
+        if self.pat:
+            headers['Authorization'] = f'token {self.pat}'
+        return headers
+
     def build_links_from_user_and_repo(self, **kwargs):
         if not self.user_name or not self.repo_name:
-            message = "'user_name' or 'repo_name' is empty."
-            print_api(message, color="red", error_type=True, **kwargs)
+            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.latest_release_json_url: str = \
-            f'https://api.{self.domain}/repos/{self.user_name}/{self.repo_name}/releases/latest'
+        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.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}'
 
     def build_links_from_repo_url(self, **kwargs):
         if not self.repo_url:
-            message = "'repo_url' is empty."
-            print_api(message, color="red", error_type=True, **kwargs)
+            raise ValueError("'repo_url' is empty.")
 
         repo_url_parsed = urls.url_parser(self.repo_url)
         self.check_github_domain(repo_url_parsed['netloc'])
@@ -118,50 +163,297 @@ class GitHubWrapper:
 
         self.build_links_from_user_and_repo()
 
-    def check_github_domain(self, domain):
+    def check_github_domain(
+            self,
+            domain: str
+    ):
         if self.domain not in domain:
             print_api(
                 f'This is not [{self.domain}] domain.', color="red", error_type=True)
 
+    def download_file(
+            self,
+            file_name: str,
+            target_dir: str
+    ) -> str:
+        """
+        Download a single repo file to a local directory.
+
+        :param file_name: string, Full repo-relative path to the file. Example:
+             "eng.traineddata"
+             "script\\English.script"
+        :param target_dir: string, Local directory to save into.
+
+        :return: The local path to the downloaded file.
+        """
+
+        # Normalize to GitHub path format
+        file_path = file_name.replace("\\", "/").strip("/")
+
+        headers = self._get_headers()
+        url = f"{self.contents_url}/{file_path}"
+        params = {"ref": self.branch}
+
+        resp = requests.get(url, headers=headers, params=params)
+        resp.raise_for_status()
+        item = resp.json()
+
+        # Expect a single file object
+        if isinstance(item, list) or item.get("type") != "file":
+            raise ValueError(f"'{file_name}' is not a file in branch '{self.branch}'.")
+
+        download_url = item.get("download_url")
+        if not download_url:
+            raise ValueError(f"Unable to obtain download URL for '{file_name}'.")
+
+        os.makedirs(target_dir, exist_ok=True)
+        local_name = item.get("name") or os.path.basename(file_path)
+
+        from .. import web  # ensure available in your module structure
+        web.download(
+            file_url=download_url,
+            target_directory=target_dir,
+            file_name=local_name,
+            headers=headers,
+        )
+        return os.path.join(target_dir, local_name)
+
+    def download_directory(
+            self,
+            folder_name: str,
+            target_dir: str
+    ) -> None:
+        """
+        Recursively download a repo directory to a local directory.
+
+        :param folder_name: string, Repo-relative directory path to download (e.g., "tests/langs").
+        :param target_dir: string, Local directory to save the folder tree into.
+        """
+        headers = self._get_headers()
+        root_path = folder_name.replace("\\", "/").strip("/")
+
+        def _walk_dir(rel_path: str, local_dir: str) -> None:
+            contents_url = f"{self.contents_url}/{rel_path}" if rel_path else self.contents_url
+            params = {"ref": self.branch}
+
+            response = requests.get(contents_url, headers=headers, params=params)
+            response.raise_for_status()
+            items = response.json()
+
+            # If a file path was passed accidentally, delegate to download_file
+            if isinstance(items, dict) and items.get("type") == "file":
+                self.download_file(rel_path, local_dir)
+                return
+
+            if not isinstance(items, list):
+                raise ValueError(f"Unexpected response shape when listing '{rel_path or '/'}'.")
+
+            os.makedirs(local_dir, exist_ok=True)
+
+            for item in items:
+                name = item["name"]
+                if item["type"] == "file":
+                    self.download_file(f"{rel_path}/{name}" if rel_path else name, local_dir)
+                elif item["type"] == "dir":
+                    _walk_dir(f"{rel_path}/{name}" if rel_path else name, os.path.join(local_dir, name))
+                # ignore symlinks/submodules if present
+
+        _walk_dir(root_path, target_dir)
+
     def download_and_extract_branch(
             self,
             target_directory: str,
             archive_remove_first_directory: bool = False,
+            download_each_file: bool = False,
             **kwargs
     ):
         """
         This function will download the branch file from GitHub, extract the file and remove the file, leaving
         only the extracted folder.
+        If the 'path' was specified during the initialization of the class, only the path will be downloaded.
 
-        :param target_directory:
-        :param archive_remove_first_directory: boolean, sets if archive extract function will extract the archive
+        :param target_directory: str, the target directory to download the branch/path.
+        :param archive_remove_first_directory: boolean, available only if 'path' was not specified during the initialization
+            Sets if archive extract function will extract the archive
             without first directory in the archive. Check reference in the
-            'archiver.zip.extract_archive_with_zipfile' function.
+            'dkarchiver.arch_wrappers.zips.extract_archive_with_zipfile' function.
+        :param download_each_file: bool, available only if 'path' was specified during the initialization of the class.
+            Sets if each file will be downloaded separately.
+
+            True: Meaning the directory '/home/user/Downloads/files/' will be created and each file will be downloaded
+                ('file1.txt', 'file2.txt', 'file3.txt') separately to this directory.
+            False: The branch file will be downloaded to temp directory then the provided path
+                will be extracted from there, then the downloaded branch directory will be removed.
         :return:
         """
 
-        # 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,
-            **kwargs)
+        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)
+
+            self.download_directory(self.path, current_target_directory)
+
+    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,
+            asset_pattern: str,
             exclude_string: 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 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 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()
@@ -174,44 +466,51 @@ class GitHubWrapper:
                 if exclude_string in download_url:
                     download_urls.remove(download_url)
 
-        # Find urls against 'string_pattern'.
-        found_urls = 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.
         if len(found_urls) > 1:
             message = f'More than 1 result found in JSON response, try changing search string or extension.\n' \
                       f'{found_urls}'
-            print_api(message, color="red", error_type=True, **kwargs)
-
-        return found_urls[0]
+            raise MoreThanOneReleaseFoundError(message)
+        elif len(found_urls) == 0:
+            message = f'No result found in JSON response, try changing search string or extension.'
+            raise NoReleaseFoundError(message)
+        else:
+            return found_urls[0]
 
     def download_latest_release(
             self,
             target_directory: str,
-            string_pattern: str,
+            asset_pattern: str,
             exclude_string: str = None,
-            **kwargs):
+            **kwargs
+    ) -> str:
         """
         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:
+        :return: str, the downloaded file path.
         """
 
+        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, **kwargs)
+        downloaded_file_path = web.download(
+            file_url=found_url, target_directory=target_directory, headers=headers, **kwargs)
         return downloaded_file_path
 
     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):
@@ -219,35 +518,219 @@ 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
-            'archiver.zip.extract_archive_with_zipfile' function.
+            'dkarchiver.arch_wrappers.zips.extract_archive_with_zipfile' function.
         :param kwargs: dict, the print arguments for the 'print_api' function.
         :return:
         """
 
+        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,
             target_directory=target_directory,
             archive_remove_first_directory=archive_remove_first_directory,
+            headers=headers,
             **kwargs)
 
-    def get_the_latest_release_json(self):
+    def get_latest_commit(self) -> dict:
         """
-        This function will get the latest releases json.
-        :return:
+        This function retrieves the latest commit on the specified branch.
+        It uses the GitHub API endpoint for commits.
+
+        :return: dict, the latest commit data.
         """
-        response = requests.get(self.latest_release_json_url)
-        return response.json()
 
-    def get_the_latest_release_version_number(self):
+        headers: dict = self._get_headers()
+
+        # Use query parameters to filter commits by branch (sha) and limit results to 1
+        params: dict = {
+            'sha': self.branch,
+            'per_page': 1
+        }
+
+        if self.path:
+            params['path'] = self.path
+
+        response = requests.get(self.commits_url, headers=headers, params=params)
+        response.raise_for_status()  # Raises an HTTPError if the HTTP request returned an unsuccessful status code.
+
+        commits = response.json()
+        if not commits:
+            return {}
+
+        latest_commit = commits[0]
+        return latest_commit
+
+    def get_latest_commit_message(self):
         """
-        This function will get the latest release version number.
-        :return:
+        This function retrieves the commit message (comment) of the latest commit on the specified branch.
+        It uses the GitHub API endpoint for commits.
+
+        :return: str, the commit message of the latest commit.
+        """
+
+        latest_commit: dict = self.get_latest_commit()
+
+        commit_message = latest_commit.get("commit", {}).get("message", "")
+        return commit_message
+
+    def list_files(
+            self,
+            pattern: str = "*",
+            recursive: bool = True,
+            path: str | None = None,
+    ) -> list[str]:
+        """
+        List files in the repository (or in a specific subfolder).
+
+        :param pattern: Glob-style pattern (e.g., "*.ex*", "*test*.py"). Matching is done
+            against the file's base name (not the full path).
+        :param recursive: If True, include files in all subfolders (returns full repo-relative
+            paths). If False, list only the immediate files in the chosen folder.
+        :param path: Optional subfolder to list from (e.g., "tests/langs"). If omitted,
+            uses self.path if set, otherwise the repo root.
+
+        :return: A list of repo-relative file paths that match the pattern.
         """
-        return self.get_the_latest_release_json()['tag_name']
+        headers = self._get_headers()
+        base_path = (path or self.path or "").strip("/")
+
+        if recursive:
+            # Use the Git Trees API to fetch all files in one call, then filter.
+            tree_url = f"{self.api_url}/git/trees/{self.branch}"
+            params = {"recursive": "1"}
+            resp = requests.get(tree_url, headers=headers, params=params)
+            resp.raise_for_status()
+            data = resp.json()
+
+            files = []
+            for entry in data.get("tree", []):
+                if entry.get("type") != "blob":
+                    continue  # only files
+                entry_path = entry.get("path", "")
+                # If a base_path was provided, keep only files under it
+                if base_path and not entry_path.startswith(base_path + "/") and entry_path != base_path:
+                    continue
+                # Match pattern against the *file name* (basename)
+                if fnmatch.fnmatch(os.path.basename(entry_path), pattern):
+                    files.append(entry_path)
+            return files
+
+        else:
+            # Non-recursive: use the Contents API to list a single directory.
+            # If base_path is empty, list the repo root.
+            if base_path:
+                contents_url = f"{self.contents_url}/{base_path}"
+            else:
+                contents_url = self.contents_url
+
+            params = {"ref": self.branch}
+            resp = requests.get(contents_url, headers=headers, params=params)
+            resp.raise_for_status()
+            items = resp.json()
+
+            # The Contents API returns a dict when the path points to a single file;
+            # normalize to a list to simplify handling.
+            if isinstance(items, dict):
+                items = [items]
+
+            files = []
+            for item in items:
+                if item.get("type") == "file":
+                    name = item.get("name", "")
+                    if fnmatch.fnmatch(name, pattern):
+                        # item["path"] is the full repo-relative path we want to return
+                        files.append(item.get("path", name))
+            return files
+
+
+def _make_parser():
+    import argparse
+
+    parser = argparse.ArgumentParser(description='GitHub Wrapper')
+    parser.add_argument(
+        '-u', '--repo_url', type=str, required=True,
+        help='The repository url. Example: https://github.com/{user_name}/{repo_name}')
+    parser.add_argument(
+        '-b', '--branch', type=str, required=True,
+        help='The branch name. The specific branch from the repo you want to operate on.')
+    parser.add_argument(
+        '-p', '--path', type=str, default=None,
+        help="The path to the file/folder inside the repo that we'll do certain actions on.\n"
+             "Available actions: get_latest_commit_message, download_path_from_branch.")
+    parser.add_argument(
+        '-t', '--target_directory', type=str, default=None,
+        help='The target directory to download the file/folder.'
+    )
+    parser.add_argument(
+        '--pat', type=str, default=None,
+        help='The personal access token to the repo.')
+    parser.add_argument(
+        '-glcm', '--get_latest_commit_message', action='store_true', default=False,
+        help='Sets if the latest commit message comment will be printed.')
+    parser.add_argument(
+        '-glcj', '--get_latest_commit_json', action='store_true', default=False,
+        help='Sets if the latest commit json will be printed.')
+    parser.add_argument(
+        '-db', '--download_branch', action='store_true', default=False,
+        help='Sets if the branch will be downloaded. In conjunction with path, only the path will be downloaded.')
+
+    return parser
+
+
+def github_wrapper_main(
+        repo_url: str,
+        branch: str,
+        path: str = None,
+        target_directory: str = None,
+        pat: str = None,
+        get_latest_commit_message: bool = False,
+        get_latest_commit_json: bool = False,
+        download_branch: bool = False
+):
+    """
+    This function is the main function for the GitHubWrapper class.
+    :param repo_url: str, the repository url.
+        Example: https://github.com/{user_name}/{repo_name}
+    :param branch: str, the branch name. The specific branch from the repo you want to operate on.
+    :param path: str, the path to the file/folder for which the commit message should be retrieved.
+    :param target_directory: str, the target directory to download the file/folder.
+    :param pat: str, the personal access token to the repo.
+    :param get_latest_commit_json: bool, sets if the latest commit json will be printed.
+    :param get_latest_commit_message: bool, sets if the latest commit message comment will be printed.
+    :param download_branch: bool, sets if the branch will be downloaded. In conjunction with path, only the path will be
+        downloaded.
+    :return:
+    """
+
+    git_wrapper = GitHubWrapper(repo_url=repo_url, branch=branch, path=path, pat=pat)
+
+    if get_latest_commit_message:
+        commit_comment = git_wrapper.get_latest_commit_message()
+        print_api(commit_comment)
+        return 0
+
+    if get_latest_commit_json:
+        latest_commit_json = git_wrapper.get_latest_commit()
+        print_api(latest_commit_json)
+        return 0
+
+    if download_branch:
+        git_wrapper.download_and_extract_branch(
+            target_directory=target_directory, download_each_file=False, archive_remove_first_directory=True)
+
+        return 0
+
+
+def github_wrapper_main_with_args():
+    main_parser = _make_parser()
+    args = main_parser.parse_args()
+
+    return github_wrapper_main(**vars(args))