Merge pull request #281 from QuantConnect/feature-add-pdf-support-for…

…-reports

Add support for PDF generations for reports

README.md

@@ -1268,6 +1268,7 @@ Options:
   --overwrite                  Overwrite --report-destination if it already contains a file
   --image TEXT                 The LEAN engine image to use (defaults to quantconnect/lean:latest)
   --update                     Pull the LEAN engine image before running the report creator
+  --pdf                        Create a PDF version along with the HTML version of the report
   --lean-config FILE           The Lean configuration file that should be used (defaults to the nearest lean.json)
   --verbose                    Enable debug logging
   --help                       Show this message and exit.

lean/commands/report.py

@@ -76,6 +76,10 @@ def _find_project_directory(backtest_file: Path) -> Optional[Path]:
               is_flag=True,
               default=False,
               help="Pull the LEAN engine image before running the report creator")
+@option("--pdf",
+              is_flag=True,
+              default=False,
+              help="Create a PDF version along with the HTML version of the report")
 def report(backtest_results: Optional[Path],
            live_results: Optional[Path],
            report_destination: Path,
@@ -85,7 +89,8 @@ def report(backtest_results: Optional[Path],
            strategy_description: Optional[str],
            overwrite: bool,
            image: Optional[str],
-           update: bool) -> None:
+           update: bool,
+           pdf: bool) -> None:
     """Generate a report of a backtest.
 
     This runs the LEAN Report Creator in Docker to generate a polished, professional-grade report of a backtest.
@@ -152,7 +157,7 @@ def report(backtest_results: Optional[Path],
         "live-data-source-file": "live-data-source-file.json" if live_results is not None else "",
         "backtest-data-source-file": "backtest-data-source-file.json",
         "report-destination": "/tmp/report.html",
-
+        "report-format": "pdf" if pdf else "",
         "environment": "report",
 
         "log-handler": "QuantConnect.Logging.CompositeLogHandler",
@@ -217,6 +222,8 @@ def report(backtest_results: Optional[Path],
         }
     }
 
+    if pdf:
+        run_options["commands"].append(f'cp /tmp/report.pdf "/Output/{report_destination.name.replace(".html", ".pdf")}"')
     if live_results is not None:
         run_options["mounts"].append(Mount(target="/Lean/Report/bin/Debug/live-data-source-file.json",
                                            source=str(live_results),