From 5ddf96fd4d99d45f3608c4e47b2e7bb7b6de2433 Mon Sep 17 00:00:00 2001 From: Jhonathan Abreu Date: Thu, 20 Jun 2024 14:23:18 -0400 Subject: [PATCH 1/3] Update readme --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 88459e28..77973576 100644 --- a/README.md +++ b/README.md @@ -382,6 +382,7 @@ Options: The EMSX broker to use --terminal-link-emsx-account TEXT The EMSX account to use + --terminal-link-emsx-team TEXT The EMSX team to receive order events from --terminal-link-openfigi-api-key TEXT The Open FIGI API key to use for mapping options --tt-user-name TEXT Your Trading Technologies username @@ -1290,6 +1291,7 @@ Options: The EMSX broker to use --terminal-link-emsx-account TEXT The EMSX account to use + --terminal-link-emsx-team TEXT The EMSX team to receive order events from --terminal-link-openfigi-api-key TEXT The Open FIGI API key to use for mapping options --tt-user-name TEXT Your Trading Technologies username From 9ce92c16e690d742d43934402fe18acd1b0fad4e Mon Sep 17 00:00:00 2001 From: Jhonathan Abreu Date: Tue, 25 Jun 2024 11:37:37 -0400 Subject: [PATCH 2/3] Update readme --- README.md | 46 +++++++++++++++++------------------- lean/models/configuration.py | 2 ++ 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 77973576..728952eb 100644 --- a/README.md +++ b/README.md @@ -153,7 +153,7 @@ Options: --ib-weekly-restart-utc-time TEXT Weekly restart UTC time (hh:mm:ss). Each week on Sunday your algorithm is restarted at this time, and will require 2FA verification. This is required by Interactive Brokers. - Use this option explicitly to override the default value. + Use this option explicitly to override the default value. (Optional). --oanda-account-id TEXT Your OANDA account id --oanda-access-token TEXT Your OANDA API token --oanda-environment [Practice|Trade] @@ -189,8 +189,8 @@ Options: --coinapi-api-key TEXT Your coinapi.io Api Key --coinapi-product [Free|Startup|Streamer|Professional|Enterprise] CoinApi pricing plan (https://www.coinapi.io/market-data-api/pricing) - --thetadata-ws-url TEXT The ThetaData host address - --thetadata-rest-url TEXT The ThetaData host address + --thetadata-ws-url TEXT The ThetaData host address (Optional). + --thetadata-rest-url TEXT The ThetaData host address (Optional). --thetadata-subscription-plan [Free|Value|Standard|Pro] Your ThetaData subscription price plan --terminal-link-connection-type [DAPI|SAPI] @@ -330,7 +330,7 @@ Options: --ib-weekly-restart-utc-time TEXT Weekly restart UTC time (hh:mm:ss). Each week on Sunday your algorithm is restarted at this time, and will require 2FA verification. This is required by Interactive Brokers. - Use this option explicitly to override the default value. + Use this option explicitly to override the default value. (Optional). --tradier-account-id TEXT Your Tradier account id --tradier-access-token TEXT Your Tradier access token --tradier-environment [live|paper] @@ -379,10 +379,9 @@ Options: --terminal-link-server-port INTEGER The port of the SAPI server --terminal-link-emsx-broker TEXT - The EMSX broker to use + The EMSX broker to use (Optional). --terminal-link-emsx-account TEXT - The EMSX account to use - --terminal-link-emsx-team TEXT The EMSX team to receive order events from + The EMSX account to use (Optional). --terminal-link-openfigi-api-key TEXT The Open FIGI API key to use for mapping options --tt-user-name TEXT Your Trading Technologies username @@ -822,7 +821,7 @@ Options: --ib-weekly-restart-utc-time TEXT Weekly restart UTC time (hh:mm:ss). Each week on Sunday your algorithm is restarted at this time, and will require 2FA verification. This is required by Interactive Brokers. - Use this option explicitly to override the default value. + Use this option explicitly to override the default value. (Optional). --oanda-account-id TEXT Your OANDA account id --oanda-access-token TEXT Your OANDA API token --oanda-environment [Practice|Trade] @@ -858,8 +857,8 @@ Options: --coinapi-api-key TEXT Your coinapi.io Api Key --coinapi-product [Free|Startup|Streamer|Professional|Enterprise] CoinApi pricing plan (https://www.coinapi.io/market-data-api/pricing) - --thetadata-ws-url TEXT The ThetaData host address - --thetadata-rest-url TEXT The ThetaData host address + --thetadata-ws-url TEXT The ThetaData host address (Optional). + --thetadata-rest-url TEXT The ThetaData host address (Optional). --thetadata-subscription-plan [Free|Value|Standard|Pro] Your ThetaData subscription price plan --terminal-link-connection-type [DAPI|SAPI] @@ -1237,7 +1236,7 @@ Options: --ib-weekly-restart-utc-time TEXT Weekly restart UTC time (hh:mm:ss). Each week on Sunday your algorithm is restarted at this time, and will require 2FA verification. This is required by Interactive Brokers. - Use this option explicitly to override the default value. + Use this option explicitly to override the default value. (Optional). --tradier-account-id TEXT Your Tradier account id --tradier-access-token TEXT Your Tradier access token --tradier-environment [live|paper] @@ -1288,10 +1287,9 @@ Options: --terminal-link-server-port INTEGER The port of the TerminalLink server --terminal-link-emsx-broker TEXT - The EMSX broker to use + The EMSX broker to use (Optional). --terminal-link-emsx-account TEXT - The EMSX account to use - --terminal-link-emsx-team TEXT The EMSX team to receive order events from + The EMSX account to use (Optional). --terminal-link-openfigi-api-key TEXT The Open FIGI API key to use for mapping options --tt-user-name TEXT Your Trading Technologies username @@ -1312,7 +1310,7 @@ Options: The order routing target comp id to use --tt-order-routing-host TEXT The host of the order routing server --tt-order-routing-port TEXT The port of the order routing server - --tt-log-fix-messages BOOLEAN Whether FIX messages should be logged + --tt-log-fix-messages BOOLEAN Whether FIX messages should be logged (Optional). --kraken-api-key TEXT Your Kraken API key --kraken-api-secret TEXT Your Kraken API secret --kraken-verification-tier [Starter|Intermediate|Pro] @@ -1330,7 +1328,7 @@ Options: Whether the testnet should be used --ib-enable-delayed-streaming-data BOOLEAN Whether delayed data may be used when your algorithm subscribes to a security you - don't have a market data subscription for + don't have a market data subscription for (Optional). --iqfeed-iqconnect TEXT The path to the IQConnect binary --iqfeed-username TEXT Your IQFeed username --iqfeed-password TEXT Your IQFeed password @@ -1343,8 +1341,8 @@ Options: --coinapi-api-key TEXT Your coinapi.io Api Key --coinapi-product [Free|Startup|Streamer|Professional|Enterprise] CoinApi pricing plan (https://www.coinapi.io/market-data-api/pricing) - --thetadata-ws-url TEXT The ThetaData host address - --thetadata-rest-url TEXT The ThetaData host address + --thetadata-ws-url TEXT The ThetaData host address (Optional). + --thetadata-rest-url TEXT The ThetaData host address (Optional). --thetadata-subscription-plan [Free|Value|Standard|Pro] Your ThetaData subscription price plan --factset-auth-config-file FILE @@ -1678,7 +1676,7 @@ Options: --ib-weekly-restart-utc-time TEXT Weekly restart UTC time (hh:mm:ss). Each week on Sunday your algorithm is restarted at this time, and will require 2FA verification. This is required by Interactive Brokers. - Use this option explicitly to override the default value. + Use this option explicitly to override the default value. (Optional). --oanda-account-id TEXT Your OANDA account id --oanda-access-token TEXT Your OANDA API token --oanda-environment [Practice|Trade] @@ -1714,8 +1712,8 @@ Options: --coinapi-api-key TEXT Your coinapi.io Api Key --coinapi-product [Free|Startup|Streamer|Professional|Enterprise] CoinApi pricing plan (https://www.coinapi.io/market-data-api/pricing) - --thetadata-ws-url TEXT The ThetaData host address - --thetadata-rest-url TEXT The ThetaData host address + --thetadata-ws-url TEXT The ThetaData host address (Optional). + --thetadata-rest-url TEXT The ThetaData host address (Optional). --thetadata-subscription-plan [Free|Value|Standard|Pro] Your ThetaData subscription price plan --terminal-link-connection-type [DAPI|SAPI] @@ -1845,7 +1843,7 @@ Options: --ib-weekly-restart-utc-time TEXT Weekly restart UTC time (hh:mm:ss). Each week on Sunday your algorithm is restarted at this time, and will require 2FA verification. This is required by Interactive Brokers. - Use this option explicitly to override the default value. + Use this option explicitly to override the default value. (Optional). --oanda-account-id TEXT Your OANDA account id --oanda-access-token TEXT Your OANDA API token --oanda-environment [Practice|Trade] @@ -1881,8 +1879,8 @@ Options: --coinapi-api-key TEXT Your coinapi.io Api Key --coinapi-product [Free|Startup|Streamer|Professional|Enterprise] CoinApi pricing plan (https://www.coinapi.io/market-data-api/pricing) - --thetadata-ws-url TEXT The ThetaData host address - --thetadata-rest-url TEXT The ThetaData host address + --thetadata-ws-url TEXT The ThetaData host address (Optional). + --thetadata-rest-url TEXT The ThetaData host address (Optional). --thetadata-subscription-plan [Free|Value|Standard|Pro] Your ThetaData subscription price plan --terminal-link-connection-type [DAPI|SAPI] diff --git a/lean/models/configuration.py b/lean/models/configuration.py index e4c6e77c..c1e1601e 100644 --- a/lean/models/configuration.py +++ b/lean/models/configuration.py @@ -175,6 +175,8 @@ def __init__(self, config_json_object): self._prompt_info = config_json_object["prompt-info"] if "help" in config_json_object: self._help = config_json_object["help"] + if self._optional: + self._help += " (Optional)." if "save-persistently-in-lean" in config_json_object: self._save_persistently_in_lean = config_json_object["save-persistently-in-lean"] From 1a5fc2256884102a67a202d9763468623ae198ff Mon Sep 17 00:00:00 2001 From: Jhonathan Abreu Date: Mon, 8 Jul 2024 08:55:47 -0400 Subject: [PATCH 3/3] Update readme --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 728952eb..000469e2 100644 --- a/README.md +++ b/README.md @@ -382,6 +382,7 @@ Options: The EMSX broker to use (Optional). --terminal-link-emsx-account TEXT The EMSX account to use (Optional). + --terminal-link-emsx-team TEXT The EMSX team to receive order events from (Optional). --terminal-link-openfigi-api-key TEXT The Open FIGI API key to use for mapping options --tt-user-name TEXT Your Trading Technologies username @@ -1290,6 +1291,7 @@ Options: The EMSX broker to use (Optional). --terminal-link-emsx-account TEXT The EMSX account to use (Optional). + --terminal-link-emsx-team TEXT The EMSX team to receive order events from (Optional). --terminal-link-openfigi-api-key TEXT The Open FIGI API key to use for mapping options --tt-user-name TEXT Your Trading Technologies username