Name Description Size Coverage
__init__.py Uniform set of models to represent objects within a CycloneDX software bill-of-materials. You can either create a `cyclonedx.model.bom.Bom` yourself programmatically, or generate a `cyclonedx.model.bom.Bom` from a `cyclonedx.parser.BaseParser` implementation. 40816 -
bom.py Enum object that defines the Traffic Light Protocol (TLP) classification that controls the sharing and distribution of the data that the BOM describes. .. note:: Introduced in CycloneDX v1.7 .. note:: See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.7/xml/#type_tlpClassificationType 32130 -
bom_ref.py An identifier that can be used to reference objects elsewhere in the BOM. This copies a similar pattern used in the CycloneDX PHP Library. .. note:: See https://github.com/CycloneDX/cyclonedx-php-library/blob/master/docs/dev/decisions/BomDependencyDataModel.md 3245 -
component.py Our internal representation of the `commitType` complex type. .. note:: See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.7/xml/#type_commitType 56893 -
component_evidence.py Enum object that defines the permissible field types for Identity. .. note:: See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.7/json/#components_items_evidence_identity 26493 -
contact.py This is our internal representation of the `postalAddressType` complex type that can be used in multiple places within a CycloneDX BOM document. .. note:: See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.7/xml/#type_postalAddressType 13355 -
crypto.py This set of classes represents cryptoPropertiesType Complex Type in the CycloneDX standard. .. note:: Introduced in CycloneDX v1.6 .. note:: See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.7/xml/#type_cryptoPropertiesType 56403 -
definition.py Helper class that allows us to perform validation on data strings that must conform to Common Requirements Enumeration (CRE) identifier(s). 20927 -
dependency.py THIS CLASS IS NON-PUBLIC API 3831 -
impact_analysis.py This set of classes represents the data about Impact Analysis. Impact Analysis is new for CycloneDX schema version 1. .. note:: See the CycloneDX Schema extension definition https://cyclonedx.org/docs/1.6 3607 -
issue.py This is our internal representation of the enum `issueClassification`. .. note:: See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.7/xml/#type_issueClassification 7473 -
license.py License related things 25646 -
lifecycle.py This set of classes represents the lifecycles types in the CycloneDX standard. .. note:: Introduced in CycloneDX v1.5 .. note:: See the CycloneDX Schema for lifecycles: https://cyclonedx.org/docs/1.7/xml/#metadata_lifecycles 8451 -
release_note.py This is our internal representation of a `releaseNotesType` for a Component in a BOM. .. note:: See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.7/xml/#type_releaseNotesType 9386 -
service.py This set of classes represents the data that is possible about known Services. .. note:: See the CycloneDX Schema extension definition https://cyclonedx.org/docs/1.7/xml/#type_servicesType 13214 -
tool.py This is our internal representation of the `toolType` complex type within the CycloneDX standard. Tool(s) are the things used in the creation of the CycloneDX document. Tool might be deprecated since CycloneDX 1.5, but it is not deprecated in this library. In fact, this library will try to provide a compatibility layer if needed. .. note:: See the CycloneDX Schema for toolType: https://cyclonedx.org/docs/1.7/xml/#type_toolType 13503 -
vulnerability.py This set of classes represents the data that is possible about known Vulnerabilities. Prior to CycloneDX schema version 1.4, vulnerabilities were possible in XML versions ONLY of the standard through a schema extension: https://cyclonedx.org/ext/vulnerability. Since CycloneDX schema version 1.4, this has become part of the core schema. .. note:: See the CycloneDX Schema extension definition https://cyclonedx.org/docs/1.7/xml/#type_vulnerabilitiesType 46667 -