ScriptCollection 3.5.137__py3-none-any.whl → 3.5.139__py3-none-any.whl

ScriptCollection/Executables.py

@@ -8,6 +8,7 @@ import keyboard
 from .TasksForCommonProjectStructure import TasksForCommonProjectStructure
 from .ScriptCollectionCore import ScriptCollectionCore
 from .GeneralUtilities import GeneralUtilities
+from .ImageUpdater import ImageUpdater, VersionEcholon
 
 
 def FilenameObfuscator() -> int:
@@ -635,7 +636,7 @@ def Espoc() -> int:
     parser.add_argument('-p', '--processid', required=True)
     parser.add_argument('-f', '--file', required=True, help='Specifies the file where the process-ids of the started processes are stored (line by line). This file will be deleted when all started processes are terminated.')
     args = parser.parse_args()
-    process_id =int(args.processid)
+    process_id = int(args.processid)
     process_list_file: str = args.file
     if not os.path.isabs(process_list_file):
         process_list_file = GeneralUtilities.resolve_relative_path(process_list_file, os.getcwd())
@@ -654,10 +655,74 @@ def Espoc() -> int:
         GeneralUtilities.write_message_to_stdout(f"File '{process_list_file}' does not exist. No processes to terminate.")
     return 0
 
-def ConvertGitRepositoryToBareRepository()->int:
+
+def ConvertGitRepositoryToBareRepository() -> int:
     parser = argparse.ArgumentParser(description="Converts a local git-repository to a bare repository.")
     parser.add_argument('-f', '--folder', required=True, help='Git-repository-folder which should be converted.')
     args = parser.parse_args()
-    sc=ScriptCollectionCore()
+    sc = ScriptCollectionCore()
     sc.convert_git_repository_to_bare_repository(args.folder)
     return 0
+
+
+def OCRAnalysisOfFolder() -> int:
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-s', '--serviceaddress', required=False, default=None)
+    parser.add_argument('-e', '--extensions', required=False, default=None)
+    parser.add_argument('-l', '--languages', required=False, default="en")
+    parser.add_argument('-f', '--folder', required=False, default=None)
+    args = parser.parse_args()
+    sc = ScriptCollectionCore()
+    if args.folder is None:
+        args.folder = os.getcwd()
+    extensions_value: str = None
+    if args.extensions is not None:
+        if "," in args.extensions:
+            extensions_value = args.extensions.split(",")
+        else:
+            extensions_value = [args.extensions]
+    sc.ocr_analysis_of_folder(args.folder, args.serviceaddress, extensions_value, args.languages)
+    return 0
+
+
+def OCRAnalysisOfFile() -> int:
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-s', '--serviceaddress', required=False, default=None)
+    parser.add_argument('-l', '--languages', required=False, default="en")
+    parser.add_argument('-f', '--file', required=True)
+    args = parser.parse_args()
+    sc = ScriptCollectionCore()
+    sc.ocr_analysis_of_file(args.file, args.serviceaddress, args.languages)
+    return 0
+
+
+def OCRAnalysisOfRepository() -> int:
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-s', '--serviceaddress', required=False, default=None)
+    parser.add_argument('-e', '--extensions', required=False, default=None)
+    parser.add_argument('-l', '--languages', required=False, default="en")
+    parser.add_argument('-f', '--folder', required=False, default=None)
+    args = parser.parse_args()
+    sc = ScriptCollectionCore()
+    if args.folder is None:
+        args.folder = os.getcwd()
+    extensions_value: str = None
+    if args.extensions is not None:
+        if "," in args.extensions:
+            extensions_value = args.extensions.split(",")
+        else:
+            extensions_value = [args.extensions]
+    sc.ocr_analysis_of_repository(args.folder, args.serviceaddress, extensions_value, args.languages)
+    return 0
+
+
+def UpdateImagesInDockerComposeFile() -> int:
+    iu: ImageUpdater = ImageUpdater()
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-f', '--file', required=False, default=None)
+    # TODO add option to specify ignored services and versionecholon
+    args = parser.parse_args()
+    if args.file is None:
+        args.file = os.path.join(os.getcwd(), "docker-compose.yml")
+    iu.update_all_services_in_docker_compose_file(args.file, VersionEcholon.LatestPatch, [])
+    return 0

ScriptCollection/ImageUpdater.py

@@ -11,7 +11,7 @@ from .GeneralUtilities import GeneralUtilities
 
 
 class VersionEcholon(Enum):
-    Patch = 0
+    LatestPatch = 0
     LatestPatchOrLatestMinor = 1
     LatestPatchOrLatestMinorOrNextMajor = 2
     Newest = 3
@@ -63,8 +63,8 @@ class ImageUpdaterHelper:
 
     @staticmethod
     @GeneralUtilities.check_arguments
-    def filter_considering_echolog(newer_versions: list[Version], current_version: Version, version_echolon: VersionEcholon) -> Version:
-        if version_echolon == VersionEcholon.Patch:
+    def filter_considering_echolon(newer_versions: list[Version], current_version: Version, version_echolon: VersionEcholon) -> Version:
+        if version_echolon == VersionEcholon.LatestPatch:
             return ImageUpdaterHelper._internal_get_latest_patch_version(newer_versions, current_version)
         elif version_echolon == VersionEcholon.LatestPatchOrLatestMinor:
             return ImageUpdaterHelper._internal_get_latest_patch_or_latest_minor_version(newer_versions, current_version)
@@ -137,11 +137,14 @@ class ConcreteImageUpdaterForNginx(ConcreteImageUpdater):
 
     @GeneralUtilities.check_arguments
     def version_to_tag(self,  version: Version) -> str:
-        raise NotImplementedError
+        return f"{version.major}.{version.minor}.{version.micro}"
 
     @GeneralUtilities.check_arguments
     def get_latest_version_of_image(self,  image: str, version_echolon: VersionEcholon, current_version: Version) -> Version:
-        raise NotImplementedError
+        versions = ImageUpdaterHelper.get_versions_in_docker_hub(image, ".", "^\\d+\\.\\d+\\.\\d+$", 999)
+        newer_versions = ImageUpdaterHelper.filter_for_newer_versions(current_version, versions)
+        result = ImageUpdaterHelper.filter_considering_echolon(newer_versions, current_version, version_echolon)
+        return result
 
     @GeneralUtilities.check_arguments
     def get_supported_images(self) -> list[str]:
