capycli 2.8.1__tar.gz → 2.9.0.dev1__tar.gz

{capycli-2.8.1 → capycli-2.9.0.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: capycli
-Version: 2.8.1
+Version: 2.9.0.dev1
 Summary: CaPyCli - Clearing Automation Python Command Line Interface for SW360
 Home-page: https://github.com/sw360/capycli
 License: MIT

{capycli-2.8.1 → capycli-2.9.0.dev1}/capycli/__init__.py

@@ -63,6 +63,12 @@ def get_app_version() -> str:
     return version
 
 
+def get_app_signature() -> str:
+    """Get the signature of this application."""
+    version = get_app_version()
+    return f"{APP_NAME}, {version}"
+
+
 # There is nothing lower than logging.DEBUG (10) in the logging library,
 # but we want an extra level to avoid being too verbose when using -vv.
 _EXTRA_VERBOSE = 5

{capycli-2.8.1 → capycli-2.9.0.dev1}/capycli/bom/bom_convert.py

@@ -163,7 +163,7 @@ class BomConvert(capycli.common.script_base.ScriptBase):
 
     def run(self, args: Any) -> None:
         """Main method()"""
-        print("\n" + capycli.APP_NAME + ", " + capycli.get_app_version() + " - Convert SBOM formats\n")
+        print("\n" + capycli.get_app_signature() + " - Convert SBOM formats\n")
 
         if args.help:
             self.display_help()

{capycli-2.8.1 → capycli-2.9.0.dev1}/capycli/bom/bom_validate.py

@@ -61,7 +61,7 @@ class BomValidate(capycli.common.script_base.ScriptBase):
 
     def run(self, args: Any) -> None:
         """Main method()"""
-        print("\n" + capycli.APP_NAME + ", " + capycli.get_app_version() + " - Validate a CaPyCLI/CycloneDX SBOM\n")
+        print("\n" + capycli.get_app_signature() + " - Validate a CaPyCLI/CycloneDX SBOM\n")
 
         if args.help:
             self.display_help()

{capycli-2.8.1 → capycli-2.9.0.dev1}/capycli/bom/check_bom.py

@@ -158,7 +158,7 @@ class CheckBom(capycli.common.script_base.ScriptBase):
             logging.getLogger("urllib3.connectionpool").setLevel(logging.WARNING)
 
         print_text(
-            "\n" + capycli.APP_NAME + ", " + capycli.get_app_version() +
+            "\n" + capycli.get_app_signature() +
             " - Check that all releases in the SBOM exist on target SW360 instance.\n")
 
         if args.help:

{capycli-2.8.1 → capycli-2.9.0.dev1}/capycli/bom/check_bom_item_status.py

@@ -176,7 +176,7 @@ class CheckBomItemStatus(capycli.common.script_base.ScriptBase):
             logging.getLogger("urllib3.connectionpool").setLevel(logging.WARNING)
 
         print_text(
-            "\n" + capycli.APP_NAME + ", " + capycli.get_app_version()
+            "\n" + capycli.get_app_signature()
             + " - check the status of the items on SW360\n")
 
         if args.help:

{capycli-2.8.1 → capycli-2.9.0.dev1}/capycli/bom/check_granularity.py

@@ -224,7 +224,7 @@ class CheckGranularity(capycli.common.script_base.ScriptBase):
             LOG = capycli.get_logger(__name__)
 
         print_text(
-            "\n" + capycli.APP_NAME + ", " + capycli.get_app_version() +
+            "\n" + capycli.get_app_signature() +
             " - Check the granularity of all releases in the SBOM.\n")
 
         if args.help:

{capycli-2.8.1 → capycli-2.9.0.dev1}/capycli/bom/create_components.py

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------------
-# Copyright (c) 2019-2024 Siemens
+# Copyright (c) 2019-2025 Siemens
 # All Rights Reserved.
 # Author: thomas.graf@siemens.com
 #
@@ -259,6 +259,10 @@ class BomCreateComponents(capycli.common.script_base.ScriptBase):
             # ensure that we have the only correct external-id name: package-url
             data["externalIds"]["package-url"] = cx_comp.purl.to_string()
 
+        # add information that this release was created by CaPyCli
+        data["additionalData"] = {}
+        data["additionalData"]["createdWith"] = capycli.get_app_signature()
+
         # use project site as fallback for source code download url
         website = CycloneDxSupport.get_ext_ref_website(cx_comp)
         repo = CycloneDxSupport.get_ext_ref_repository(cx_comp)
@@ -318,6 +322,11 @@ class BomCreateComponents(capycli.common.script_base.ScriptBase):
         if cx_comp.purl:
             purl = PurlUtils.component_purl_from_release_purl(cx_comp.purl)
             data["externalIds"] = {"package-url": purl}
+
+        # add information that this component was created by CaPyCli
+        data["additionalData"] = {}
+        data["additionalData"]["createdWith"] = capycli.get_app_signature()
+
         return data
 
     def create_release(self, cx_comp: Component, component_id: str) -> Optional[Dict[str, Any]]:
@@ -733,7 +742,7 @@ class BomCreateComponents(capycli.common.script_base.ScriptBase):
             logging.getLogger("urllib3.connectionpool").setLevel(logging.WARNING)
 
         print_text(
-            "\n" + capycli.APP_NAME + ", " + capycli.get_app_version() +
+            "\n" + capycli.get_app_signature() +
             " - Create new components and releases on SW360\n")
 
         if args.help:

{capycli-2.8.1 → capycli-2.9.0.dev1}/capycli/bom/diff_bom.py

@@ -202,7 +202,7 @@ class DiffBom(capycli.common.script_base.ScriptBase):
             LOG = capycli.get_logger(__name__)
 
         print_text(
-            "\n" + capycli.APP_NAME + ", " + capycli.get_app_version() +
+            "\n" + capycli.get_app_signature() +
             " - Compare two SBOM files.\n")
 
         if args.help:

{capycli-2.8.1 → capycli-2.9.0.dev1}/capycli/bom/download_sources.py

@@ -158,7 +158,7 @@ class BomDownloadSources(capycli.common.script_base.ScriptBase):
             logging.getLogger("urllib3.connectionpool").setLevel(logging.WARNING)
 
         print_text(
-            "\n" + capycli.APP_NAME + ", " + capycli.get_app_version() +
+            "\n" + capycli.get_app_signature() +
             " - Download source files from the URL specified in the SBOM\n")
 
         if args.help:

{capycli-2.8.1 → capycli-2.9.0.dev1}/capycli/bom/filter_bom.py

@@ -271,7 +271,7 @@ class FilterBom(capycli.common.script_base.ScriptBase):
             global LOG
             LOG = capycli.get_logger(__name__)
 
-        print_text("\n" + capycli.APP_NAME + ", " + capycli.get_app_version() + " - Apply a filter file to a SBOM\n")
+        print_text("\n" + capycli.get_app_signature() + " - Apply a filter file to a SBOM\n")
 
         if args.help:
             print("Usage: CaPyCli bom filter [-h] [-v] -i INPUTFILE -o OUTPUTFILE -filterfile FILTERFILE")

{capycli-2.8.1 → capycli-2.9.0.dev1}/capycli/bom/findsources.py

@@ -694,7 +694,7 @@ class FindSources(capycli.common.script_base.ScriptBase):
             logging.getLogger("urllib3.connectionpool").setLevel(logging.WARNING)
 
         print_text(
-            "\n" + capycli.APP_NAME + ", " + capycli.get_app_version() +
+            "\n" + capycli.get_app_signature() +
             " - Go through the list of SBOM items and try to determine the source code.\n")
 
         if args.help:

{capycli-2.8.1 → capycli-2.9.0.dev1}/capycli/bom/map_bom.py

@@ -832,7 +832,7 @@ class MapBom(capycli.common.script_base.ScriptBase):
             logging.getLogger("urllib3.connectionpool").setLevel(logging.WARNING)
 
         print_text(
-            "\n" + capycli.APP_NAME + ", " + capycli.get_app_version() +
+            "\n" + capycli.get_app_signature() +
             " - Map a given SBOM to data on SW360\n")
 
         if args.help:

{capycli-2.8.1 → capycli-2.9.0.dev1}/capycli/bom/merge_bom.py

@@ -122,7 +122,7 @@ class MergeBom(capycli.common.script_base.ScriptBase):
             LOG = capycli.get_logger(__name__)
 
         print_text(
-            "\n" + capycli.APP_NAME + ", " + capycli.get_app_version() +
+            "\n" + capycli.get_app_signature() +
             " - Merge two SBOM files.\n")
 
         if args.help:

{capycli-2.8.1 → capycli-2.9.0.dev1}/capycli/bom/show_bom.py

@@ -98,7 +98,7 @@ class ShowBom(capycli.common.script_base.ScriptBase):
             global LOG
             LOG = capycli.get_logger(__name__)
 
-        print_text("\n" + capycli.APP_NAME + ", " + capycli.get_app_version() + " - Print SBOM contents to stdout\n")
+        print_text("\n" + capycli.get_app_signature() + " - Print SBOM contents to stdout\n")
 
         if args.help:
             print("usage: capycli bom show [-h] -i bomfile")

{capycli-2.8.1 → capycli-2.9.0.dev1}/capycli/dependencies/javascript.py

@@ -279,7 +279,7 @@ class GetJavascriptDependencies(capycli.common.dependencies_base.DependenciesBas
             logging.getLogger("urllib3.connectionpool").setLevel(logging.WARNING)
 
         print_text(
-            "\n" + capycli.APP_NAME + ", " + capycli.get_app_version() +
+            "\n" + capycli.get_app_signature() +
             " - Determine Javascript components/dependencies\n")
 
         if args.help:

{capycli-2.8.1 → capycli-2.9.0.dev1}/capycli/dependencies/maven_list.py

@@ -310,7 +310,7 @@ class GetJavaMavenTreeDependencies(capycli.common.dependencies_base.Dependencies
             LOG = capycli.get_logger(__name__)
 
         print_text(
-            "\n" + capycli.APP_NAME + ", " + capycli.get_app_version() +
+            "\n" + capycli.get_app_signature() +
             " - Determine Java components/dependencies\n")
 
         if args.help:

{capycli-2.8.1 → capycli-2.9.0.dev1}/capycli/dependencies/maven_pom.py

@@ -117,7 +117,7 @@ class GetJavaMavenPomDependencies(capycli.common.script_base.ScriptBase):
             LOG = capycli.get_logger(__name__)
 
         print_text(
-            "\n" + capycli.APP_NAME + ", " + capycli.get_app_version() +
+            "\n" + capycli.get_app_signature() +
             " - Determine Java components/dependencies\n")
 
         if args.help: