ScriptCollection 3.5.140__py3-none-any.whl → 3.5.143__py3-none-any.whl

ScriptCollection/ScriptCollectionCore.py

@@ -33,7 +33,7 @@ from .ProgramRunnerPopen import ProgramRunnerPopen
 from .ProgramRunnerEpew import ProgramRunnerEpew, CustomEpewArgument
 from .SCLog import SCLog, LogLevel
 
-version = "3.5.140"
+version = "3.5.143"
 __version__ = version
 
 

ScriptCollection/TasksForCommonProjectStructure.py

@@ -5,6 +5,7 @@ from pathlib import Path
 from functools import cmp_to_key
 import shutil
 import math
+import tarfile
 import re
 import urllib.request
 import zipfile
@@ -22,6 +23,7 @@ from .GeneralUtilities import GeneralUtilities
 from .ScriptCollectionCore import ScriptCollectionCore
 from .SCLog import SCLog, LogLevel
 from .ProgramRunnerEpew import ProgramRunnerEpew
+from .ImageUpdater import ImageUpdater, VersionEcholon
 
 
 class CreateReleaseConfiguration():
@@ -1513,7 +1515,7 @@ class TasksForCommonProjectStructure:
         project_version = self.get_version_of_project(repository_folder)
         codeunit_folder = os.path.join(repository_folder, codeunit_name)
 
-        # Check codeunit-conformity
+        # check codeunit-conformity
         # TODO check if foldername=="<codeunitname>[.codeunit.xml]" == <codeunitname> in file
         supported_codeunitspecificationversion = "2.9.4"  # should always be the latest version of the ProjectTemplates-repository
         codeunit_file = os.path.join(codeunit_folder, f"{codeunit_name}.codeunit.xml")
@@ -1523,7 +1525,7 @@ class TasksForCommonProjectStructure:
         namespaces = {'cps': 'https://projects.aniondev.de/PublicProjects/Common/ProjectTemplates/-/tree/main/Conventions/RepositoryStructure/CommonProjectStructure',  'xsi': 'http://www.w3.org/2001/XMLSchema-instance'}
         root: etree._ElementTree = etree.parse(codeunit_file)
 
-        # Check codeunit-spcecification-version
+        # check codeunit-spcecification-version
         try:
             codeunit_file_version = root.xpath('//cps:codeunit/@codeunitspecificationversion', namespaces=namespaces)[0]
             if codeunit_file_version != supported_codeunitspecificationversion:
@@ -1538,27 +1540,27 @@ class TasksForCommonProjectStructure:
                 GeneralUtilities.write_message_to_stderr(f'Warning: Codeunitfile "{codeunit_file}" can not be validated due to the following exception:')
                 GeneralUtilities.write_exception_to_stderr(exception)
 
-        # Check codeunit-name
+        # check codeunit-name
         codeunit_name_in_codeunit_file = root.xpath('//cps:codeunit/cps:name/text()', namespaces=namespaces)[0]
         if codeunit_name != codeunit_name_in_codeunit_file:
             raise ValueError(f"The folder-name ('{codeunit_name}') is not equal to the codeunit-name ('{codeunit_name_in_codeunit_file}').")
 
-        # Check owner-name
+        # check owner-name
         codeunit_ownername_in_codeunit_file = self. get_codeunit_owner_name(codeunit_file)
         GeneralUtilities.assert_condition(GeneralUtilities.string_has_content(codeunit_ownername_in_codeunit_file), "No valid name for codeunitowner given.")
 
-        # Check owner-emailaddress
+        # check owner-emailaddress
         codeunit_owneremailaddress_in_codeunit_file = self.get_codeunit_owner_emailaddress(codeunit_file)
         GeneralUtilities.assert_condition(GeneralUtilities.string_has_content(codeunit_owneremailaddress_in_codeunit_file), "No valid email-address for codeunitowner given.")
 
-        # Check development-state
+        # check development-state
         developmentstate = root.xpath('//cps:properties/@developmentstate', namespaces=namespaces)[0]
         developmentstate_active = "Active development"
         developmentstate_maintenance = "Maintenance-updates only"
         developmentstate_inactive = "Inactive"
         GeneralUtilities.assert_condition(developmentstate in (developmentstate_active, developmentstate_maintenance, developmentstate_inactive), f"Invalid development-state. Must be '{developmentstate_active}' or '{developmentstate_maintenance}' or '{developmentstate_inactive}' but was '{developmentstate}'.")
 
