Files
quantconnect--lean/Configuration/ReportArgumentParser.cs
T
Ricardo Andrés Marino Rojas 3338486b52
Benchmarks / build (push) Has been cancelled
Build & Test Lean / build (push) Has been cancelled
Regression Tests / build (push) Has been cancelled
Research Regression Tests / build (push) Has been cancelled
Python Virtual Environments / build (push) Has been cancelled
Enable Report generator to use custom HTML template (#7410)
* Add support for custom HTML file in Report

* Add support for custom crisis HTML template

* Revert "Add support for custom crisis HTML template"

After considering this option carefully, the QC team has decided to
add this functionality in a different way.

This reverts commit aead1ff8504556417e9dffadb33b06c7599ab87a.

* Get parameters and crisis HTML custom templates

* Move parameters html template to a file

* Nit change

* Remove template.crisis.html and add unit tests

* Nit change

* Nit change

* Add unit tests for the fail cases
2023-08-01 12:55:14 -03:00

54 lines
2.6 KiB
C#

/*
* QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
* Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using System.Collections.Generic;
using McMaster.Extensions.CommandLineUtils;
namespace QuantConnect.Configuration
{
/// <summary>
/// Command Line arguments parser for Report Creator
/// </summary>
public static class ReportArgumentParser
{
private const string ApplicationName = "Report Creator";
private const string ApplicationDescription =
"LEAN Report Creator generates beautiful PDF reports from your backtesting strategies for sharing with prospective partners.";
private const string ApplicationHelpText =
"If you are looking for help, please go to https://www.quantconnect.com/docs";
private static readonly List<CommandLineOption> Options = new List<CommandLineOption>
{
new CommandLineOption("strategy-name", CommandOptionType.SingleValue, "Strategy name"),
new CommandLineOption("strategy-description", CommandOptionType.SingleValue, "Strategy description"),
new CommandLineOption("live-data-source-file", CommandOptionType.SingleValue, "Live source data json file"),
new CommandLineOption("backtest-data-source-file", CommandOptionType.SingleValue, "Backtest source data json file"),
new CommandLineOption("report-destination", CommandOptionType.SingleValue, "Destination of processed report file"),
new CommandLineOption("report-css-override-file", CommandOptionType.SingleValue, "CSS override source file"),
new CommandLineOption("report-html-custom-file", CommandOptionType.SingleValue, "Custom HTML source file"),
};
/// <summary>
/// Parse and construct the args.
/// </summary>
public static Dictionary<string, object> ParseArguments(string[] args)
{
return ApplicationParser.Parse(ApplicationName, ApplicationDescription, ApplicationHelpText, args, Options);
}
}
}