ScriptCollection 3.5.31__py3-none-any.whl → 3.5.32__py3-none-any.whl

ScriptCollection/Executables.py

@@ -371,3 +371,19 @@ def GenerateARC42ReferenceTemplate() -> int:
         folder = os.getcwd()
     ScriptCollectionCore().generate_arc42_reference_template(folder, args.productname, args.subfolder)
     return 0
+
+
+def CreateChangelogEntry() -> int:
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-f', '--repositoryfolder', required=False, default=".")
+    parser.add_argument('-p', '--message', required=True)
+    parser.add_argument('-s', '--commit', action='store_true', required=False, default=False)
+    args = parser.parse_args()
+
+    folder: str = None
+    if os.path.isabs(args.repositoryfolder):
+        folder = args.repositoryfolder
+    else:
+        folder = GeneralUtilities.resolve_relative_path(args.repositoryfolder, os.getcwd())
+    TasksForCommonProjectStructure().create_changelog_entry(folder, args.message, args.commit)
+    return 0

ScriptCollection/GeneralUtilities.py

@@ -732,8 +732,7 @@ class GeneralUtilities:
 
     @staticmethod
     @check_arguments
-    def read_csv_file(file: str, ignore_first_line: bool = False, treat_number_sign_at_begin_of_line_as_comment: bool = True, trim_values: bool = True,
-                      encoding="utf-8", ignore_empty_lines: bool = True, separator_character: str = ";", values_are_surrounded_by_quotes: bool = False) -> list[list[str]]:
+    def read_csv_file(file: str, ignore_first_line: bool = False, treat_number_sign_at_begin_of_line_as_comment: bool = True, trim_values: bool = True, encoding="utf-8", ignore_empty_lines: bool = True, separator_character: str = ";", values_are_surrounded_by_quotes: bool = False) -> list[list[str]]:
         lines = GeneralUtilities.read_lines_from_file(file, encoding)
 
         if ignore_first_line:

ScriptCollection/ScriptCollectionCore.py

@@ -31,7 +31,7 @@ from .ProgramRunnerBase import ProgramRunnerBase
 from .ProgramRunnerPopen import ProgramRunnerPopen
 from .ProgramRunnerEpew import ProgramRunnerEpew, CustomEpewArgument
 
-version = "3.5.31"
+version = "3.5.32"
 __version__ = version
 
 
@@ -1719,26 +1719,22 @@ chmod {permission} {link_file}
         GeneralUtilities.write_lines_to_file(file, lines)
 
     @GeneralUtilities.check_arguments
-    def get_external_ip(self, proxy: str) -> str:
-        information = self.get_externalnetworkinformation_as_json_string(proxy)
+    def get_external_ip(self) -> str:
+        information = self.get_externalnetworkinformation_as_json_string()
         parsed = json.loads(information)
-        return parsed.ip
+        return parsed.IPAddress
 
     @GeneralUtilities.check_arguments
-    def get_country_of_external_ip(self, proxy: str) -> str:
-        information = self.get_externalnetworkinformation_as_json_string(proxy)
+    def get_country_of_external_ip(self) -> str:
+        information = self.get_externalnetworkinformation_as_json_string()
         parsed = json.loads(information)
-        return parsed.country
+        return parsed.Country
 
     @GeneralUtilities.check_arguments
-    def get_externalnetworkinformation_as_json_string(self, proxy: str) -> str:
-        proxies = None
-        if GeneralUtilities.string_has_content(proxy):
-            proxies = {"http": proxy}
+    def get_externalnetworkinformation_as_json_string(self) -> str:
         headers = {'Cache-Control': 'no-cache'}
-        response = requests.get('https://ipinfo.io',  proxies=proxies, timeout=5, headers=headers)
-        network_information_as_json_string = GeneralUtilities.bytes_to_string(
-            response.content)
+        response = requests.get('https://clientinformation.anion327.de/API/v1/ClientInformationBackendController/Information',  timeout=5, headers=headers)
+        network_information_as_json_string = GeneralUtilities.bytes_to_string(response.content)
         return network_information_as_json_string
 
     @GeneralUtilities.check_arguments

ScriptCollection/TasksForCommonProjectStructure.py

@@ -1102,9 +1102,7 @@ class TasksForCommonProjectStructure:
             raise ValueError(f"Repository '{repository_folder}' has uncommitted changes.")
 
     @GeneralUtilities.check_arguments
-    def ensure_certificate_authority_for_development_purposes_is_generated(self, script_file: str):
-        folder_of_current_file = os.path.dirname(script_file)
-        product_folder: str = GeneralUtilities.resolve_relative_path("../..", folder_of_current_file)
+    def ensure_certificate_authority_for_development_purposes_is_generated(self, product_folder: str):
         product_name: str = os.path.basename(product_folder)
         now = datetime.now()
         ca_name = f"{product_name}CA_{now.year:04}{now.month:02}{now.day:02}{now.hour:02}{now.min:02}{now.second:02}"
@@ -1119,6 +1117,15 @@ class TasksForCommonProjectStructure:
                 pass
         if generate_certificate:
             self.__sc.generate_certificate_authority(ca_folder, ca_name, "DE", "SubjST", "SubjL", "SubjO", "SubjOU")
