Merge remote-tracking branch 'origin/9.0.0-dev' into feat/BomRef-affects-comparissons-equality

Author: jkowalleck

.flake8

@@ -41,3 +41,6 @@ copyright-text =
     '#'
     '# SPDX-License-Identifier: Apache-2.0'
     '# Copyright (c) OWASP Foundation. All Rights Reserved.'
+lines-to-exclude =
+    ## shebang
+    '#!'

CHANGELOG.md

@@ -2,6 +2,75 @@
 
 
 
+## v8.7.0 (2025-02-06)
+
+### Feature
+
+* feat: allow empty `OrganizationalContact` object (#772)
+
+fixes https://github.com/CycloneDX/cyclonedx-python-lib/issues/771
+
+---------
+
+Signed-off-by: Johannes Feichtner <[email protected]>
+Signed-off-by: Johannes Feichtner <[email protected]> ([`03b35f4`](https://github.com/CycloneDX/cyclonedx-python-lib/commit/03b35f4293ab3b4c402c7bb8ff458831e492cb8b))
+
+
+## v8.6.0 (2025-02-04)
+
+### Feature
+
+* feat: expand the capabilities of `models.definition.Standard` (#713)
+
+
+---------
+
+Signed-off-by: Hakan Dilek <[email protected]>
+Signed-off-by: Jan Kowalleck <[email protected]>
+Co-authored-by: Jan Kowalleck <[email protected]> ([`901dcdc`](https://github.com/CycloneDX/cyclonedx-python-lib/commit/901dcdc60a8a46d30878764d7b8bda69c6ba8b80))
+
+* feat: allow empty `OrganizationalEntity` object (#768)
+
+fixes https://github.com/CycloneDX/cyclonedx-python-lib/issues/764
+
+Signed-off-by: Johannes Feichtner <[email protected]> ([`472bded`](https://github.com/CycloneDX/cyclonedx-python-lib/commit/472bded38cd480ba6885d44c798e015b63c89190))
+
+
+## v8.5.1 (2025-01-28)
+
+### Documentation
+
+* docs: responsibilities & capabilities (#763)
+
+
+
+Signed-off-by: Jan Kowalleck <[email protected]> ([`ab4ae45`](https://github.com/CycloneDX/cyclonedx-python-lib/commit/ab4ae4578555f010914d7e904133dd478d7c80c1))
+
+* docs: Fix typos in in conda-forge.md and remove unused reference in README (#762)
+
+- Fix few typos in conda-forge.md
+- Removed unused PEP-508 ref in README.md
+
+Signed-off-by: Arthit Suriyawongkul <[email protected]> ([`66ece7a`](https://github.com/CycloneDX/cyclonedx-python-lib/commit/66ece7ae0042740a541ceed3048b89c4f2b24145))
+
+* docs: modernize docstrings for CDX1.6 (#759)
+
+Signed-off-by: Jan Kowalleck <[email protected]> ([`fb9a42e`](https://github.com/CycloneDX/cyclonedx-python-lib/commit/fb9a42ef9bda6407ddf4c49e75d10aa0fc91e46d))
+
+### Feature
+
+* feat: couple classes and their serializes (#757)
+
+Deprecates `.serialization.BomRefHelper` and
+`.serialization.LicenseRepositoryHelper`
+
+fixes #756
+
+---------
+
+Signed-off-by: Jan Kowalleck <[email protected]> ([`6003feb`](https://github.com/CycloneDX/cyclonedx-python-lib/commit/6003febaa032969732ee246deb739d1e13bae581))
+
+
 ## v8.5.0 (2024-11-18)
 
 ### Documentation

README.md

@@ -17,20 +17,22 @@
 OWASP [CycloneDX][link_website] is a full-stack Bill of Materials (BOM) standard
 that provides advanced supply chain capabilities for cyber risk reduction.
 
-This Python package provides data models, validators and more, 
+This Python package provides data models, validators and more,
 to help you create/render/read CycloneDX documents.
 
-**This package is not designed for standalone use. It is a software library.**
-
-As of version `3.0.0`, the internal data model was adjusted to allow CycloneDX VEX documents to be produced as per
-[official examples](https://cyclonedx.org/capabilities/bomlink/#linking-external-vex-to-bom-inventory) linking VEX to a separate CycloneDX document.
-
-If you're looking for a CycloneDX tool to run to generate (SBOM) software bill-of-materials documents, why not checkout 
-[CycloneDX Python][cyclonedx-python] or [Jake][jake].
+> [!NOTE]
+> This package is a software library not intended for standalone use. 
+> For generating Software Bill of Materials (SBOM), check out [CycloneDX Python][cyclonedx-python] or [Jake][jake].
 
 ## Documentation
 
-View the documentation [here](https://cyclonedx-python-library.readthedocs.io/).
+Complete documentation is available on [Read the Docs][link_rtfd]. This includes:
+- Responsibilities & Capabilities
+- Install Instructions
+- API Reference
+- Usage Examples
+- Integration Guides
+- Best Practices
 
 ## Python Support
 
@@ -81,5 +83,3 @@ See the [LICENSE][license_file] file for the full license.
 [link_slack]: https://cyclonedx.org/slack/invite
 [link_discussion]: https://groups.io/g/CycloneDX
 [link_twitter]: https://twitter.com/CycloneDX_Spec
-
-[PEP-508]: https://www.python.org/dev/peps/pep-0508/

cyclonedx/__init__.py

@@ -22,4 +22,4 @@
 
 # !! version is managed by semantic_release
 # do not use typing here, or else `semantic_release` might have issues finding the variable
-__version__ = "8.5.0"  # noqa:Q000
+__version__ = "8.7.0"  # noqa:Q000

cyclonedx/_internal/compare.py

@@ -58,40 +58,25 @@ def __gt__(self, other: Any) -> bool:
         return False
 
 
-class ComparableDict:
+class ComparableDict(ComparableTuple):
     """
     Allows comparison of dictionaries, allowing for missing/None values.
     """
 
-    def __init__(self, dict_: Dict[Any, Any]) -> None:
-        self._dict = dict_
-
-    def __lt__(self, other: Any) -> bool:
-        if not isinstance(other, ComparableDict):
-            return True
-        keys = sorted(self._dict.keys() | other._dict.keys())
-        return ComparableTuple(self._dict.get(k) for k in keys) \
-            < ComparableTuple(other._dict.get(k) for k in keys)
-
-    def __gt__(self, other: Any) -> bool:
-        if not isinstance(other, ComparableDict):
-            return False
-        keys = sorted(self._dict.keys() | other._dict.keys())
-        return ComparableTuple(self._dict.get(k) for k in keys) \
-            > ComparableTuple(other._dict.get(k) for k in keys)
+    def __new__(cls, d: Dict[Any, Any]) -> 'ComparableDict':
+        return super(ComparableDict, cls).__new__(cls, sorted(d.items()))
 
 
 class ComparablePackageURL(ComparableTuple):
     """
     Allows comparison of PackageURL, allowing for qualifiers.
     """
 
-    def __new__(cls, purl: 'PackageURL') -> 'ComparablePackageURL':
-        return super().__new__(
-            ComparablePackageURL, (
-                purl.type,
-                purl.namespace,
-                purl.version,
-                ComparableDict(purl.qualifiers) if isinstance(purl.qualifiers, dict) else purl.qualifiers,
-                purl.subpath
-            ))
+    def __new__(cls, p: 'PackageURL') -> 'ComparablePackageURL':
+        return super(ComparablePackageURL, cls).__new__(cls, (
+            p.type,
+            p.namespace,
+            p.version,
+            ComparableDict(p.qualifiers) if isinstance(p.qualifiers, dict) else p.qualifiers,
+            p.subpath
+        ))

cyclonedx/exception/model.py

@@ -123,3 +123,11 @@ class LicenseExpressionAlongWithOthersException(CycloneDxModelException):
     See https://github.com/CycloneDX/specification/pull/205
     """
     pass
+
+
+class InvalidCreIdException(CycloneDxModelException):
+    """
+    Raised when a supplied value for an CRE ID does not meet the format requirements
+    as defined at https://opencre.org/
+    """
+    pass