cyclonedx.contrib.component.builders
====================================

.. py:module:: cyclonedx.contrib.component.builders

.. autoapi-nested-parse::

   Component related builders



Classes
-------

.. autoapisummary::

   cyclonedx.contrib.component.builders.ComponentBuilder


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

.. py:class:: ComponentBuilder

   .. py:method:: make_for_file(absolute_file_path: str, *, name: Optional[str]) -> cyclonedx.model.component.Component

      Helper method to create a :class:`cyclonedx.model.component.Component`
      that represents the provided local file as a Component.

      Args:
          absolute_file_path:
              Absolute path to the file you wish to represent
          name:
              Optionally, if supplied this is the name that will be used for the component.
              Defaults to arg ``absolute_file_path``.

      Returns:
          `Component` representing the supplied file