-        # Check for mandatory files
+        # check for mandatory files
         files = ["Other/Build/Build.py", "Other/QualityCheck/Linting.py", "Other/Reference/GenerateReference.py"]
         if self.codeunit_has_testable_sourcecode(codeunit_file):
             # TODO check if the testsettings-section appears in the codeunit-file
@@ -1574,7 +1576,7 @@ class TasksForCommonProjectStructure:
         if os.path.isfile(os.path.join(codeunit_folder, "Other", "requirements.txt")):
             self.install_requirementstxt_for_codeunit(codeunit_folder, verbosity)
 
-        # Check developer
+        # check developer
         if self.validate_developers_of_repository:
             expected_authors: list[tuple[str, str]] = []
             expected_authors_in_xml = root.xpath('//cps:codeunit/cps:developerteam/cps:developer', namespaces=namespaces)
@@ -1597,19 +1599,30 @@ class TasksForCommonProjectStructure:
 
         # TODO implement cycle-check for dependent codeunits
 
-        # Clear previously builded artifacts if desired:
+        # clear previously builded artifacts if desired:
         if clear_artifacts_folder:
             artifacts_folder = os.path.join(codeunit_folder, "Other", "Artifacts")
             GeneralUtilities.ensure_directory_does_not_exist(artifacts_folder)
 
-        # Get artifacts from dependent codeunits
+        # get artifacts from dependent codeunits
         # if assume_dependent_codeunits_are_already_built:
         #    self.build_dependent_code_units(repository_folder, codeunit_name, verbosity, target_environmenttype, additional_arguments_file, commandline_arguments)
         self.copy_artifacts_from_dependent_code_units(repository_folder, codeunit_name)
 
-        # Update codeunit-version
+        # update codeunit-version
         self.update_version_of_codeunit(common_tasks_scripts_file, codeunit_version)
 
+        # set project version
+        package_json_file = os.path.join(repository_folder, "package.json")  # TDOO move this to a general project-specific (and codeunit-independent-script)
+        if os.path.isfile(package_json_file):
+            package_json_data: str = None
+            with open(package_json_file, "r", encoding="utf-8") as f1:
+                package_json_data = json.load(f1)
+                package_json_data["version"] = project_version
+            with open(package_json_file, "w", encoding="utf-8") as f2:
+                json.dump(package_json_data, f2, indent=2)
+            GeneralUtilities.write_text_to_file(package_json_file, GeneralUtilities.read_text_from_file(package_json_file).replace("\r", ""))
+
         # set default constants
         self.set_default_constants(os.path.join(codeunit_folder))
 
@@ -2121,6 +2134,27 @@ class TasksForCommonProjectStructure:
             GeneralUtilities.ensure_file_does_not_exist(yamlfile3)
             shutil.copyfile(yamlfile1, yamlfile3)
 
+    @GeneralUtilities.check_arguments
+    def get_latest_version_of_openapigenerator(self) -> None:
+        github_api_releases_link = "https://api.github.com/repos/OpenAPITools/openapi-generator/releases"
+        with urllib.request.urlopen(github_api_releases_link) as release_information_url:
+            latest_release_infos = json.load(release_information_url)[0]
+            latest_version = latest_release_infos["tag_name"][1:]
+            return latest_version
+
+    @GeneralUtilities.check_arguments
+    def set_version_of_openapigenerator_by_update_dependencies_file(self, update_dependencies_script_file: str, used_version: str = None) -> None:
+        codeunit_folder: str = GeneralUtilities.resolve_relative_path("../..", update_dependencies_script_file)
+        self.set_version_of_openapigenerator(codeunit_folder, used_version)
+
+    @GeneralUtilities.check_arguments
+    def set_version_of_openapigenerator(self, codeunit_folder: str, used_version: str = None) -> None:
+        version_file = os.path.join(codeunit_folder, "Other", "Resources", "Dependencies", "OpenAPIGenerator", "Version.txt")
+        if used_version is None:
+            used_version = self.get_latest_version_of_openapigenerator()
+        GeneralUtilities.ensure_file_exists(version_file)
+        GeneralUtilities.write_text_to_file(version_file, used_version)
+
     @GeneralUtilities.check_arguments
     def ensure_openapigenerator_is_available(self, codeunit_folder: str) -> None:
         self.assert_is_codeunit_folder(codeunit_folder)
@@ -2130,14 +2164,12 @@ class TasksForCommonProjectStructure:
         jar_file = f"{openapigenerator_folder}/{filename}"
         jar_file_exists = os.path.isfile(jar_file)
         if internet_connection_is_available:  # Load/Update
