jake.command.oss
================

.. py:module:: jake.command.oss


Attributes
----------

.. autoapisummary::

   jake.command.oss._SONATYPE_GUIDE_SOURCE


Classes
-------

.. autoapisummary::

   jake.command.oss.OssCommand
   jake.command.oss.DdtCommand


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

.. py:data:: _SONATYPE_GUIDE_SOURCE
   :value: 'Sonatype Guide'


.. py:class:: OssCommand

   Bases: :py:obj:`jake.command.BaseCommand`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:attribute:: _console
      :type:  rich.console.Console


   .. py:method:: handle_args() -> int


   .. py:method:: _perform_scan() -> tuple[List[cyclonedx.model.component.Component], List[cyclonedx.model.vulnerability.Vulnerability], List[sonatype_guide_api_client.ComponentReportPost]]


   .. py:method:: _apply_whitelist(guide_results: List[sonatype_guide_api_client.ComponentReportPost]) -> None


   .. py:method:: _process_components(parser: jake._internal.parsers.BaseJakeParser, guide_results: List[sonatype_guide_api_client.ComponentReportPost], progress: rich.progress.Progress, task: rich.progress.TaskID) -> tuple[List[cyclonedx.model.component.Component], List[cyclonedx.model.vulnerability.Vulnerability]]


   .. py:method:: _build_ratings(vuln: sonatype_guide_api_client.OssiVulnerabilityPost) -> List[cyclonedx.model.vulnerability.VulnerabilityRating]
      :staticmethod:



   .. py:method:: _build_vulnerability(component: cyclonedx.model.component.Component, vuln: sonatype_guide_api_client.OssiVulnerabilityPost) -> cyclonedx.model.vulnerability.Vulnerability
      :staticmethod:



   .. py:method:: get_argument_parser_name() -> str


   .. py:method:: get_argument_parser_help() -> str


   .. py:method:: setup_argument_parser(arg_parser: argparse.ArgumentParser) -> None


   .. py:method:: _build_bom(components: Iterable[cyclonedx.model.component.Component], vulnerabilities: Iterable[cyclonedx.model.vulnerability.Vulnerability]) -> cyclonedx.model.bom.Bom
      :staticmethod:



   .. py:method:: _print_oss_index_report(components: List[cyclonedx.model.component.Component], vulnerabilities: List[cyclonedx.model.vulnerability.Vulnerability]) -> None


   .. py:method:: _get_max_cvss_score_for_vulnerability(vulnerability: cyclonedx.model.vulnerability.Vulnerability) -> float
      :staticmethod:



   .. py:method:: _get_max_cvss_score(component: cyclonedx.model.component.Component, vulnerabilities: List[cyclonedx.model.vulnerability.Vulnerability]) -> float
      :staticmethod:



   .. py:method:: _print_vulnerability(tree: rich.tree.Tree, v: cyclonedx.model.vulnerability.Vulnerability) -> None
      :staticmethod:



   .. py:method:: _get_color_for_cvss_score(cvss_score: float = 0.0) -> str
      :staticmethod:



   .. py:method:: _get_severity_for_cvss_score(cvss_score: float) -> str
      :staticmethod:



.. py:class:: DdtCommand

   Bases: :py:obj:`OssCommand`


   Deprecated alias for OssCommand that registers as the 'ddt' subcommand.


   .. py:method:: get_argument_parser_name() -> str


   .. py:method:: get_argument_parser_help() -> str