+        # TODO add switch to auto-install the script if desired
+        # for windows: powershell Import-Certificate -FilePath ConSurvCA_20241121000236.crt -CertStoreLocation 'Cert:\CurrentUser\Root'
+        # for linux: (TODO)
+
+    @GeneralUtilities.check_arguments
+    def generate_certificate_for_development_purposes_for_product(self, repository_folder: str):
+        product_name = os.path.basename(repository_folder)
+        ca_folder: str = os.path.join(repository_folder, "Other", "Resources", "CA")
+        self.__generate_certificate_for_development_purposes(product_name, os.path.join(repository_folder, "Other", "Resources"), ca_folder, None)
 
     @GeneralUtilities.check_arguments
     def generate_certificate_for_development_purposes_for_external_service(self, service_folder: str, domain: str = None):
@@ -1160,6 +1167,15 @@ class TasksForCommonProjectStructure:
             self.__sc.sign_certificate(certificate_folder, ca_folder, ca_name, domain, resource_content_filename)
             GeneralUtilities.ensure_file_does_not_exist(unsignedcertificate_file)
 
+    @GeneralUtilities.check_arguments
+    def copy_product_resource_to_codeunit_resource_folder(self, codeunit_folder: str, resourcename: str) -> None:
+        src_folder = GeneralUtilities.resolve_relative_path(f"../Other/Resources/{resourcename}", codeunit_folder)
+        GeneralUtilities.assert_condition(os.path.isdir(src_folder), f"Required product-resource {resourcename} does not exist. Expected folder: {src_folder}")
+        trg_folder = GeneralUtilities.resolve_relative_path(f"Other/Resources/{resourcename}", codeunit_folder)
+        GeneralUtilities.ensure_directory_does_not_exist(trg_folder)
+        GeneralUtilities.ensure_directory_exists(trg_folder)
+        GeneralUtilities.copy_content_of_folder(src_folder, trg_folder)
+
     @GeneralUtilities.check_arguments
     def ensure_product_resource_is_imported(self, codeunit_folder: str, product_resource_name: str) -> None:
         product_folder = os.path.dirname(codeunit_folder)
@@ -1803,7 +1819,7 @@ class TasksForCommonProjectStructure:
 
     @GeneralUtilities.check_arguments
     def copy_development_certificate_to_default_development_directory(self, codeunit_folder: str, build_environment: str, domain: str = None, certificate_resource_name: str = "DevelopmentCertificate") -> None:
-        if build_environment == "Development":
+        if build_environment != "Productive":
             codeunit_name: str = os.path.basename(codeunit_folder)
             if domain is None:
                 domain = f"{codeunit_name}.test.local".lower()
@@ -2272,7 +2288,7 @@ class TasksForCommonProjectStructure:
         changelog_folder = os.path.join(repository_folder, "Other", "Resources", "Changelog")
         changelog_file = os.path.join(changelog_folder, f"v{project_version}.md")
         if not os.path.isfile(changelog_file):
-            raise ValueError(f"Changelog-file '{changelog_file}' does not exist.")
+            raise ValueError(f"Changelog-file '{changelog_file}' does not exist. Try creating it using 'sccreatechangelogentry' for example.")
 
     @GeneralUtilities.check_arguments
     def __check_whether_security_txt_exists(self, repository_folder: str) -> None:
@@ -2743,6 +2759,21 @@ class TasksForCommonProjectStructure:
             self.commandline_arguments = commandline_arguments
             self.main_branch_name = "main"
 
+    @GeneralUtilities.check_arguments
+    def create_changelog_entry(self, repositoryfolder: str, message: str, commit: bool):
+        current_version = self.get_version_of_project(repositoryfolder)
+        changelog_file = os.path.join(repositoryfolder, "Other", "Resources", "Changelog", f"v{current_version}.md")
+        if os.path.isdir(changelog_file):
+            raise ValueError(f"Changelogfile {changelog_file} already exists.")
+        else:
+            GeneralUtilities.ensure_file_exists(changelog_file)
+            GeneralUtilities.write_text_to_file(changelog_file, f"""# Release notes
+
+## Changes
+
+- {message}
+""")
+
     @GeneralUtilities.check_arguments
     def update_http_documentation(self, update_http_documentation_arguments: UpdateHTTPDocumentationArguments):
         GeneralUtilities.write_message_to_stdout(f"Update HTTP-documentation for for {update_http_documentation_arguments.product_name}.")

