mythx_cli.render package¶

mythx_cli.render.command¶

mythx_cli.render.command.render(*args, **kwargs)¶

Render an analysis job or group report as HTML.

Parameters:

ctx – Click context holding group-level parameters
target – Group or analysis ID to fetch the data for
user_template – User-defined template string
aesthetic – DO NOT TOUCH IF YOU’RE BORING
markdown – Flag to render a markdown report
min_severity – Ignore SWC IDs below the designated level
swc_blacklist – A comma-separated list of SWC IDs to ignore
swc_whitelist – A comma-separated list of SWC IDs to include

mythx_cli.render.util¶

mythx_cli.render.util.get_analysis_info(client, uuid: str, min_severity: Optional[str], swc_blacklist: Optional[List[str]], swc_whitelist: Optional[List[str]]) → Tuple[mythx_models.response.analysis_status.AnalysisStatusResponse, mythx_models.response.detected_issues.DetectedIssuesResponse, mythx_models.response.analysis_input.AnalysisInputResponse][source]¶

Fetch information related to the specified analysis job UUID.

Given a UUID, this function will query the MythX API for the analysis status, the analysis’ input data, and the issue report. Furthermore, filtering parameters can be passed to remove certain SWCs or severities from the returned report.