cyclonedx.model.tool
====================

.. py:module:: cyclonedx.model.tool


Classes
-------

.. autoapisummary::

   cyclonedx.model.tool.Tool
   cyclonedx.model.tool.ToolRepository


Module Contents
---------------

.. py:class:: 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


   .. py:attribute:: vendor
      :type:  Optional[str]


   .. py:attribute:: name
      :type:  Optional[str]


   .. py:attribute:: version
      :type:  Optional[str]


   .. py:attribute:: hashes
      :type:  SortedSet[HashType]


   .. py:attribute:: external_references
      :type:  SortedSet[ExternalReference]


   .. py:method:: from_component(component: cyclonedx.model.component.Component) -> Tool
      :classmethod:



   .. py:method:: from_service(service: cyclonedx.model.service.Service) -> Tool
      :classmethod:



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

   The repository of tool formats


   .. py:property:: components
      :type: SortedSet[Component]


      Returns:
          A SortedSet of Components



   .. py:property:: services
      :type: SortedSet[Service]


      Returns:
          A SortedSet of Services



   .. py:property:: tools
      :type: SortedSet[Tool]



   .. py:method:: all_as_tools() -> SortedSet[Tool]

      Get all tools, components, and services as Tool objects.