@@ -149,14 +152,36 @@ class ConcreteImageUpdaterForNginx(ConcreteImageUpdater):
 
     @GeneralUtilities.check_arguments
     def get_version_from_tag(self, image: str, tag: str) -> Version:
-        raise NotImplementedError
+        return ve.parse(tag)
+
+
+class ConcreteImageUpdaterForWordpress(ConcreteImageUpdater):
+
+    @GeneralUtilities.check_arguments
+    def version_to_tag(self,  version: Version) -> str:
+        return f"{version.major}.{version.minor}.{version.micro}"
+
+    @GeneralUtilities.check_arguments
+    def get_latest_version_of_image(self,  image: str, version_echolon: VersionEcholon, current_version: Version) -> Version:
+        versions = ImageUpdaterHelper.get_versions_in_docker_hub(image, ".", "^\\d+\\.\\d+\\.\\d+$", 999)
+        newer_versions = ImageUpdaterHelper.filter_for_newer_versions(current_version, versions)
+        result = ImageUpdaterHelper.filter_considering_echolon(newer_versions, current_version, version_echolon)
+        return result
+
+    @GeneralUtilities.check_arguments
+    def get_supported_images(self) -> list[str]:
+        return ["wordpress"]
+
+    @GeneralUtilities.check_arguments
+    def get_version_from_tag(self, image: str, tag: str) -> Version:
+        return ve.parse(tag)
 
 
 class ConcreteImageUpdaterForGitLab(ConcreteImageUpdater):
 
     @GeneralUtilities.check_arguments
     def version_to_tag(self,  version: Version) -> str:
-        raise NotImplementedError
+        return f"{version.major}.{version.minor}.{version.micro}-ce.0"
 
     @GeneralUtilities.check_arguments
     def get_latest_version_of_image(self,  image: str, version_echolon: VersionEcholon, current_version: Version) -> Version:
@@ -175,96 +200,111 @@ class ConcreteImageUpdaterForRegistry(ConcreteImageUpdater):
 
     @GeneralUtilities.check_arguments
     def version_to_tag(self,  version: Version) -> str:
-        raise NotImplementedError
+        return f"{version.major}.{version.minor}.{version.micro}"
 
     @GeneralUtilities.check_arguments
     def get_latest_version_of_image(self,  image: str, version_echolon: VersionEcholon, current_version: Version) -> Version:
-        raise NotImplementedError
+        versions = ImageUpdaterHelper.get_versions_in_docker_hub(image, ".", "^\\d+\\.\\d+\\.\\d+$", 999)
+        newer_versions = ImageUpdaterHelper.filter_for_newer_versions(current_version, versions)
+        result = ImageUpdaterHelper.filter_considering_echolon(newer_versions, current_version, version_echolon)
+        return result
 
     @abstractmethod
     @GeneralUtilities.check_arguments
     def get_supported_images(self) -> list[str]:
-        return []  # TODO
+        return ["registry"]
 
     @GeneralUtilities.check_arguments
     def get_version_from_tag(self, image: str, tag: str) -> Version:
-        raise NotImplementedError
+        return ve.parse(tag)
 
 
 class ConcreteImageUpdaterForPrometheus(ConcreteImageUpdater):
 
     @GeneralUtilities.check_arguments
     def version_to_tag(self,  version: Version) -> str:
-        raise NotImplementedError
+        return f"v{version.major}.{version.minor}.{version.micro}"
 
     @GeneralUtilities.check_arguments
     def get_latest_version_of_image(self,  image: str, version_echolon: VersionEcholon, current_version: Version) -> Version:
-        raise NotImplementedError
+        versions = ImageUpdaterHelper.get_versions_in_docker_hub(image, ".", "^v\\d+\\.\\d+\\.\\d+$", 999)
+        newer_versions = ImageUpdaterHelper.filter_for_newer_versions(current_version, versions)
+        result = ImageUpdaterHelper.filter_considering_echolon(newer_versions, current_version, version_echolon)
+        return result
 
     @GeneralUtilities.check_arguments
     def get_supported_images(self) -> list[str]:
-        return []  # TODO
+        return ["prom/prometheus"]
 
     @GeneralUtilities.check_arguments
     def get_version_from_tag(self, image: str, tag: str) -> Version:
-        raise NotImplementedError
+        return ve.parse(tag[1:])
 
 
 class ConcreteImageUpdaterForPrometheusBlackboxExporter(ConcreteImageUpdater):
 
     @GeneralUtilities.check_arguments
     def version_to_tag(self,  version: Version) -> str:
-        raise NotImplementedError
+        return f"v{version.major}.{version.minor}.{version.micro}"
 
     @GeneralUtilities.check_arguments
     def get_latest_version_of_image(self,  image: str, version_echolon: VersionEcholon, current_version: Version) -> Version:
-        raise NotImplementedError
+        versions = ImageUpdaterHelper.get_versions_in_docker_hub(image, ".", "^v\\d+\\.\\d+\\.\\d+$", 999)
+        newer_versions = ImageUpdaterHelper.filter_for_newer_versions(current_version, versions)
+        result = ImageUpdaterHelper.filter_considering_echolon(newer_versions, current_version, version_echolon)
+        return result
 
     @GeneralUtilities.check_arguments
     def get_supported_images(self) -> list[str]:
-        return []  # TODO
+        return ["prom/blackbox-exporter"]
 
     @GeneralUtilities.check_arguments
     def get_version_from_tag(self, image: str, tag: str) -> Version:
-        raise NotImplementedError
+        return ve.parse(tag[1:])
 
 
 class ConcreteImageUpdaterForPrometheusNginxExporter(ConcreteImageUpdater):
 
     @GeneralUtilities.check_arguments
     def version_to_tag(self,  version: Version) -> str:
-        raise NotImplementedError
+        return f"v{version.major}.{version.minor}.{version.micro}"
 
     @GeneralUtilities.check_arguments
     def get_latest_version_of_image(self,  image: str, version_echolon: VersionEcholon, current_version: Version) -> Version:
