hoppr-cyclonedx-models 0.6.0

CycloneDX Pydantic models for easy use in your Python project.

Hoppr CycloneDX Models

Serializable CycloneDX Models. Quickly get up and running with models generated directly off the specification.

Current generated models can be found here.

Installation

Install using pip install --upgrade hoppr-cyclonedx-models or poetry add hoppr-cyclonedx-models.

A Simple Example

>>> 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.