mafw.devtools.dependencies.audit

Dependency auditing utilities for MAFw.

This module provides functions for running pip-audit against compiled requirement files.

Functions

run_pip_audit(req_file, output_file, ...)

Run pip-audit on a requirements file and save the output.

mafw.devtools.dependencies.audit.run_pip_audit(req_file: Path, output_file: Path, output_format: str) CompletedProcess[Any][source]

Run pip-audit on a requirements file and save the output.

Parameters:
  • req_file (Path) – Requirements file to audit.

  • output_file (Path) – Path to the output report.

  • output_format (str) – Format of the report (e.g. ‘markdown’, ‘json’).

Returns:

Completed process produced by the command execution.

Return type:

subprocess.CompletedProcess[Any]