-        raise NotImplementedError
+        versions = ImageUpdaterHelper.get_versions_in_docker_hub(image, ".", "^v\\d+\\.\\d+\\.\\d+$", 999)
+        newer_versions = ImageUpdaterHelper.filter_for_newer_versions(current_version, versions)
+        result = ImageUpdaterHelper.filter_considering_echolon(newer_versions, current_version, version_echolon)
+        return result
 
     @GeneralUtilities.check_arguments
     def get_supported_images(self) -> list[str]:
-        return []  # TODO
+        return ["prom/nginx-prometheus-exporter"]
 
     @GeneralUtilities.check_arguments
     def get_version_from_tag(self, image: str, tag: str) -> Version:
-        raise NotImplementedError
+        return ve.parse(tag[1:])
 
 
 class ConcreteImageUpdaterForPrometheusNodeExporter(ConcreteImageUpdater):
 
     @GeneralUtilities.check_arguments
     def version_to_tag(self,  version: Version) -> str:
-        raise NotImplementedError
+        return f"v{version.major}.{version.minor}.{version.micro}"
 
     @GeneralUtilities.check_arguments
     def get_latest_version_of_image(self,  image: str, version_echolon: VersionEcholon, current_version: Version) -> Version:
-        raise NotImplementedError
+        versions = ImageUpdaterHelper.get_versions_in_docker_hub(image, ".", "^v\\d+\\.\\d+\\.\\d+$", 999)
+        newer_versions = ImageUpdaterHelper.filter_for_newer_versions(current_version, versions)
+        result = ImageUpdaterHelper.filter_considering_echolon(newer_versions, current_version, version_echolon)
+        return result
 
     @GeneralUtilities.check_arguments
     def get_supported_images(self) -> list[str]:
-        return []  # TODO
+        return ["prom/node-exporter"]
 
     @GeneralUtilities.check_arguments
     def get_version_from_tag(self, image: str, tag: str) -> Version:
-        raise NotImplementedError
+        return ve.parse(tag[1:])
 
 
 class ConcreteImageUpdaterForKeycloak(ConcreteImageUpdater):
@@ -296,7 +336,7 @@ class ConcreteImageUpdaterForMariaDB(ConcreteImageUpdater):
     def get_latest_version_of_image(self,  image: str, version_echolon: VersionEcholon, current_version: Version) -> Version:
         versions = ImageUpdaterHelper.get_versions_in_docker_hub(image, ".", "^\\d+\\.\\d+\\.\\d+$", 999)
         newer_versions = ImageUpdaterHelper.filter_for_newer_versions(current_version, versions)
-        result = ImageUpdaterHelper.filter_considering_echolog(newer_versions, current_version, version_echolon)
+        result = ImageUpdaterHelper.filter_considering_echolon(newer_versions, current_version, version_echolon)
         return result
 
     @GeneralUtilities.check_arguments
@@ -312,19 +352,22 @@ class ConcreteImageUpdaterForPostgreSQL(ConcreteImageUpdater):
 
     @GeneralUtilities.check_arguments
     def version_to_tag(self,  version: Version) -> str:
-        raise NotImplementedError
+        return f"{version.major}.{version.minor}"
 
     @GeneralUtilities.check_arguments
     def get_latest_version_of_image(self,  image: str, version_echolon: VersionEcholon, current_version: Version) -> Version:
-        raise NotImplementedError
+        versions = ImageUpdaterHelper.get_versions_in_docker_hub(image, ".", "^\\d+\\.\\d+$", 999)
+        newer_versions = ImageUpdaterHelper.filter_for_newer_versions(current_version, versions)
+        result = ImageUpdaterHelper.filter_considering_echolon(newer_versions, current_version, version_echolon)
+        return result
 
     @GeneralUtilities.check_arguments
     def get_supported_images(self) -> list[str]:
-        return []  # TODO
+        return ["postgres"]
 
     @GeneralUtilities.check_arguments
     def get_version_from_tag(self, image: str, tag: str) -> Version:
-        raise NotImplementedError
+        return ve.parse(tag+".0")
 
 
 class ConcreteImageUpdaterForAdminer(ConcreteImageUpdater):
@@ -337,7 +380,7 @@ class ConcreteImageUpdaterForAdminer(ConcreteImageUpdater):
     def get_latest_version_of_image(self,  image: str, version_echolon: VersionEcholon, current_version: Version) -> Version:
         versions = ImageUpdaterHelper.get_versions_in_docker_hub(image, ".", "^\\d+\\.\\d+\\.\\d+$", 999)
         newer_versions = ImageUpdaterHelper.filter_for_newer_versions(current_version, versions)
-        result = ImageUpdaterHelper.filter_considering_echolog(newer_versions, current_version, version_echolon)
+        result = ImageUpdaterHelper.filter_considering_echolon(newer_versions, current_version, version_echolon)
         return result
 
     @GeneralUtilities.check_arguments
@@ -358,6 +401,7 @@ class ImageUpdater:
 
     def add_default_mapper(self) -> None:
         self.updater.append(ConcreteImageUpdaterForNginx())
+        self.updater.append(ConcreteImageUpdaterForWordpress())
         self.updater.append(ConcreteImageUpdaterForGitLab())
         self.updater.append(ConcreteImageUpdaterForRegistry())
         self.updater.append(ConcreteImageUpdaterForPrometheus())
@@ -415,6 +459,7 @@ class ImageUpdater:
         result = self.get_latest_version_of_image(imagename, version_echolon, existing_version)
         newest_version = result[0]
         newest_tag = result[1]
+        # TODO write info to console if there is a newwer version available if versionecoholon==latest would have been chosen
         if existing_version < newest_version:
 
             with open(dockercompose_file, 'r', encoding="utf-8") as f:

ScriptCollection/ScriptCollectionCore.py

@@ -33,7 +33,7 @@ from .ProgramRunnerPopen import ProgramRunnerPopen
 from .ProgramRunnerEpew import ProgramRunnerEpew, CustomEpewArgument
 from .SCLog import SCLog, LogLevel
 
-version = "3.5.137"
+version = "3.5.139"
 __version__ = version
 
 
