ScriptCollection 3.5.18__py3-none-any.whl → 3.5.20__py3-none-any.whl

ScriptCollection/Executables.py

@@ -362,10 +362,11 @@ def GenerateARC42ReferenceTemplate() -> int:
     parser = argparse.ArgumentParser()
     parser.add_argument('-f', '--folder', required=False)
     parser.add_argument('-p', '--productname', required=False)
+    parser.add_argument('-s', '--subfolder', required=False)
     args = parser.parse_args()
 
     folder = args.folder
     if folder is None:
         folder = os.getcwd()
-    ScriptCollectionCore().generate_arc42_reference_template(folder, args.productname)
+    ScriptCollectionCore().generate_arc42_reference_template(folder, args.productname, args.subfolder)
     return 0

ScriptCollection/ScriptCollectionCore.py

@@ -30,7 +30,7 @@ from .ProgramRunnerBase import ProgramRunnerBase
 from .ProgramRunnerPopen import ProgramRunnerPopen
 from .ProgramRunnerEpew import ProgramRunnerEpew, CustomEpewArgument
 
-version = "3.5.18"
+version = "3.5.20"
 __version__ = version
 
 
@@ -414,8 +414,8 @@ class ScriptCollectionCore:
             args.append("-m")
             args.append(commit_message)
         args.append(sourcebranch)
-        self.run_program_argsasarray(
-            "git", args, directory, throw_exception_if_exitcode_is_not_zero=True, verbosity=0)
+        self.run_program_argsasarray("git", args, directory, throw_exception_if_exitcode_is_not_zero=True, verbosity=0)
+        self.run_program_argsasarray("git", ["submodule", "update"], directory, throw_exception_if_exitcode_is_not_zero=True, verbosity=0)
         return self.git_get_commit_id(directory)
 
     @GeneralUtilities.check_arguments
@@ -1757,11 +1757,13 @@ chmod {permission} {link_file}
 """.replace("XDX", "ODO"))
 
     @GeneralUtilities.check_arguments
-    def generate_arc42_reference_template(self, repository: str, productname: str = None):
+    def generate_arc42_reference_template(self, repository: str, productname: str = None, subfolder: str = None):
         productname: str
         if productname is None:
             productname = os.path.basename(repository)
-        reference_root_folder = f"{repository}/Other/Resources/Reference"
+        if subfolder is None:
+            subfolder = "Other/Resources/Reference"
+        reference_root_folder = f"{repository}/{subfolder}"
         reference_content_folder = reference_root_folder + "/Technical"
         if os.path.isdir(reference_root_folder):
             raise ValueError(f"The folder '{reference_root_folder}' does already exist.")
@@ -1780,11 +1782,11 @@ TXDX add minimal service-description here.
 
 TXDX
 
-# Quality goals
+## Quality goals
 
- TXDX
+TXDX
 
-# Stakeholder
+## Stakeholder
 
 | Name | How to contact | Reason |
 | ---- | -------------- | ------ |""")
@@ -1803,7 +1805,7 @@ TXDX
 
 ## Scope
 
- TXDX""")
+TXDX""")
         self.__add_chapter(main_reference_file, reference_content_folder, 4, 'Solution Strategy', """TXDX""")
         self.__add_chapter(main_reference_file, reference_content_folder, 5, 'Building Block View', """TXDX""")
         self.__add_chapter(main_reference_file, reference_content_folder, 6, 'Runtime View', """TXDX""")

ScriptCollection/TasksForCommonProjectStructure.py

@@ -1840,6 +1840,74 @@ class TasksForCommonProjectStructure:
         self.__sc.run_program("swagger", f"tofile --output {versioned_api_spec_file} BuildResult_DotNet_{runtime}/{codeunitname}.dll {swagger_document_name}", artifacts_folder, verbosity=verbosity)
         shutil.copyfile(os.path.join(artifacts_folder, versioned_api_spec_file), os.path.join(artifacts_folder, f"APISpecification/{codeunitname}.latest.api.json"))
 
