Update contraqctor to render to optionally render to html (#452)

Author: bruno-f-cruz

pyproject.toml

@@ -28,7 +28,7 @@ Changelog = "https://github.com/AllenNeuralDynamics/Aind.Behavior.VrForaging/rel
 
 [project.optional-dependencies]
 
-data = ["contraqctor<0.6.0"]
+data = ["contraqctor>=0.5.3, <0.6.0"]
 
 launcher = [
     "aind-clabe[aind-services] >0.8 ,<0.10.0",

src/aind_behavior_vr_foraging/data_qc.py

@@ -285,11 +285,19 @@ class DataQcCli(pydantic_settings.BaseSettings, cli_kebab_case=True):
         description="Path to the session data directory."
     )
     version: str = pydantic.Field(default=__semver__, description="Version of the dataset.")
+    report_path: Path | None = pydantic.Field(
+        default=None, description="Path to save the Html QC report. If not provided, report is not saved."
+    )
 
     def cli_cmd(self):
         vr_dataset = dataset(Path(self.data_path), self.version)
         runner = make_qc_runner(vr_dataset)
-        runner.run_all_with_progress()
+        results = runner.run_all_with_progress()
+        if report_path := self.report_path:
+            from contraqctor.qc.reporters import HtmlReporter
+
+            reporter = HtmlReporter(output_path=report_path)
+            reporter.report_results(results, serialize_context_exportable_obj=True)
 
 
 if __name__ == "__main__":