@@ -154,7 +154,7 @@ class ScriptCollectionCore:
 
     @GeneralUtilities.check_arguments
     def commit_is_signed_by_key(self, repository_folder: str, revision_identifier: str, key: str) -> bool:
-        self.assert_is_git_repository(repository_folder)
+        self.is_git_or_bare_git_repository(repository_folder)
         result = self.run_program("git", f"verify-commit {revision_identifier}", repository_folder, throw_exception_if_exitcode_is_not_zero=False)
         if (result[0] != 0):
             return False
@@ -168,12 +168,12 @@ class ScriptCollectionCore:
 
     @GeneralUtilities.check_arguments
     def get_parent_commit_ids_of_commit(self, repository_folder: str, commit_id: str) -> str:
-        self.assert_is_git_repository(repository_folder)
+        self.is_git_or_bare_git_repository(repository_folder)
         return self.run_program("git", f'log --pretty=%P -n 1 "{commit_id}"', repository_folder, throw_exception_if_exitcode_is_not_zero=True)[1].replace("\r", GeneralUtilities.empty_string).replace("\n", GeneralUtilities.empty_string).split(" ")
 
     @GeneralUtilities.check_arguments
     def get_all_authors_and_committers_of_repository(self, repository_folder: str, subfolder: str = None, verbosity: int = 1) -> list[tuple[str, str]]:
-        self.assert_is_git_repository(repository_folder)
+        self.is_git_or_bare_git_repository(repository_folder)
         space_character = "_"
         if subfolder is None:
             subfolder_argument = GeneralUtilities.empty_string
@@ -193,7 +193,7 @@ class ScriptCollectionCore:
 
     @GeneralUtilities.check_arguments
     def get_commit_ids_between_dates(self, repository_folder: str, since: datetime, until: datetime, ignore_commits_which_are_not_in_history_of_head: bool = True) -> None:
-        self.assert_is_git_repository(repository_folder)
+        self.is_git_or_bare_git_repository(repository_folder)
         since_as_string = self.__datetime_to_string_for_git(since)
         until_as_string = self.__datetime_to_string_for_git(until)
         result = filter(lambda line: not GeneralUtilities.string_is_none_or_whitespace(line), self.run_program("git", f'log --since "{since_as_string}" --until "{until_as_string}" --pretty=format:"%H" --no-patch', repository_folder, throw_exception_if_exitcode_is_not_zero=True)[1].split("\n").replace("\r", GeneralUtilities.empty_string))
@@ -207,7 +207,7 @@ class ScriptCollectionCore:
 
     @GeneralUtilities.check_arguments
     def git_commit_is_ancestor(self, repository_folder: str,  ancestor: str, descendant: str = "HEAD") -> bool:
-        self.assert_is_git_repository(repository_folder)
+        self.is_git_or_bare_git_repository(repository_folder)
         result = self.run_program_argsasarray("git", ["merge-base", "--is-ancestor", ancestor, descendant], repository_folder, throw_exception_if_exitcode_is_not_zero=False)
         exit_code = result[0]
         if exit_code == 0:
@@ -261,13 +261,13 @@ class ScriptCollectionCore:
 
     @GeneralUtilities.check_arguments
     def git_get_commit_id(self, repository_folder: str, commit: str = "HEAD") -> str:
-        self.assert_is_git_repository(repository_folder)
+        self.is_git_or_bare_git_repository(repository_folder)
         result: tuple[int, str, str, int] = self.run_program_argsasarray("git", ["rev-parse", "--verify", commit], repository_folder, throw_exception_if_exitcode_is_not_zero=True, verbosity=0)
         return result[1].replace('\n', '')
 
     @GeneralUtilities.check_arguments
     def git_get_commit_date(self, repository_folder: str, commit: str = "HEAD") -> datetime:
-        self.assert_is_git_repository(repository_folder)
+        self.is_git_or_bare_git_repository(repository_folder)
         result: tuple[int, str, str, int] = self.run_program_argsasarray("git", ["show", "-s", "--format=%ci", commit], repository_folder, throw_exception_if_exitcode_is_not_zero=True, verbosity=0)
         date_as_string = result[1].replace('\n', '')
         result = datetime.strptime(date_as_string, '%Y-%m-%d %H:%M:%S %z')
@@ -279,17 +279,17 @@ class ScriptCollectionCore:
 
     @GeneralUtilities.check_arguments
     def git_fetch(self, folder: str, remotename: str = "--all") -> None:
-        self.assert_is_git_repository(folder)
+        self.is_git_or_bare_git_repository(folder)
         self.run_program_argsasarray("git", ["fetch", remotename, "--tags", "--prune"], folder, throw_exception_if_exitcode_is_not_zero=True, verbosity=0)
 
     @GeneralUtilities.check_arguments
     def git_fetch_in_bare_repository(self, folder: str, remotename, localbranch: str, remotebranch: str) -> None:
-        self.assert_is_git_repository(folder)
+        self.is_git_or_bare_git_repository(folder)
         self.run_program_argsasarray("git", ["fetch", remotename, f"{remotebranch}:{localbranch}"], folder, throw_exception_if_exitcode_is_not_zero=True, verbosity=0)
 
     @GeneralUtilities.check_arguments
     def git_remove_branch(self, folder: str, branchname: str) -> None:
-        self.assert_is_git_repository(folder)
+        self.is_git_or_bare_git_repository(folder)
         self.run_program("git", f"branch -D {branchname}", folder, throw_exception_if_exitcode_is_not_zero=True, verbosity=0)
 
     @GeneralUtilities.check_arguments
@@ -298,7 +298,7 @@ class ScriptCollectionCore:
 
     @GeneralUtilities.check_arguments
     def git_push(self, folder: str, remotename: str, localbranchname: str, remotebranchname: str, forcepush: bool = False, pushalltags: bool = True, verbosity: int = 0) -> None:
-        self.assert_is_git_repository(folder)
+        self.is_git_or_bare_git_repository(folder)
         argument = ["push", "--recurse-submodules=on-demand", remotename, f"{localbranchname}:{remotebranchname}"]
         if (forcepush):
             argument.append("--force")
