chore: rename package and module name

leoreinmann · leoreinmann · commit 7a31d4babef2 · 2025-04-25T13:45:30.000+02:00
diff --git a/README.md b/README.md
@@ -19,15 +19,15 @@ The library provides Standard BOM parser and serializer classes. The parser clas
 ## Read a Standard BOM from a JSON file
 
 ```python
-from standardbom.parser import StandardBomParser
+from siemens_standard_bom.parser import StandardBomParser
 
 bom = StandardBomParser.parse("sbom.cdx.json")
 ```
 
 ## Write a Standard BOM to a JSON file
 
 ```python
-from standardbom.parser import StandardBomParser
+from siemens_standard_bom.parser import StandardBomParser
 
 bom = ...
 StandardBomParser.save(bom, "sbom.cdx.json")
@@ -36,7 +36,7 @@ StandardBomParser.save(bom, "sbom.cdx.json")
 If you'd like to skip the `.dependencies` field in the output file, you can use the following code:
 
 ```python
-from standardbom.parser import StandardBomParser
+from siemens_standard_bom.parser import StandardBomParser
 
 bom = ...
 StandardBomParser.save(bom, "sbom.cdx.json", with_dependencies=False)
@@ -52,7 +52,7 @@ The `StandardBom` class is a subclass of the `cyclonedx.bom.Bom` class from the
 model objects from the upstream library.
 
 ```python
-from standardbom.model import StandardBom, Component, ComponentType
+from siemens_standard_bom.model import StandardBom, Component, ComponentType
 from cyclonedx.model.contact import OrganizationalContact
 
 bom = StandardBom()
@@ -65,7 +65,7 @@ You can also use the Standard BOM wrapper classes to create and edit the Standar
 For example, you can do the following similar to the example abode:
 
 ```python
-from standardbom.model import StandardBom, Component, ComponentType, SbomComponent
+from siemens_standard_bom.model import StandardBom, Component, ComponentType, SbomComponent
 from cyclonedx.model.contact import OrganizationalContact
 
 bom = StandardBom()
@@ -81,7 +81,7 @@ fields. For example, the `tools` or `components` getters returns a list of `Sbom
 
 ```python
 from typing import Iterable
-from standardbom.model import SbomComponent
+from siemens_standard_bom.model import SbomComponent
 
 bom = ...
 components: Iterable[SbomComponent] = bom.components
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,5 +1,5 @@
 [project]
-name = "standard-bom"
+name = "siemens-standard-bom"
 version = "4.0.0"
 description = "Standard BOM Format Library"
 keywords = ["sbom", "software-bill-of-materials", "cyclonedx", "cdx"]
@@ -36,8 +36,8 @@ build-backend = "poetry.core.masonry.api"
 [tool.poetry]
 package-mode = true
 packages = [
-    { include = "standardbom" },
-    { include = "standardbom/py.typed" },
+    { include = "siemens_standard_bom" },
+    { include = "siemens_standard_bom/py.typed" },
 ]
 
 [tool.poetry.group.dev.dependencies]
diff --git a/siemens_standard_bom/__init__.py b/siemens_standard_bom/__init__.py
diff --git a/siemens_standard_bom/immutable.py b/siemens_standard_bom/immutable.py
diff --git a/siemens_standard_bom/model.py b/siemens_standard_bom/model.py
@@ -20,9 +20,9 @@
 from packageurl import PackageURL
 from sortedcontainers import SortedSet
 
-from standardbom.immutable import ImmutableList
+from siemens_standard_bom.immutable import ImmutableList
 
-STANDARD_BOM_MODULE: str = 'standard-bom'
+STANDARD_BOM_MODULE: str = 'siemens-standard-bom'
 
 PROPERTY_DIRECT_DEPENDENCY = "siemens:direct"
 PROPERTY_FILENAME = "siemens:filename"
diff --git a/siemens_standard_bom/parser.py b/siemens_standard_bom/parser.py
@@ -11,7 +11,7 @@
 from cyclonedx.model.bom import Bom
 from cyclonedx.output.json import JsonV1Dot6
 
-from standardbom.model import StandardBom
+from siemens_standard_bom.model import StandardBom
 
 
 class StandardBomParser:
diff --git a/siemens_standard_bom/py.typed b/siemens_standard_bom/py.typed
diff --git a/tests/abstract_sbom_compare.py b/tests/abstract_sbom_compare.py
@@ -13,8 +13,8 @@
 from dateutil import parser as dateparser
 from deepdiff import DeepDiff
 
