compass.utilities.finalize.compile_collection_summary_message#

compile_collection_summary_message(manifest_fp, collection_manifest, total_seconds)[source]#

Compile a short collection summary message

Parameters:

  • manifest_fp (path-like) – File path where the collection manifest was written. The value is embedded in the summary text.

  • collection_manifest (dict) – Dictionary describing the collection results, including a list of jurisdictions and their associated documents. The function extracts jurisdiction and document counts from the manifest for inclusion in the summary.

  • total_seconds (float or int) – Duration of the collection phase in seconds, used to report total runtime in the summary.

Returns:

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