compass.utilities.finalize.compile_run_summary_message#

compile_run_summary_message(total_seconds, total_cost, out_dir, document_count)[source]#

Create a human-readable summary of a completed run

Parameters:

  • total_seconds (float or int) – Duration of the run in seconds.

  • total_cost (float or int or None) – Monetary cost incurred by the run. None or zero suppresses the cost line in the summary.

  • out_dir (path-like) – Location of the run output directory. The value is embedded in the summary text.

  • document_count (int) – Number of documents discovered across all jurisdictions.

Returns:

str – Summary string formatted for CLI presentation with rich markup.

Notes

The function does not perform I/O; callers may log or display the returned string as needed.