-from standardbom.model import StandardBom
-from standardbom.parser import StandardBomParser
+from siemens_standard_bom.model import StandardBom
+from siemens_standard_bom.parser import StandardBomParser
 
 # excluding bom_ref values mainly from metadata.component.bom_ref
 exclude_regex_paths = [
diff --git a/tests/test_immutable_list.py b/tests/test_immutable_list.py
@@ -5,7 +5,7 @@
 
 from sortedcontainers import SortedSet
 
-from standardbom.immutable import ImmutableList
+from siemens_standard_bom.immutable import ImmutableList
 
 
 class ImmutableListTestCase(unittest.TestCase):
diff --git a/tests/test_model_sbom_component.py b/tests/test_model_sbom_component.py
@@ -9,7 +9,7 @@
 from cyclonedx.model.license import DisjunctiveLicense
 from packageurl import PackageURL
 
-from standardbom.model import ExternalComponent, SbomComponent
+from siemens_standard_bom.model import ExternalComponent, SbomComponent
 
 
 class SBomComponentTestCase(unittest.TestCase):
diff --git a/tests/test_model_sources.py b/tests/test_model_sources.py
@@ -5,7 +5,7 @@
 from cyclonedx.model import ExternalReference, ExternalReferenceType, HashAlgorithm, HashType, XsUri
 from cyclonedx.model.component import ComponentType, Component
 
-from standardbom.model import SbomComponent, SOURCE_ARCHIVE_LOCAL, SourceArtifact
+from siemens_standard_bom.model import SbomComponent, SOURCE_ARCHIVE_LOCAL, SourceArtifact
 
 
 class StandardBomSourcesTestCase(unittest.TestCase):
diff --git a/tests/test_model_standard_bom.py b/tests/test_model_standard_bom.py
@@ -9,7 +9,7 @@
 from cyclonedx.model.contact import OrganizationalContact
 from sortedcontainers import SortedSet
 
-from standardbom.model import StandardBom, SbomComponent, ExternalComponent, is_standardbom_component_entry
+from siemens_standard_bom.model import StandardBom, SbomComponent, ExternalComponent, is_standardbom_component_entry
 
 
 class StandardBomTestCase(unittest.TestCase):
@@ -63,8 +63,8 @@ def test_tools_entry(self) -> None:
 
         component = next(filter(lambda c: is_standardbom_component_entry(c.component), sbom.tools))
         assert component is not None
-        self.assertEqual('standard-bom', component.name)
-        self.assertEqual(version('standard-bom'), component.version)
+        self.assertEqual('siemens-standard-bom', component.name)
+        self.assertEqual(version('siemens-standard-bom'), component.version)
         self.assertEqual('https://sbom.siemens.io/', component.website)
         assert component.supplier is not None
         self.assertEqual('Siemens AG', component.supplier.name)
diff --git a/tests/test_profile.py b/tests/test_profile.py
@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: MIT
 import unittest
 
-from standardbom.model import StandardBom
+from siemens_standard_bom.model import StandardBom
 
 
 class ProfilesTestCase(unittest.TestCase):
diff --git a/tests/test_v2_parser.py b/tests/test_v2_parser.py
@@ -7,8 +7,8 @@
 
 from packageurl import PackageURL
 
-from standardbom.model import SbomNature
-from standardbom.parser import StandardBomParser
+from siemens_standard_bom.model import SbomNature
+from siemens_standard_bom.parser import StandardBomParser
 from tests.abstract_sbom_compare import AbstractSbomComparingTestCase, read_timestamp
 
 
diff --git a/tests/test_v3_parser.py b/tests/test_v3_parser.py
@@ -8,8 +8,8 @@
 from cyclonedx.model.contact import OrganizationalContact
 from packageurl import PackageURL
 
-from standardbom.model import SbomNature
-from standardbom.parser import StandardBomParser
+from siemens_standard_bom.model import SbomNature
+from siemens_standard_bom.parser import StandardBomParser
 from tests.abstract_sbom_compare import AbstractSbomComparingTestCase, read_timestamp
 
 
diff --git a/tests/test_v3_parser_write.py b/tests/test_v3_parser_write.py
@@ -8,8 +8,8 @@
 from cyclonedx.model.component import Component, ComponentType
 from cyclonedx.model.license import LicenseExpression
 
-from standardbom.model import StandardBom, SbomComponent
-from standardbom.parser import StandardBomParser
+from siemens_standard_bom.model import StandardBom, SbomComponent
+from siemens_standard_bom.parser import StandardBomParser
 from tests.abstract_sbom_compare import AbstractSbomComparingTestCase
 
 
diff --git a/tests/v2/full-valid.cdx.json b/tests/v2/full-valid.cdx.json
@@ -7,7 +7,7 @@
         "tools": [
             {
                 "vendor": "Siemens AG",
-                "name": "standard-bom",
+                "name": "siemens-standard-bom",
                 "version": "${formatVersion}",
                 "externalReferences": [
                     {
diff --git a/tests/v2/metadata-extensive.cdx.json b/tests/v2/metadata-extensive.cdx.json
@@ -8,7 +8,7 @@
     "tools": [
       {
         "vendor": "Siemens AG",
-        "name": "standard-bom",
+        "name": "siemens-standard-bom",
         "version": "2.0.0",
         "externalReferences": [
           {
diff --git a/tests/v2/metadata-external.cdx.json b/tests/v2/metadata-external.cdx.json
@@ -13,7 +13,7 @@
             "url": "https://sbom.siemens.io/"
           }
         ],
-        "name": "standard-bom",
+        "name": "siemens-standard-bom",
         "vendor": "Siemens AG",
         "version": "2.4.0"
       }
diff --git a/tests/v2/multiple-dependencies.cdx.json b/tests/v2/multiple-dependencies.cdx.json
@@ -7,7 +7,7 @@
     "timestamp": "2022-12-21T13:01:46Z",
       "tools": [
         {
-          "name": "standard-bom",
+          "name": "siemens-standard-bom",
           "vendor": "Siemens AG",
           "version": "2.4.0"
         }
diff --git a/tests/v2/serial-number.cdx.json b/tests/v2/serial-number.cdx.json
@@ -14,7 +14,7 @@
               "url": "https://sbom.siemens.io/"
             }
           ],
-          "name": "standard-bom",
+          "name": "siemens-standard-bom",
           "vendor": "Siemens AG",
           "version": "2.4.0"
         }
diff --git a/tests/v3/full-valid.cdx.json b/tests/v3/full-valid.cdx.json
@@ -10,7 +10,7 @@
                     "supplier": {
                         "name": "Siemens AG"
                     },
-                    "name": "standard-bom",
+                    "name": "siemens-standard-bom",
                     "version": "3.0.0",
                     "description": "Standard BOM helper library for Python",
                     "externalReferences": [
diff --git a/tests/v3/metadata-extensive.cdx.json b/tests/v3/metadata-extensive.cdx.json
@@ -11,7 +11,7 @@
                     "supplier": {
                         "name": "Siemens AG"
                     },
-                    "name": "standard-bom",
+                    "name": "siemens-standard-bom",
                     "version": "3.0.0",
                     "description": "Standard BOM helper library for Python",
                     "externalReferences": [
diff --git a/tests/v3/metadata-external.cdx.json b/tests/v3/metadata-external.cdx.json
@@ -10,7 +10,7 @@
                     "supplier": {
                         "name": "Siemens AG"
                     },
-                    "name": "standard-bom",
+                    "name": "siemens-standard-bom",
                     "version": "3.0.0",
                     "description": "Standard BOM helper library for Python",
                     "externalReferences": [
diff --git a/tests/v3/multiple-dependencies.cdx.json b/tests/v3/multiple-dependencies.cdx.json
@@ -71,7 +71,7 @@
                         "url": "https://sbom.siemens.io/"
                     }
                 ],
-                "bom-ref": "standard-bom"
+                "bom-ref": "siemens-standard-bom"
             }
         ]
     }
diff --git a/tests/v3/serial-number.cdx.json b/tests/v3/serial-number.cdx.json
@@ -11,7 +11,7 @@
                     "supplier": {
                         "name": "Siemens AG"
                     },
-                    "name": "standard-bom",
+                    "name": "siemens-standard-bom",
                     "version": "3.0.0",
                     "description": "Standard BOM helper library for Python",
                     "externalReferences": [
diff --git a/tests/v3/single-dependency.cdx.json b/tests/v3/single-dependency.cdx.json
@@ -34,7 +34,7 @@
                         "url": "https://sbom.siemens.io/"
                     }
                 ],
-                "bom-ref": "standard-bom"
+                "bom-ref": "siemens-standard-bom"
             }
         ]
     }
diff --git a/tox.toml b/tox.toml
@@ -20,7 +20,7 @@ deps = [
     "flake8>=7",
 ]
 commands = [
-    ["flake8", "standardbom", "tests"], { replace = "posargs", extend = true} ,
+    ["flake8", "siemens_standard_bom", "tests"], { replace = "posargs", extend = true} ,
 ]
 
 [env.type]
@@ -32,5 +32,5 @@ deps = [
     "deepdiff>=8",
 ]
 commands = [
-    ["mypy", "-p", "standardbom", "-p", "tests", { replace = "posargs", extend = true} ],
+    ["mypy", "-p", "siemens_standard_bom", "-p", "tests", { replace = "posargs", extend = true} ],
 ]
