This library called thoth-report-processing <https://pypi.org/project/thoth-report-processing>
is used in project Thoth <https://thoth-station.ninja>
to process all outputs provided by Thoth Components
and stored using thoth-storages library <https://github.com/thoth-station/storages>
__.
The library can be installed via pip or Pipenv from PyPI <https://pypi.org/project/thoth-report-processing>
__:
.. code-block:: console
pipenv install thoth-report-processing
The library does not provide any CLI, it is rather a low level library supporting other parts of Thoth.
The reports to be processed can be retrieved in two ways:
locally
, providing a path.Using Ceph S3
providing the following environment variables:
.. code-block:: console
THOTH_CEPH_KEY_ID=
see currently available adapters from thoth-storages here <https://github.com/thoth-station/report-processing/blob/master/thoth/report_processing/enums.py>
__.
Aggregating Security Indicators using local path:
.. code-block:: python
from thoth.report_processing.components.security import SecurityIndicatorsBandit, SecurityIndicatorsCloc from thoth.report_processing.components.security import SecurityIndicatorsAggregator
_SI_BANDIT_FOLDER_PATH =<> _SI_CLOC_FOLDER_PATH =<>
security_aggregator = SecurityIndicatorsAggregator()
si_bandit_report = SecurityIndicatorsBandit.aggregate_security_indicator_bandit_results( security_indicator_bandit_repo_path=_SI_BANDIT_FOLDER_PATH, is_local=True )[0]
si_cloc_report = SecurityIndicatorsCloc.aggregate_security_indicator_cloc_results( security_indicator_cloc_repo_path=_SI_CLOC_FOLDER_PATH, is_local=True )[0]
aggregated_json = security_aggregator.create_si_aggregated_json( si_bandit_report=si_bandit_report, si_cloc_report=si_cloc_report )