cyclonedx.model.tool

Classes

`Tool`	This is our internal representation of the toolType complex type within the CycloneDX standard.
`ToolRepository`	The repository of tool formats

Module Contents

class cyclonedx.model.tool.Tool

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

vendor: str | None

name: str | None

version: str | None

hashes: SortedSet[HashType]

external_references: SortedSet[ExternalReference]

classmethod from_component(component: cyclonedx.model.component.Component) → Tool

classmethod from_service(service: cyclonedx.model.service.Service) → Tool

class cyclonedx.model.tool.ToolRepository(*, components: collections.abc.Iterable[cyclonedx.model.component.Component] | None = None, services: collections.abc.Iterable[cyclonedx.model.service.Service] | None = None, tools: collections.abc.Iterable[Tool] | None = None)

The repository of tool formats

property components: SortedSet[Component]

Returns:: A SortedSet of Components

property services: SortedSet[Service]

Returns:: A SortedSet of Services

property tools: SortedSet[Tool]

all_as_tools() → SortedSet[Tool]: Get all tools, components, and services as Tool objects.