@@ -313,7 +313,7 @@ class ScriptCollectionCore:
 
     @GeneralUtilities.check_arguments
     def git_pull(self, folder: str, remote: str, localbranchname: str, remotebranchname: str, force: bool = False) -> None:
-        self.assert_is_git_repository(folder)
+        self.is_git_or_bare_git_repository(folder)
         argument = f"pull {remote} {remotebranchname}:{localbranchname}"
         if force:
             argument = f"{argument} --force"
@@ -321,7 +321,7 @@ class ScriptCollectionCore:
 
     @GeneralUtilities.check_arguments
     def git_list_remote_branches(self, folder: str, remote: str, fetch: bool) -> list[str]:
-        self.assert_is_git_repository(folder)
+        self.is_git_or_bare_git_repository(folder)
         if fetch:
             self.git_fetch(folder, remote)
         run_program_result = self.run_program("git", f"branch -rl {remote}/*", folder, throw_exception_if_exitcode_is_not_zero=True, verbosity=0)
@@ -355,19 +355,19 @@ class ScriptCollectionCore:
 
     @GeneralUtilities.check_arguments
     def git_get_all_remote_names(self, directory: str) -> list[str]:
-        self.assert_is_git_repository(directory)
+        self.is_git_or_bare_git_repository(directory)
         result = GeneralUtilities.string_to_lines(self.run_program_argsasarray("git", ["remote"], directory, throw_exception_if_exitcode_is_not_zero=True, verbosity=0)[1], False)
         return result
 
     @GeneralUtilities.check_arguments
     def git_get_remote_url(self, directory: str, remote_name: str) -> str:
-        self.assert_is_git_repository(directory)
+        self.is_git_or_bare_git_repository(directory)
         result = GeneralUtilities.string_to_lines(self.run_program_argsasarray("git", ["remote", "get-url", remote_name], directory, throw_exception_if_exitcode_is_not_zero=True, verbosity=0)[1], False)
         return result[0].replace('\n', '')
 
     @GeneralUtilities.check_arguments
     def repository_has_remote_with_specific_name(self, directory: str, remote_name: str) -> bool:
-        self.assert_is_git_repository(directory)
+        self.is_git_or_bare_git_repository(directory)
         return remote_name in self.git_get_all_remote_names(directory)
 
     @GeneralUtilities.check_arguments
@@ -448,7 +448,7 @@ class ScriptCollectionCore:
 
     @GeneralUtilities.check_arguments
     def git_create_tag(self, directory: str, target_for_tag: str, tag: str, sign: bool = False, message: str = None) -> None:
-        self.assert_is_git_repository(directory)
+        self.is_git_or_bare_git_repository(directory)
         argument = ["tag", tag, target_for_tag]
         if sign:
             if message is None:
@@ -458,7 +458,7 @@ class ScriptCollectionCore:
 
     @GeneralUtilities.check_arguments
     def git_delete_tag(self, directory: str, tag: str) -> None:
-        self.assert_is_git_repository(directory)
+        self.is_git_or_bare_git_repository(directory)
         self.run_program_argsasarray("git", ["tag", "--delete", tag], directory, throw_exception_if_exitcode_is_not_zero=True, verbosity=0)
 
     @GeneralUtilities.check_arguments
@@ -532,7 +532,7 @@ class ScriptCollectionCore:
                     self.git_clone(target_repository, source_repository, include_submodules=True, mirror=True)
 
     def get_git_submodules(self, directory: str) -> list[str]:
-        self.assert_is_git_repository(directory)
+        self.is_git_or_bare_git_repository(directory)
         e = self.run_program("git", "submodule status", directory)
         result = []
         for submodule_line in GeneralUtilities.string_to_lines(e[1], False, True):
@@ -541,7 +541,7 @@ class ScriptCollectionCore:
 
     @GeneralUtilities.check_arguments
     def file_is_git_ignored(self, file_in_repository: str, repositorybasefolder: str) -> None:
-        self.assert_is_git_repository(repositorybasefolder)
+        self.is_git_or_bare_git_repository(repositorybasefolder)
         exit_code = self.run_program_argsasarray("git", ['check-ignore', file_in_repository], repositorybasefolder, throw_exception_if_exitcode_is_not_zero=False, verbosity=0)[0]
         if (exit_code == 0):
             return True
@@ -563,21 +563,21 @@ class ScriptCollectionCore:
 
     @GeneralUtilities.check_arguments
     def git_get_commitid_of_tag(self, repository: str, tag: str) -> str:
-        self.assert_is_git_repository(repository)
+        self.is_git_or_bare_git_repository(repository)
         stdout = self.run_program_argsasarray("git", ["rev-list", "-n", "1", tag], repository, verbosity=0)
         result = stdout[1].replace("\r", GeneralUtilities.empty_string).replace("\n", GeneralUtilities.empty_string)
         return result
 
     @GeneralUtilities.check_arguments
     def git_get_tags(self, repository: str) -> list[str]:
-        self.assert_is_git_repository(repository)
+        self.is_git_or_bare_git_repository(repository)
         tags = [line.replace("\r", GeneralUtilities.empty_string) for line in self.run_program_argsasarray(
             "git", ["tag"], repository)[1].split("\n") if len(line) > 0]
         return tags
 
     @GeneralUtilities.check_arguments
     def git_move_tags_to_another_branch(self, repository: str, tag_source_branch: str, tag_target_branch: str, sign: bool = False, message: str = None) -> None:
-        self.assert_is_git_repository(repository)
+        self.is_git_or_bare_git_repository(repository)
         tags = self.git_get_tags(repository)
         tags_count = len(tags)
         counter = 0
@@ -598,13 +598,13 @@ class ScriptCollectionCore:
 
     @GeneralUtilities.check_arguments
     def get_current_git_branch_has_tag(self, repository_folder: str) -> bool:
-        self.assert_is_git_repository(repository_folder)
+        self.is_git_or_bare_git_repository(repository_folder)
         result = self.run_program_argsasarray("git", ["describe", "--tags", "--abbrev=0"], repository_folder, verbosity=0, throw_exception_if_exitcode_is_not_zero=False)
         return result[0] == 0
 
     @GeneralUtilities.check_arguments
     def get_latest_git_tag(self, repository_folder: str) -> str:
