hoppr-cyclonedx-models 0.7.0__tar.gz

hoppr_cyclonedx_models-0.7.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Lockheed Martin Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

hoppr_cyclonedx_models-0.7.0/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.4
+Name: hoppr-cyclonedx-models
+Version: 0.7.0
+Summary: CycloneDX Pydantic models for easy use in your Python project.
+License: MIT
+License-File: LICENSE
+Keywords: pydantic,models,cyclonedx,software bill of materials
+Author: LMCO Open Source
+Author-email: open.source@lmco.com
+Requires-Python: >=3.8.0,<4.0.0
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Framework :: Pydantic
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Typing :: Typed
+Requires-Dist: pydantic[email] (>=1.10.2,<2.0.0)
+Requires-Dist: typing-extensions (>=4.7.1,<5.0.0)
+Project-URL: Repository, https://gitlab.com/hoppr/hoppr-cyclonedx-models
+Description-Content-Type: text/markdown
+
+# Hoppr CycloneDX Models
+
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/hoppr-cyclonedx-models?logo=python&style=plastic)
+[![PyPI - Version](https://img.shields.io/pypi/v/hoppr-cyclonedx-models?style=plastic)](https://pypi.org/project/hoppr-cyclonedx-models)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/hoppr-cyclonedx-models?style=plastic)](https://pypi.org/project/hoppr-cyclonedx-models)
+[![PyPI - License](https://img.shields.io/pypi/l/hoppr-cyclonedx-models?style=plastic)](LICENSE)
+[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json&style=plastic)](https://python-poetry.org/)
+
+Serializable CycloneDX Models. Quickly get up and running with models generated directly off the specification.
+
+Current generated models can be found [here](hoppr_cyclonedx_models).
+
+## Installation
+
+Install using `pip install --upgrade hoppr-cyclonedx-models` or `poetry add hoppr-cyclonedx-models`.
+
+## A Simple Example
+
+```python
+>>> from hoppr_cyclonedx_models.cyclonedx_1_5 import Component
+>>> data = {"type": "library", "purl": "pkg:pypi/django@1.11.1", "name": "django", "version": "1.11.1"}
+>>> component = Component(**data)
+>>> component
+>>> print(component)
+Component(
+    type='library',
+    mime_type=None,
+    bom_ref=None,
+    supplier=None,
+    author=None,
+    publisher=None,
+    group=None,
+    name='django',
+    version='1.11.1',
+    description=None,
+    scope=<Scope.REQUIRED: 'required'>,
+    hashes=None,
+    licenses=None,
+    copyright=None,
+    cpe=None,
+    purl='pkg:pypi/django@1.11.1',
+    swid=None,
+    modified=None,
+    pedigree=None,
+    externalReferences=None,
+    components=None,
+    evidence=None,
+    releaseNotes=None,
+    modelCard=None,
+    data=None,
+    properties=None,
+    signature=None
+)
+```
+
+## Contributing
+
+For guidance setting up a development environment and how to contribute to `hoppr-cyclonedx-models`,
+see [Contributing to Hoppr](https://hoppr.dev/docs/development/contributing).
+

hoppr_cyclonedx_models-0.7.0/README.md

@@ -0,0 +1,59 @@
+# Hoppr CycloneDX Models
+
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/hoppr-cyclonedx-models?logo=python&style=plastic)
+[![PyPI - Version](https://img.shields.io/pypi/v/hoppr-cyclonedx-models?style=plastic)](https://pypi.org/project/hoppr-cyclonedx-models)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/hoppr-cyclonedx-models?style=plastic)](https://pypi.org/project/hoppr-cyclonedx-models)
+[![PyPI - License](https://img.shields.io/pypi/l/hoppr-cyclonedx-models?style=plastic)](LICENSE)
+[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json&style=plastic)](https://python-poetry.org/)
+
+Serializable CycloneDX Models. Quickly get up and running with models generated directly off the specification.
+
+Current generated models can be found [here](hoppr_cyclonedx_models).
+
+## Installation
+
+Install using `pip install --upgrade hoppr-cyclonedx-models` or `poetry add hoppr-cyclonedx-models`.
+
+## A Simple Example
+
+```python
+>>> from hoppr_cyclonedx_models.cyclonedx_1_5 import Component
+>>> data = {"type": "library", "purl": "pkg:pypi/django@1.11.1", "name": "django", "version": "1.11.1"}
+>>> component = Component(**data)
+>>> component
+>>> print(component)
+Component(
+    type='library',
+    mime_type=None,
+    bom_ref=None,
+    supplier=None,
+    author=None,
+    publisher=None,
+    group=None,
+    name='django',
+    version='1.11.1',
+    description=None,
+    scope=<Scope.REQUIRED: 'required'>,
+    hashes=None,
+    licenses=None,
+    copyright=None,
+    cpe=None,
+    purl='pkg:pypi/django@1.11.1',
+    swid=None,
+    modified=None,
+    pedigree=None,
+    externalReferences=None,
+    components=None,
+    evidence=None,
+    releaseNotes=None,
+    modelCard=None,
+    data=None,
+    properties=None,
+    signature=None
+)
+```
+
+## Contributing
+
+For guidance setting up a development environment and how to contribute to `hoppr-cyclonedx-models`,
+see [Contributing to Hoppr](https://hoppr.dev/docs/development/contributing).

hoppr_cyclonedx_models-0.7.0/hoppr_cyclonedx_models/__init__.py

@@ -0,0 +1,84 @@
+"""
+Hoppr package to generate Pydantic models for CycloneDX schema
+
+--------------------------------------------------------------------------------
+SPDX-FileCopyrightText: Copyright © 2023 Lockheed Martin <open.source@lmco.com>
+SPDX-FileName: hoppr_cyclonedx_models/__init__.py
+SPDX-FileType: SOURCE
+SPDX-License-Identifier: MIT
+--------------------------------------------------------------------------------
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+--------------------------------------------------------------------------------
+"""
+from __future__ import annotations
+
+from typing import Any
+
+from pydantic import Extra, Field, root_validator
+from typing_extensions import Annotated, Literal
+
+from hoppr_cyclonedx_models.base import CycloneDXBaseModel
+from hoppr_cyclonedx_models.cyclonedx_1_3 import CyclonedxSoftwareBillOfMaterialSpecification as Sbom_1_3
+from hoppr_cyclonedx_models.cyclonedx_1_4 import CyclonedxSoftwareBillOfMaterialsStandard as Sbom_1_4
+from hoppr_cyclonedx_models.cyclonedx_1_5 import CyclonedxSoftwareBillOfMaterialsStandard as Sbom_1_5
+
+
+class Sbom(Sbom_1_5, Sbom_1_4, Sbom_1_3):  # pylint: disable=too-few-public-methods
+    """
+    Convenience class to parse SBOM as latest spec version
+    """
+
+    class Config(CycloneDXBaseModel.Config):
+        """
+        Config options for Sbom
+        """
+
+        extra = Extra.forbid
+
+    field_schema: Annotated[
+        Literal[
+            "http://cyclonedx.org/schema/bom-1.3.schema.json",
+            "http://cyclonedx.org/schema/bom-1.4.schema.json",
+            "http://cyclonedx.org/schema/bom-1.5.schema.json",
+        ],
+        Field(alias="$schema"),
+    ] = "http://cyclonedx.org/schema/bom-1.5.schema.json"
+
+    specVersion: Annotated[
+        Literal["1.3", "1.4", "1.5"],
+        Field(
+            description="The version of the CycloneDX specification a BOM conforms to (starting at version 1.2).",
+            examples=["1.3", "1.4", "1.5"],
+            title="CycloneDX Specification Version",
+        ),
+    ] = "1.5"
+
+    @root_validator(allow_reuse=True, pre=True)
+    @classmethod
+    def validate_sbom(cls, sbom: dict[str, Any]) -> dict[str, Any]:
+        """
+        Parse SBOM as latest CycloneDX spec release
+        """
+        sbom["$schema"] = "http://cyclonedx.org/schema/bom-1.5.schema.json"
+        sbom["specVersion"] = "1.5"
+
+        return Sbom_1_5(**sbom).dict(exclude_none=True, exclude_unset=True)
+
+
+__version__ = "0.7.0"

hoppr_cyclonedx_models-0.7.0/hoppr_cyclonedx_models/base.py

@@ -0,0 +1,111 @@
+"""
+Override Pydantic's BaseModel class to ensure hashable model objects
+
+--------------------------------------------------------------------------------
+SPDX-FileCopyrightText: Copyright © 2023 Lockheed Martin <open.source@lmco.com>
+SPDX-FileName: hoppr_cyclonedx_models/base.py
+SPDX-FileType: SOURCE
+SPDX-License-Identifier: MIT
+--------------------------------------------------------------------------------
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+--------------------------------------------------------------------------------
+"""
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any, Callable
+
+from pydantic import BaseConfig, BaseModel, Extra
+
+if TYPE_CHECKING:
+    from pydantic.typing import AbstractSetIntStr, DictStrAny, MappingIntStrAny
+
+
+class CycloneDXBaseModel(BaseModel):
+    """
+    Hoppr CycloneDX base data model
+    """
+
+    class Config(BaseConfig):
+        """
+        Config options for CycloneDXBaseModel
+        """
+
+        allow_population_by_field_name = True
+        arbitrary_types_allowed = True
+        extra = Extra.allow
+        use_enum_values = True
+
+    def __eq__(self, other: object) -> bool:
+        return hash(self) == hash(other)
+
+    def __hash__(self) -> int:
+        """
+        Define to test equality or uniqueness between objects
+        """
+        return hash(repr(self))
+
+    # Override to export by alias by default
+    def dict(
+        self,
+        *,
+        include: AbstractSetIntStr | MappingIntStrAny | None = None,
+        exclude: AbstractSetIntStr | MappingIntStrAny | None = None,
+        by_alias: bool = True,
+        skip_defaults: bool | None = None,
+        exclude_unset: bool = False,
+        exclude_defaults: bool = False,
+        exclude_none: bool = False,
+    ) -> DictStrAny:
+        return super().dict(
+            include=include,
+            exclude=exclude,
+            by_alias=by_alias,
+            skip_defaults=skip_defaults,
+            exclude_unset=exclude_unset,
+            exclude_defaults=exclude_defaults,
+            exclude_none=exclude_none,
+        )
+
+    # Override to export by alias and exclude fields that are None or unset by default
+    def json(
+        self,
+        *,
+        include: AbstractSetIntStr | MappingIntStrAny | None = None,
+        exclude: AbstractSetIntStr | MappingIntStrAny | None = None,
+        by_alias: bool = True,
+        skip_defaults: bool | None = None,
+        exclude_unset: bool = True,
+        exclude_defaults: bool = False,
+        exclude_none: bool = True,
+        encoder: Callable[[Any], Any] | None = None,
+        models_as_dict: bool = True,
+        **dumps_kwargs: Any,
+    ) -> str:
+        return super().json(
+            include=include,
+            exclude=exclude,
+            by_alias=by_alias,
+            skip_defaults=skip_defaults,
+            exclude_unset=exclude_unset,
+            exclude_defaults=exclude_defaults,
+            exclude_none=exclude_none,
+            encoder=encoder,
+            models_as_dict=models_as_dict,
+            **dumps_kwargs,
+        )