-            github_api_releases_link = "https://api.github.com/repos/OpenAPITools/openapi-generator/releases"
-            with urllib.request.urlopen(github_api_releases_link) as release_information_url:
-                latest_release_infos = json.load(release_information_url)[0]
-                latest_version = latest_release_infos["tag_name"][1:]
-                download_link = f"https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/{latest_version}/openapi-generator-cli-{latest_version}.jar"
-                GeneralUtilities.ensure_directory_does_not_exist(openapigenerator_folder)
-                GeneralUtilities.ensure_directory_exists(openapigenerator_folder)
-                urllib.request.urlretrieve(download_link, jar_file)
+            version_file = os.path.join(codeunit_folder, "Other", "Resources", "Dependencies", "OpenAPIGenerator", "Version.txt")
+            used_version = GeneralUtilities.read_text_from_file(version_file)
+            download_link = f"https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/{used_version}/openapi-generator-cli-{used_version}.jar"
+            GeneralUtilities.ensure_directory_does_not_exist(openapigenerator_folder)
+            GeneralUtilities.ensure_directory_exists(openapigenerator_folder)
+            urllib.request.urlretrieve(download_link, jar_file)
         else:
             if jar_file_exists:
                 GeneralUtilities.write_message_to_stdout("Warning: Can not check for updates of OpenAPIGenerator due to missing internet-connection.")
@@ -2569,14 +2601,6 @@ class TasksForCommonProjectStructure:
             from_day = datetime(now.year, now.month, now.day, 0, 0, 0)
             self.mark_current_version_as_supported(repository_folder, project_version, from_day, until_day)
 
-        package_json_file = os.path.join(repository_folder, "package.json")
-        if os.path.isfile(package_json_file):
-            with open(package_json_file, "r", encoding="utf-8") as f1:
-                package_json_data = json.load(f1)
-                package_json_data["version"] = project_version
-                with open(package_json_file, "w", encoding="utf-8") as f2:
-                    json.dump(package_json_data, f2, indent=2)
-
         project_resources_folder = os.path.join(repository_folder, "Other", "Scripts")
         PrepareBuildCodeunits_script_name = "PrepareBuildCodeunits.py"
         prepare_build_codeunits_scripts = os.path.join(project_resources_folder, PrepareBuildCodeunits_script_name)
@@ -2665,7 +2689,7 @@ class TasksForCommonProjectStructure:
         GeneralUtilities.write_message_to_stdout(message2)
 
     @GeneralUtilities.check_arguments
-    def __do_repository_checks(self, repository_folder: str, project_version: str) -> None:
+    def __do_repository_checks(self, repository_folder: str, project_version: str) -> None:  # TDOO move this to a general project-specific (and codeunit-independent-script)
         self.__sc.assert_is_git_repository(repository_folder)
         self.__check_if_changelog_exists(repository_folder, project_version)
         self.__check_whether_security_txt_exists(repository_folder)
@@ -2793,6 +2817,30 @@ class TasksForCommonProjectStructure:
     def ensure_androidappbundletool_is_available(self, target_folder: str) -> None:
         self.ensure_file_from_github_assets_is_available_with_retry(target_folder, "google", "bundletool", "AndroidAppBundleTool", "bundletool.jar", lambda latest_version: f"bundletool-all-{latest_version}.jar")
 
+    @GeneralUtilities.check_arguments
+    def ensure_mediamtx_is_available(self, target_folder: str) -> None:
+        def download_and_extract(osname: str, osname_in_github_asset: str, extension: str):
+            resource_name: str = f"MediaMTX_{osname}"
+            zip_filename: str = f"{resource_name}.{extension}"
+            self.ensure_file_from_github_assets_is_available_with_retry(target_folder, "bluenviron", "mediamtx", resource_name, zip_filename, lambda latest_version: f"mediamtx_{latest_version}_{osname_in_github_asset}_amd64.{extension}")
+            resource_folder: str = os.path.join(target_folder, "Other", "Resources", resource_name)
+            target_folder_extracted = os.path.join(resource_folder, "MediaMTX")
+            local_zip_file: str = os.path.join(resource_folder, f"{resource_name}.{extension}")
+            GeneralUtilities.ensure_folder_exists_and_is_empty(target_folder_extracted)
+            if extension == "zip":
+                with zipfile.ZipFile(local_zip_file, 'r') as zip_ref:
+                    zip_ref.extractall(target_folder_extracted)
+            elif extension == "tar.gz":
+                with tarfile.open(local_zip_file, "r:gz") as tar:
+                    tar.extractall(path=target_folder_extracted)
+            else:
+                raise ValueError(f"Unknown extension: \"{extension}\"")
+            GeneralUtilities.ensure_file_does_not_exist(local_zip_file)
+
+        download_and_extract("Windows", "windows", "zip")
+        download_and_extract("Linux", "linux", "tar.gz")
+        download_and_extract("MacOS", "darwin", "tar.gz")
+
     @GeneralUtilities.check_arguments
     def ensure_cyclonedxcli_is_available(self, target_folder: str) -> None:
         local_filename = "cyclonedx-cli"