-        self.assert_is_git_repository(repository_folder)
+        self.is_git_or_bare_git_repository(repository_folder)
         result = self.run_program_argsasarray("git", ["describe", "--tags", "--abbrev=0"], repository_folder, verbosity=0)
         result = result[1].replace("\r", GeneralUtilities.empty_string).replace("\n", GeneralUtilities.empty_string)
         return result
@@ -624,7 +624,7 @@ class ScriptCollectionCore:
 
     @GeneralUtilities.check_arguments
     def run_git_command_in_repository_and_submodules(self, repository_folder: str, arguments: list[str]) -> None:
-        self.assert_is_git_repository(repository_folder)
+        self.is_git_or_bare_git_repository(repository_folder)
         self.run_program_argsasarray("git", arguments, repository_folder)
         self.run_program_argsasarray("git", ["submodule", "foreach", "--recursive", "git"]+arguments, repository_folder)
 
@@ -688,7 +688,7 @@ class ScriptCollectionCore:
             raise ValueError(f"Folder '{folder}' does not exist.")
         git_folder_path = f"{folder}/.git"
         return self.is_folder(git_folder_path) or self.is_file(git_folder_path)
-    
+
     @GeneralUtilities.check_arguments
     def is_bare_git_repository(self, folder: str) -> bool:
         """This function works platform-independent also for non-local-executions if the ScriptCollection commandline-commands are available as global command on the target-system."""
@@ -697,26 +697,25 @@ class ScriptCollectionCore:
         if not self.is_folder(folder):
             raise ValueError(f"Folder '{folder}' does not exist.")
         return folder.endswith(".git")
-    
+
     @GeneralUtilities.check_arguments
     def is_git_or_bare_git_repository(self, folder: str) -> bool:
         """This function works platform-independent also for non-local-executions if the ScriptCollection commandline-commands are available as global command on the target-system."""
-        return self.is_git_repository(folder) or self.is_bare_git_repository(folder) 
+        return self.is_git_repository(folder) or self.is_bare_git_repository(folder)
 
     @GeneralUtilities.check_arguments
     def assert_is_git_repository(self, folder: str) -> str:
         """This function works platform-independent also for non-local-executions if the ScriptCollection commandline-commands are available as global command on the target-system."""
         GeneralUtilities.assert_condition(self.is_git_repository(folder), f"'{folder}' is not a git-repository.")
 
-
     @GeneralUtilities.check_arguments
-    def convert_git_repository_to_bare_repository(self,repository_folder:str):
-        repository_folder=repository_folder.replace("\\", "/")
+    def convert_git_repository_to_bare_repository(self, repository_folder: str):
+        repository_folder = repository_folder.replace("\\", "/")
         self.assert_is_git_repository(repository_folder)
-        git_folder=repository_folder+ "/.git"
+        git_folder = repository_folder + "/.git"
         if not self.is_folder(git_folder):
             raise ValueError(f"Converting '{repository_folder}' to a bare repository not possible. The folder '{git_folder}' does not exist. Converting is currently only supported when the git-folder is a direct folder in a repository and not a reference to another location.")
-        target_folder:str = repository_folder + ".git"
+        target_folder: str = repository_folder + ".git"
         GeneralUtilities.ensure_directory_exists(target_folder)
         GeneralUtilities.move_content_of_folder(git_folder, target_folder)
         GeneralUtilities.ensure_directory_does_not_exist(repository_folder)
@@ -2336,3 +2335,74 @@ TXDX
     @GeneralUtilities.check_arguments
     def install_requirementstxt_file(self, requirements_txt_file: str, folder: str, verbosity: int):
         self.run_program_argsasarray("pip", ["install", "-r", requirements_txt_file], folder, verbosity=verbosity)
+
+    @GeneralUtilities.check_arguments
+    def ocr_analysis_of_folder(self, folder: str, serviceaddress: str, extensions: list[str], languages: list[str]) -> list[str]:  # Returns a list of changed files due to ocr-analysis.
+        GeneralUtilities.write_message_to_stdout("Starting OCR analysis of folder " + folder)
+        supported_extensions = ['png', 'jpg', 'jpeg', 'tiff', 'bmp', 'gif', 'pdf', 'docx', 'doc', 'xlsx', 'xls', 'pptx', 'ppt']
+        changes_files: list[str] = []
+        if extensions is None:
+            extensions = supported_extensions
+        for file in GeneralUtilities.get_direct_files_of_folder(folder):
+            file_lower = file.lower()
+            for extension in extensions:
+                if file_lower.endswith("."+extension):
+                    if self.ocr_analysis_of_file(file, serviceaddress, languages):
+                        changes_files.append(file)
+                    break
+        for subfolder in GeneralUtilities.get_direct_folders_of_folder(folder):
+            for file in self.ocr_analysis_of_folder(subfolder, serviceaddress, extensions, languages):
+                changes_files.append(file)
+        return changes_files
+
+    @GeneralUtilities.check_arguments
+    def ocr_analysis_of_file(self, file: str, serviceaddress: str, languages: list[str]) -> bool:  # Returns true if the ocr-file was generated or updated. Returns false if the existing ocr-file was not changed.
+        GeneralUtilities.write_message_to_stdout("Do OCR analysis of file " + file)
+        supported_extensions = ['png', 'jpg', 'jpeg', 'tiff', 'bmp', 'webp', 'gif', 'pdf', 'rtf', 'docx', 'doc', 'odt', 'xlsx', 'xls', 'ods', 'pptx', 'ppt', 'odp']
+        for extension in supported_extensions:
+            if file.lower().endswith("."+extension):
+                raise ValueError(f"Extension '{extension}' is not supported. Supported extensions are: {', '.join(supported_extensions)}")
+        target_file = file+".ocr.txt"
+        hash_of_current_file: str = GeneralUtilities. get_sha256_of_file(file)
+        if os.path.isfile(target_file):
+            lines = GeneralUtilities.read_lines_from_file(target_file)
+            previous_hash_of_current_file: str = lines[1].split(":")[1].strip()
+            if hash_of_current_file == previous_hash_of_current_file:
+                return False
+        ocr_content = self.get_ocr_content_of_file(file, serviceaddress, languages)
+        GeneralUtilities.ensure_file_exists(target_file)
+        GeneralUtilities.write_text_to_file(file, f"""Name of file: \"{os.path.basename(file)}\""
+Hash of file: {hash_of_current_file}
+OCR-content:
+\"{ocr_content}\"""")
+        return True
+
+    @GeneralUtilities.check_arguments
+    def get_ocr_content_of_file(self, file: str, serviceaddress: str, languages: list[str]) -> str:  # serviceaddress = None means local executable
+        result: str = None
+        if serviceaddress is None:
+            result = ""  # TODO call local executable
+        else:
+            result = ""  # TODO call remote service
+        return result
+
+    @GeneralUtilities.check_arguments
+    def ocr_analysis_of_repository(self, folder: str, serviceaddress: str, extensions: list[str], languages: list[str]) -> None:
+        self.assert_is_git_repository(folder)
+        changed_files = self.ocr_analysis_of_folder(folder, serviceaddress, extensions, languages)
+        for changed_ocr_file in changed_files:
+            GeneralUtilities.assert_condition(changed_ocr_file.endswith(".ocr.txt"), f"File '{changed_ocr_file}' is not an OCR-file. It should end with '.ocr.txt'.")
+            base_file = changed_ocr_file[:-len(".ocr.txt")]
+            GeneralUtilities.assert_condition(os.path.isfile(base_file), f"Base file '{base_file}' does not exist. The OCR-file '{changed_ocr_file}' is not valid.")
+            base_file_relative_path = os.path.relpath(base_file, folder)
+            base_file_diff_program_result = self.run_program("git", f"diff --quiet -- \"{base_file_relative_path}\"", folder, throw_exception_if_exitcode_is_not_zero=False)
+            has_staged_changes: bool = None
+            if base_file_diff_program_result[0] == 0:
+                has_staged_changes = False
+            elif base_file_diff_program_result[0] == 1:
+                has_staged_changes = True
+            else:
+                raise RuntimeError(f"Unexpected exit code {base_file_diff_program_result[0]} when checking for staged changes of file '{base_file_relative_path}'.")
+            if has_staged_changes:
+                changed_ocr_file_relative_path = os.path.relpath(changed_ocr_file, folder)
+                self.run_program_argsasarray("git", ["add", changed_ocr_file_relative_path], folder)