{ScriptCollection-3.5.31.dist-info → ScriptCollection-3.5.32.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ScriptCollection
-Version: 3.5.31
+Version: 3.5.32
 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.2.post1
-Requires-Dist: coverage >=7.6.7
-Requires-Dist: cyclonedx-bom >=5.1.1
-Requires-Dist: defusedxml >=0.7.1
-Requires-Dist: keyboard >=0.13.5
-Requires-Dist: lcov-cobertura >=2.0.2
-Requires-Dist: lxml >=5.3.0
-Requires-Dist: ntplib >=0.4.0
-Requires-Dist: Pillow >=11.0.0
-Requires-Dist: pycdlib >=1.14.0
-Requires-Dist: Pygments >=2.18.0
-Requires-Dist: pylint >=3.3.1
-Requires-Dist: pyOpenSSL >=24.2.1
-Requires-Dist: PyPDF2 >=3.0.1
-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.4.3
+Requires-Dist: build>=1.2.2.post1
+Requires-Dist: coverage>=7.6.8
+Requires-Dist: cyclonedx-bom>=5.1.1
+Requires-Dist: defusedxml>=0.7.1
+Requires-Dist: keyboard>=0.13.5
+Requires-Dist: lcov-cobertura>=2.0.2
+Requires-Dist: lxml>=5.3.0
+Requires-Dist: ntplib>=0.4.0
+Requires-Dist: Pillow>=11.0.0
+Requires-Dist: pycdlib>=1.14.0
+Requires-Dist: Pygments>=2.18.0
+Requires-Dist: pylint>=3.3.1
+Requires-Dist: pyOpenSSL>=24.2.1
+Requires-Dist: PyPDF2>=3.0.1
+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.4.3
 
 # ScriptCollection
 

ScriptCollection-3.5.32.dist-info/RECORD

@@ -0,0 +1,16 @@
+ScriptCollection/Executables.py,sha256=BORL6X7QF3_A_UzQjiH4NfKLp2cWftSs48rb99hXnUM,20819
+ScriptCollection/GeneralUtilities.py,sha256=prDx6pTHFVwH4_aFBIQ843Td2su-VJ1PVx8qwRKxCAQ,35786
+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=jOv1mqd_-5S7gpwXgoAPaMGrrcjrbqvCNPaNb2a3uek,101810
+ScriptCollection/TasksForCommonProjectStructure.py,sha256=piNVRc6__qqGGhEX-vB1SuKQu3m8uaPHi_20RO0jcd4,197149
+ScriptCollection/UpdateCertificates.py,sha256=Eynbgu7k9jLxApP2D_8Il77B6BFjJap6K7oTeEAZYbk,7790
+ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ScriptCollection-3.5.32.dist-info/METADATA,sha256=cuwsb2y18ZtOsonyOt6_101KjtNrVB2T_n0kG9KyI38,7664
+ScriptCollection-3.5.32.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+ScriptCollection-3.5.32.dist-info/entry_points.txt,sha256=_O7BmQ81LdDfrj5uOhjshg9Xc-tABHQJIxDOyOGRzzI,2397
+ScriptCollection-3.5.32.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
+ScriptCollection-3.5.32.dist-info/RECORD,,

{ScriptCollection-3.5.31.dist-info → ScriptCollection-3.5.32.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.5.0)
+Generator: setuptools (75.6.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{ScriptCollection-3.5.31.dist-info → ScriptCollection-3.5.32.dist-info}/entry_points.txt

@@ -5,6 +5,7 @@ scbuildcodeunitsc = ScriptCollection.Executables:BuildCodeUnitsC
 sccalculatebitcoinblockhash = ScriptCollection.Executables:CalculateBitcoinBlockHash
 scchangefileextension = ScriptCollection.Executables:ChangeFileExtensions
 scchangehashofprogram = ScriptCollection.Executables:ChangeHashOfProgram
+sccreatechangelogentry = ScriptCollection.Executables:CreateChangelogEntry
 sccreateemptyfilewithspecificsize = ScriptCollection.Executables:CreateEmptyFileWithSpecificSize
 sccreatehashofallfiles = ScriptCollection.Executables:CreateHashOfAllFiles
 sccreateisofilewithobfuscatedfiles = ScriptCollection.Executables:CreateISOFileWithObfuscatedFiles

ScriptCollection-3.5.31.dist-info/RECORD

@@ -1,16 +0,0 @@
-ScriptCollection/Executables.py,sha256=57f2bopoRUchbyyCZTseBk0ynEyHfXc2u4-LraxI7qg,20161
-ScriptCollection/GeneralUtilities.py,sha256=6tMhEThExEJse33i7HgfJEvRqndNkSOzoXDQA8lUfHw,35809
-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=OYVN6uOsQgwVk4CCGwNZPiuqblf7zaXLrO_G2Vq57ic,101921
-ScriptCollection/TasksForCommonProjectStructure.py,sha256=lrypLs_dF5a0CCKinMwZhbg0LxJkVHxlmqJF4B6I31U,195223
-ScriptCollection/UpdateCertificates.py,sha256=Eynbgu7k9jLxApP2D_8Il77B6BFjJap6K7oTeEAZYbk,7790
-ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ScriptCollection-3.5.31.dist-info/METADATA,sha256=AmndyxGsXVmE1zsut5NOoZyk1sMChMoqGdcXiP6wA0w,7684
-ScriptCollection-3.5.31.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
-ScriptCollection-3.5.31.dist-info/entry_points.txt,sha256=yASwR6hWZ_b5d4W49YeX1htD8ngfWbwgjpfQiJdtUAU,2322
-ScriptCollection-3.5.31.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
-ScriptCollection-3.5.31.dist-info/RECORD,,