@@ -3378,3 +3426,12 @@ class TasksForCommonProjectStructure:
 
 - Updated geo-ip-database.
 """)
+
+    @GeneralUtilities.check_arguments
+    def update_images_in_example(self, codeunit_folder: str):
+        iu = ImageUpdater()
+        iu.add_default_mapper()
+        dockercomposefile: str = f"{codeunit_folder}\\Other\\Reference\\ReferenceContent\\Examples\\MinimalDockerComposeFile\\docker-compose.yml"
+        excluded = ["opendms"]
+        iu.update_all_services_in_docker_compose_file(dockercomposefile, VersionEcholon.LatestPatchOrLatestMinor, excluded)
+        iu.check_for_newest_version(dockercomposefile, excluded)

{scriptcollection-3.5.140.dist-info → scriptcollection-3.5.143.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ScriptCollection
-Version: 3.5.140
+Version: 3.5.143
 Summary: The ScriptCollection is the place for reusable scripts.
 Home-page: https://github.com/anionDev/ScriptCollection
 Author: Marius Göcke
@@ -24,19 +24,19 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: build>=1.2.2.post1
 Requires-Dist: coverage>=7.9.1
-Requires-Dist: cyclonedx-bom>=6.1.1
+Requires-Dist: cyclonedx-bom>=6.1.2
 Requires-Dist: defusedxml>=0.7.1
 Requires-Dist: keyboard>=0.13.5
 Requires-Dist: lcov-cobertura>=2.1.1
-Requires-Dist: lxml>=5.4.0
+Requires-Dist: lxml>=6.0.0
 Requires-Dist: ntplib>=0.4.0
 Requires-Dist: Pillow>=11.2.1
 Requires-Dist: psutil>=7.0.0
 Requires-Dist: pycdlib>=1.14.0
-Requires-Dist: Pygments>=2.19.1
+Requires-Dist: Pygments>=2.19.2
 Requires-Dist: pylint>=3.3.7
 Requires-Dist: pyOpenSSL>=25.1.0
-Requires-Dist: PyPDF>=5.6.0
+Requires-Dist: PyPDF>=5.6.1
 Requires-Dist: pytest>=8.4.1
 Requires-Dist: PyYAML>=6.0.2
 Requires-Dist: qrcode>=8.2

{scriptcollection-3.5.140.dist-info → scriptcollection-3.5.143.dist-info}/RECORD

@@ -7,11 +7,11 @@ ScriptCollection/ProgramRunnerBase.py,sha256=2kMIAqdc65UjBAddOZkzy_aFx9h5roZ5a4b
 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=RRwHiyjOKelBW0a52t4goDjm0Nm5yOz-r3grzkEPZRc,136482
-ScriptCollection/TasksForCommonProjectStructure.py,sha256=Aln85JyVrspQmluNyNSFT4gPycVt42W_4dM21qys13c,236756
+ScriptCollection/ScriptCollectionCore.py,sha256=pWtZZsQbcjvCTsVEnx19Wr2Az_ClRUv8c1auPLVG5gM,136482
+ScriptCollection/TasksForCommonProjectStructure.py,sha256=AP-hy9fvAZsXvd90r9fhG1wNAL248Rbh7KkmdKg8eJg,240506
 ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scriptcollection-3.5.140.dist-info/METADATA,sha256=h47YkJZXJr_B_LQt2qF2bEJnHxtoc6Us-cKkxiVxBts,7694
-scriptcollection-3.5.140.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-scriptcollection-3.5.140.dist-info/entry_points.txt,sha256=AvmVO9iyWImExpvzL3YYQ9AOEiUIN9guPRRG_W_VNWY,4116
-scriptcollection-3.5.140.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
-scriptcollection-3.5.140.dist-info/RECORD,,
+scriptcollection-3.5.143.dist-info/METADATA,sha256=_LIGGGBWhdvyi-HunxH_73o-n4Y0sqBTZTs_s4oT0fQ,7694
+scriptcollection-3.5.143.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+scriptcollection-3.5.143.dist-info/entry_points.txt,sha256=AvmVO9iyWImExpvzL3YYQ9AOEiUIN9guPRRG_W_VNWY,4116
+scriptcollection-3.5.143.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
+scriptcollection-3.5.143.dist-info/RECORD,,