+    @GeneralUtilities.check_arguments
+    def ensure_openapigenerator_is_available(self, codeunit_folder: str) -> None:
+        openapigenerator_folder = os.path.join(codeunit_folder, "Other", "Resources", "OpenAPIGenerator")
+        internet_connection_is_available = GeneralUtilities.internet_connection_is_available()
+        filename = "open-api-generator.jar"
+        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)
+        else:
+            if jar_file_exists:
+                GeneralUtilities.write_message_to_stdout("Warning: Can not check for updates of OpenAPIGenerator due to missing internet-connection.")
+            else:
+                raise ValueError("Can not download OpenAPIGenerator.")
+
+    def generate_api_client_from_dependent_codeunit_in_dotnet(self, file: str, name_of_api_providing_codeunit: str, base_namespace: str) -> None:
+        codeunit_folder = GeneralUtilities.resolve_relative_path("../..", file)
+        codeunit_name = os.path.basename(codeunit_folder)
+        client_subpath = f"{codeunit_name}/APIClients/{name_of_api_providing_codeunit}"
+        namespace = f"{base_namespace}.APIClients.{name_of_api_providing_codeunit}"
+        self.generate_api_client_from_dependent_codeunit(file, name_of_api_providing_codeunit, client_subpath, "csharp", f"--additional-properties packageName={namespace}")
+
+    def generate_api_client_from_dependent_codeunit(self, file: str, name_of_api_providing_codeunit: str, target_subfolder_in_codeunit: str, language: str, additional_properties: str) -> None:
+        codeunit_folder = GeneralUtilities.resolve_relative_path("../..", file)
+        self.ensure_openapigenerator_is_available(codeunit_folder)
+        openapigenerator_jar_file = os.path.join(codeunit_folder, "Other", "Resources", "OpenAPIGenerator", "open-api-generator.jar")
+        openapi_spec_file = os.path.join(codeunit_folder, "Other", "Resources", "DependentCodeUnits", name_of_api_providing_codeunit, "APISpecification", f"{name_of_api_providing_codeunit}.latest.api.json")
+        target_folder = os.path.join(codeunit_folder, target_subfolder_in_codeunit)
+        GeneralUtilities.ensure_directory_exists(target_folder)
+        ScriptCollectionCore().run_program("java", f'-jar {openapigenerator_jar_file} generate -i {openapi_spec_file} -g {language} -o {target_folder} --global-property supportingFiles --global-property models --global-property apis {additional_properties}', codeunit_folder)
+
+        # move docs to correct folder
+        target_folder_docs = os.path.join(target_folder, "docs")
+        target_folder_docs_correct = os.path.join(codeunit_folder, "Other", "Reference", "ReferenceContent", f"{name_of_api_providing_codeunit}-API")
+        GeneralUtilities.ensure_directory_does_not_exist(target_folder_docs_correct)
+        GeneralUtilities.ensure_directory_exists(target_folder_docs_correct)
+        GeneralUtilities.move_content_of_folder(target_folder_docs, target_folder_docs_correct)
+        GeneralUtilities.ensure_directory_does_not_exist(target_folder_docs)
+
+        code_folders = GeneralUtilities.get_direct_folders_of_folder(os.path.join(target_folder, "src"))
+
+        # remove test-folder
+        tests_folder = [x for x in code_folders if x.endswith(".Test")][0]
+        GeneralUtilities.ensure_directory_does_not_exist(tests_folder)
+
+        # move source to correct folder
+        src_folder = [x for x in code_folders if not x.endswith(".Test")][0]
+        target_folder_src = GeneralUtilities.resolve_relative_path("../..", src_folder)
+
+        for targetfile in GeneralUtilities.get_direct_files_of_folder(target_folder_src):
+            GeneralUtilities.ensure_file_does_not_exist(targetfile)
+        for folder in GeneralUtilities.get_direct_folders_of_folder(target_folder_src):
+            f = folder.replace("\\", "/")
+            if not f.endswith("/.openapi-generator") and not f.endswith("/src"):
+                GeneralUtilities.ensure_directory_does_not_exist(f)
+        GeneralUtilities.ensure_directory_exists(target_folder_src)
+        GeneralUtilities.move_content_of_folder(src_folder, target_folder_src)
+        GeneralUtilities.ensure_directory_does_not_exist(src_folder)
+        for targetfile in GeneralUtilities.get_direct_files_of_folder(target_folder_src):
+            GeneralUtilities.ensure_file_does_not_exist(targetfile)
+
     @GeneralUtilities.check_arguments
     def replace_version_in_packagejson_file(self, packagejson_file: str, codeunit_version: str) -> None:
         encoding = "utf-8"
@@ -2507,7 +2575,7 @@ class TasksForCommonProjectStructure:
                 else:
                     GeneralUtilities.write_message_to_stdout(f"There are no dependencies to update in codeunit {codeunit}.")
         if updated_dependencies:
-            self.__sc.run_program("scbuildcodeunits", "--targetenvironment QualityCheck", repository_folder)  # TODO set verbosity
+            self.__sc.run_program("scbuildcodeunits", "--targetenvironment QualityCheck", repository_folder, verbosity=verbosity)  # TODO set timeout
             self.__sc.git_commit(repository_folder, "Updated dependencies")
 
     class GenericPrepareNewReleaseArguments:

{ScriptCollection-3.5.18.dist-info → ScriptCollection-3.5.20.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ScriptCollection
-Version: 3.5.18
+Version: 3.5.20
 Summary: The ScriptCollection is the place for reusable scripts.
 Home-page: https://github.com/anionDev/ScriptCollection
 Author: Marius Göcke
@@ -22,26 +22,26 @@ Classifier: Topic :: Terminals
 Classifier: Topic :: Utilities
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
-Requires-Dist: build >=1.2.1
-Requires-Dist: coverage >=7.6.0
-Requires-Dist: cyclonedx-bom >=4.5.0
+Requires-Dist: build >=1.2.2
+Requires-Dist: coverage >=7.6.1
+Requires-Dist: cyclonedx-bom >=4.6.1
 Requires-Dist: defusedxml >=0.7.1
 Requires-Dist: keyboard >=0.13.5
 Requires-Dist: lcov-cobertura >=2.0.2
-Requires-Dist: lxml >=5.2.2
+Requires-Dist: lxml >=5.3.0
 Requires-Dist: ntplib >=0.4.0
 Requires-Dist: Pillow >=10.4.0
 Requires-Dist: pycdlib >=1.14.0
 Requires-Dist: Pygments >=2.18.0
-Requires-Dist: pylint >=3.2.6
+Requires-Dist: pylint >=3.3.1
 Requires-Dist: pyOpenSSL >=24.2.1
 Requires-Dist: PyPDF2 >=3.0.1
-Requires-Dist: pytest >=8.3.2
-Requires-Dist: PyYAML >=6.0.1
-Requires-Dist: qrcode >=7.4.2
+Requires-Dist: pytest >=8.3.3
+Requires-Dist: PyYAML >=6.0.2
+Requires-Dist: qrcode >=8.0
 Requires-Dist: send2trash >=1.8.3
 Requires-Dist: twine >=5.1.1
-Requires-Dist: xmlschema >=3.3.2
+Requires-Dist: xmlschema >=3.4.2
 
 # ScriptCollection
 

{ScriptCollection-3.5.18.dist-info → ScriptCollection-3.5.20.dist-info}/RECORD

@@ -1,16 +1,16 @@
-ScriptCollection/Executables.py,sha256=Ui9omPvmBjnsgFZXpeXMoZXmk17sjPyO1mS_7B7w8aY,19951
+ScriptCollection/Executables.py,sha256=rdyVf_rWHIHeAeOngTeyohYYIimb0BqtZxUBDDpQSDQ,20028
 ScriptCollection/GeneralUtilities.py,sha256=AElXv2NO30cTw-Qs3qVmO-YCOQ5FvBQM3RZMywuKQ_Y,35121
 ScriptCollection/ProcessesRunner.py,sha256=3mu4ZxzZleQo0Op6o9EYTCFiJfb6kx5ov2YfZfT89mU,1395
 ScriptCollection/ProgramRunnerBase.py,sha256=7QAjoqOz6XPmJH19F2k-Z1fFQB_uZnPFvn-T54IJcHQ,2324
 ScriptCollection/ProgramRunnerEpew.py,sha256=C2Rs3YWOWWWJct7XmKphp5CF1tf0j4Fp-ljV2drLTfs,6349
 ScriptCollection/ProgramRunnerPopen.py,sha256=G3LgQUVCfaq7XjBsGzalElH31Hbr0etttGR2_H87YzA,3512
 ScriptCollection/RPStream.py,sha256=NRRHL3YSP3D9MuAV2jB_--0KUKCsvJGxeKnxgrRZ9kY,1545
-ScriptCollection/ScriptCollectionCore.py,sha256=5As77GOFsK0QWvwQW49rPh-KRVugq7RTkeSmhcmV61o,100035
-ScriptCollection/TasksForCommonProjectStructure.py,sha256=QWUusRX-iMI96V7D41I8u3at1HYR9Fv1BPdTvkvFF8s,185366
+ScriptCollection/ScriptCollectionCore.py,sha256=a0v9sXIrZ2ymtcwcZUFsBUKsrhzYFOUAhzd28s9I1KQ,100252
+ScriptCollection/TasksForCommonProjectStructure.py,sha256=9Nm7btdvikTOCOQaSXRV7sadaIi2aVqTWVCvUcYclK8,190588
 ScriptCollection/UpdateCertificates.py,sha256=Eynbgu7k9jLxApP2D_8Il77B6BFjJap6K7oTeEAZYbk,7790
 ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ScriptCollection-3.5.18.dist-info/METADATA,sha256=DKfaIJ6HfmBFP_ql4-E8tur2iBPQkucg4gaHLtyPK70,7680
-ScriptCollection-3.5.18.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-ScriptCollection-3.5.18.dist-info/entry_points.txt,sha256=yASwR6hWZ_b5d4W49YeX1htD8ngfWbwgjpfQiJdtUAU,2322
-ScriptCollection-3.5.18.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
-ScriptCollection-3.5.18.dist-info/RECORD,,
+ScriptCollection-3.5.20.dist-info/METADATA,sha256=H0PzPBf00yKeONM1Mer8i5AbyoDpZeEfiqzg5r1T-5E,7678
+ScriptCollection-3.5.20.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+ScriptCollection-3.5.20.dist-info/entry_points.txt,sha256=yASwR6hWZ_b5d4W49YeX1htD8ngfWbwgjpfQiJdtUAU,2322
+ScriptCollection-3.5.20.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
+ScriptCollection-3.5.20.dist-info/RECORD,,