ScriptCollection/TasksForCommonProjectStructure.py

@@ -3115,7 +3115,7 @@ class TasksForCommonProjectStructure:
         # TODO validate artifactsinformation_file against xsd
         GeneralUtilities.write_message_to_stdout(f"Finished building codeunit {codeunit_name} without errors.")
 
-    def __add_changelog_file(self, repository_folder: str, version_of_project: str):
+    def __ensure_changelog_file_is_added(self, repository_folder: str, version_of_project: str):
         changelog_file = os.path.join(repository_folder, "Other", "Resources", "Changelog", f"v{version_of_project}.md")
         if not os.path.isfile(changelog_file):
             GeneralUtilities.ensure_file_exists(changelog_file)
@@ -3136,16 +3136,16 @@ class TasksForCommonProjectStructure:
         target_environmenttype = "QualityCheck"
         project_name: str = os.path.basename(repository_folder)
         GeneralUtilities.assert_condition(not self.__sc.git_repository_has_uncommitted_changes(repository_folder), "There are uncommitted changes in the repository.")
+        self.build_codeunits(repository_folder, target_environmenttype=target_environmenttype, do_git_clean_when_no_changes=True, note="Prepare dependency-update")  # Required because update dependencies is not always possible for not-buildet codeunits (depends on the programming language or package manager)
 
         # update dependencies of resources
         global_scripts_folder = os.path.join(repository_folder, "Other", "Scripts")
         if os.path.isfile(os.path.join(global_scripts_folder, update_dependencies_script_filename)):
-            self.build_codeunits(repository_folder, target_environmenttype=target_environmenttype, do_git_clean_when_no_changes=True, note="Prepare dependency-update")  # Required because update dependencies is not always possible for not-buildet codeunits (depends on the programming language or package manager)
             self.__sc.run_program("python", update_dependencies_script_filename, global_scripts_folder, print_live_output=True)
             version_of_project = self.get_version_of_project(repository_folder)
-            self.__add_changelog_file(repository_folder, version_of_project)
+            self.__ensure_changelog_file_is_added(repository_folder, version_of_project)
             GeneralUtilities.write_message_to_stdout(f"Updated global dependencies of {project_name}.")
-            self.build_codeunits(repository_folder, verbosity, "QualityCheck", None, False, None, [], False, "Build codeunits due to updated dependencies")
+            self.build_codeunits(repository_folder, verbosity, "QualityCheck", None, False, None, [], False, "Build codeunits due to updated product-wide dependencies")
 
         # update dependencies of codeunits
         for codeunit in codeunits:
@@ -3160,10 +3160,10 @@ class TasksForCommonProjectStructure:
                 self.__sc.run_program("python", update_dependencies_script_filename, update_dependencies_script_folder, verbosity, print_live_output=True)
                 if self.__sc.git_repository_has_uncommitted_changes(repository_folder):
                     version_of_project = self.get_version_of_project(repository_folder)
-                    self.__add_changelog_file(repository_folder, version_of_project)
+                    self.__ensure_changelog_file_is_added(repository_folder, version_of_project)
                     GeneralUtilities.write_message_to_stdout(f"Updated dependencies in codeunit {codeunit}.")
 
-        self.build_codeunits(repository_folder, verbosity, "QualityCheck", None, False, None, [], False, "Build codeunits due to updated dependencies")
+        self.build_codeunits(repository_folder, verbosity, "QualityCheck", None, False, None, [], False, "Build all codeunits due to updated dependencies")
         self.__sc.git_commit(repository_folder, "Updated dependencies")
 
     class GenericPrepareNewReleaseArguments:

{scriptcollection-3.5.137.dist-info → scriptcollection-3.5.139.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ScriptCollection
-Version: 3.5.137
+Version: 3.5.139
 Summary: The ScriptCollection is the place for reusable scripts.
 Home-page: https://github.com/anionDev/ScriptCollection
 Author: Marius Göcke
@@ -23,7 +23,7 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: build>=1.2.2.post1
-Requires-Dist: coverage>=7.8.2
+Requires-Dist: coverage>=7.9.1
 Requires-Dist: cyclonedx-bom>=6.1.1
 Requires-Dist: defusedxml>=0.7.1
 Requires-Dist: keyboard>=0.13.5
@@ -42,7 +42,7 @@ Requires-Dist: PyYAML>=6.0.2
 Requires-Dist: qrcode>=8.2
 Requires-Dist: send2trash>=1.8.3
 Requires-Dist: twine>=6.1.0
-Requires-Dist: xmlschema>=4.0.1
+Requires-Dist: xmlschema>=4.1.0
 
 # ScriptCollection
 

{scriptcollection-3.5.137.dist-info → scriptcollection-3.5.139.dist-info}/RECORD

@@ -1,17 +1,17 @@
 ScriptCollection/CertificateUpdater.py,sha256=OAxrG21k_o3W3niOOGNSZzUPJlvolOWc1lRB2dMhc3g,9212
-ScriptCollection/Executables.py,sha256=Sbi0cuHnd8PYROA9HcHQ00KJV805LtFhyiEl5PgHoIQ,32672
+ScriptCollection/Executables.py,sha256=d9QkQuaS0nxTwNUGxtqKUk9dJqT5gS670LNuCz2YMw0,35349
 ScriptCollection/GeneralUtilities.py,sha256=PKdzq382RYVSWeSG_6z6FiHu-SiTOi2BavJKvP-0slU,47308
-ScriptCollection/ImageUpdater.py,sha256=lel1nevTN7fgdoCDE6Xg8YY6XPsZaOQiCIyWXbmVnh0,20882
+ScriptCollection/ImageUpdater.py,sha256=3B5pgAMnyne3ZogWz-suqglZGIB9FAKyWn31P9E1ST0,24491
 ScriptCollection/ProcessesRunner.py,sha256=3mu4ZxzZleQo0Op6o9EYTCFiJfb6kx5ov2YfZfT89mU,1395
 ScriptCollection/ProgramRunnerBase.py,sha256=2kMIAqdc65UjBAddOZkzy_aFx9h5roZ5a4bQNM6RV6Y,2480
 ScriptCollection/ProgramRunnerEpew.py,sha256=4pjEd0r9Fcz3TTDv0MdTSd5KkigYXcWUVI1X43regfU,6477
 ScriptCollection/ProgramRunnerPopen.py,sha256=BPY7-ZMIlqT7JOKz8qlB5c0laF2Js-ijzqk09GxZC48,3821
 ScriptCollection/SCLog.py,sha256=Dd2P8vH2PA830wAv6bchlMHHdGE_7At-F4WQY5w4XdA,4016
-ScriptCollection/ScriptCollectionCore.py,sha256=L-tWnkE54e9jI7YxZUnny6_-_DjflWMeLaQDgV3QsFU,130990
-ScriptCollection/TasksForCommonProjectStructure.py,sha256=b3bb3kSHSce3HgaitDyuZdQ82KroU1HFryANBycKo0I,235854
+ScriptCollection/ScriptCollectionCore.py,sha256=rX1wjbWTYkTVGaVzvgDYlCxSVhxfyoIr7Yn4oTJ8qy4,135815
+ScriptCollection/TasksForCommonProjectStructure.py,sha256=boOF-cOYdfUPRf5DOgL1yfeO7GYxAn6-W3fdUV84clE,235903
 ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scriptcollection-3.5.137.dist-info/METADATA,sha256=DdSE7BdnUmmZ2uSaaGWy5MNjkg63I5rszeyyQ09b_XU,7694
-scriptcollection-3.5.137.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-scriptcollection-3.5.137.dist-info/entry_points.txt,sha256=AhXNaa8RMBRFO_4TzKi9jc32C-ZNIiU12mRGu6wEpBk,3796
-scriptcollection-3.5.137.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
-scriptcollection-3.5.137.dist-info/RECORD,,
+scriptcollection-3.5.139.dist-info/METADATA,sha256=9OcBLfJLHZo4Vtr9udrIBQSbqI50JA9oVS0DkjXUCdQ,7694
+scriptcollection-3.5.139.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+scriptcollection-3.5.139.dist-info/entry_points.txt,sha256=AvmVO9iyWImExpvzL3YYQ9AOEiUIN9guPRRG_W_VNWY,4116
+scriptcollection-3.5.139.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
+scriptcollection-3.5.139.dist-info/RECORD,,

{scriptcollection-3.5.137.dist-info → scriptcollection-3.5.139.dist-info}/entry_points.txt

@@ -35,6 +35,9 @@ sclistfoldercontent = ScriptCollection.Executables:ListFolderContent
 scmergepdfs = ScriptCollection.Executables:MergePDFs
 scnpmi = ScriptCollection.Executables:NpmI
 scobfuscatefilesfolder = ScriptCollection.Executables:ObfuscateFilesFolder
+scocranalysisoffile = ScriptCollection.Executables:OCRAnalysisOfFile
+scocranalysisoffolder = ScriptCollection.Executables:OCRAnalysisOfFolder
+scocranalysisofrepository = ScriptCollection.Executables:OCRAnalysisOfRepository
 scorganizelinesinfile = ScriptCollection.Executables:OrganizeLinesInFile
 scpdftoimage = ScriptCollection.Executables:PDFToImage
 scprintcurrentworkingdirectory = ScriptCollection.Executables:PrintCurrecntWorkingDirectory
@@ -51,5 +54,6 @@ scsetcontentoffile = ScriptCollection.Executables:SetContentOfFile
 scshow2faasqrcode = ScriptCollection.Executables:Show2FAAsQRCode
 scshowmissingfiles = ScriptCollection.Executables:ShowMissingFiles
 scsigncertificate = ScriptCollection.Executables:SignCertificate
+scupdateimagesindockercomposefile = ScriptCollection.Executables:UpdateImagesInDockerComposeFile
 scupdatenugetpackagesincsharpproject = ScriptCollection.Executables:UpdateNugetpackagesInCsharpProject
 scuploadfile = ScriptCollection.Executables:UploadFile