From c69e14a5ca0b4412b7445a71fb6254c4e75b5093 Mon Sep 17 00:00:00 2001 From: James Maslek Date: Thu, 12 May 2022 20:54:58 -0400 Subject: [PATCH] Improve main terminal menu + small alignments (#1813) * random spacing * add m * Add context descriptions to main terminal menu * clean up forex alignment * lint --- openbb_terminal/feature_flags.py | 2 +- openbb_terminal/forex/forex_controller.py | 20 ++++++------- terminal.py | 28 ++++++++++--------- .../test_forex_controller/test_print_help.txt | 20 ++++++------- 4 files changed, 36 insertions(+), 34 deletions(-) diff --git a/openbb_terminal/feature_flags.py b/openbb_terminal/feature_flags.py index e128d2276fc..cacda6de56a 100644 --- a/openbb_terminal/feature_flags.py +++ b/openbb_terminal/feature_flags.py @@ -83,5 +83,5 @@ LOGGING_COMMIT_HASH = str(os.getenv("OPENBB_LOGGING_COMMIT_HASH", "REPLACE_ME")) try: version = pkg_resources.get_distribution("OpenBBTerminal").version except Exception: - version = "1.2.1m" + version = "1.3.0m" VERSION = str(os.getenv("OPENBB_VERSION", version)) diff --git a/openbb_terminal/forex/forex_controller.py b/openbb_terminal/forex/forex_controller.py index 60d9176eae1..a90920f7ce6 100644 --- a/openbb_terminal/forex/forex_controller.py +++ b/openbb_terminal/forex/forex_controller.py @@ -61,24 +61,24 @@ class ForexController(BaseController): has_symbols_start = "" if self.from_symbol and self.to_symbol else "[dim]" has_symbols_end = "" if self.from_symbol and self.to_symbol else "[/dim]" help_text = f"""[cmds] - from select the "from" currency in a forex pair - to select the "to" currency in a forex pair[/cmds] + from select the "from" currency in a forex pair + to select the "to" currency in a forex pair[/cmds] [param]From: [/param]{None or self.from_symbol} [param]To: [/param]{None or self.to_symbol} [param]Source: [/param]{None or FOREX_SOURCES[self.source]}[cmds]{has_symbols_start} [cmds] - quote get last quote [src][AlphaVantage][/src] - load get historical data - candle show candle plot for loaded pair - fwd get forward rates for loaded pair[src][FXEmpire][/src][/cmds] + quote get last quote [src][AlphaVantage][/src] + load get historical data + candle show candle plot for loaded pair + fwd get forward rates for loaded pair [src][FXEmpire][/src][/cmds] [menu] -> ta technical analysis for loaded coin, e.g.: ema, macd, rsi, adx, bbands, obv -> qa quantitative analysis, e.g.: decompose, cusum, residuals analysis -> pred prediction techniques e.g.: regression, arima, rnn, lstm, conv1d, monte carlo +> ta technical analysis, e.g.: ema, macd, rsi, adx, bbands, obv +> qa quantitative analysis, e.g.: decompose, cusum, residuals analysis +> pred prediction techniques e.g.: regression, arima, rnn, lstm, conv1d, monte carlo [/menu]{has_symbols_end} [info]Forex brokerages:[/info][menu] -> oanda Oanda menu[/menu][/cmds] +> oanda Oanda menu[/menu][/cmds] """ console.print(text=help_text, menu="Forex") diff --git a/terminal.py b/terminal.py index 53ed880c1cb..47aed1c59bf 100644 --- a/terminal.py +++ b/terminal.py @@ -137,20 +137,22 @@ class TerminalController(BaseController): [param]Export Folder:[/param] {obbff.EXPORT_FOLDER_PATH if obbff.EXPORT_FOLDER_PATH else 'DEFAULT (folder: exports/)'} [param]Timezone: [/param] {get_user_timezone_or_invalid()} -[menu] -> stocks -> crypto -> etf -> economy -> forex -> funds -> alternative -> econometrics +[menu][info] +Asset classes:[/info] +> stocks access historical pricing data, options, sector and industry, and overall due diligence +> crypto dive into onchain data, tokenomics, circulation supply, nfts and more +> etf exchange traded funds. Historical pricing, compare holdings and screening +> economy global macroeconomic data, e.g. futures, yield, treasury +> forex foreign exchanges, quotes, forward rates for currency pairs and oanda integration +> funds mutual funds search, overview, holdings and sector weights +> alternative alternative datasets, such as COVID and open source metrics -> portfolio -> dashboards -> reports[/menu] - """, +[info]Others:[/info] +> econometrics statistical and quantitative methods for relationships between datasets +> portfolio perform portfolio optimization and look at portfolio performance and attribution +> dashboards interactive dashboards using voila and jupyter notebooks +> reports customizable research reports through jupyter notebooks[/menu] +""", menu="Home", ) diff --git a/tests/openbb_terminal/forex/txt/test_forex_controller/test_print_help.txt b/tests/openbb_terminal/forex/txt/test_forex_controller/test_print_help.txt index d1d3920d5eb..fd54376cc71 100644 --- a/tests/openbb_terminal/forex/txt/test_forex_controller/test_print_help.txt +++ b/tests/openbb_terminal/forex/txt/test_forex_controller/test_print_help.txt @@ -1,20 +1,20 @@ - from select the "from" currency in a forex pair - to select the "to" currency in a forex pair + from select the "from" currency in a forex pair + to select the "to" currency in a forex pair From: USD To: Source: YahooFinance[dim] - quote get last quote [AlphaVantage] - load get historical data - candle show candle plot for loaded pair - fwd get forward rates for loaded pair[FXEmpire] + quote get last quote [AlphaVantage] + load get historical data + candle show candle plot for loaded pair + fwd get forward rates for loaded pair [FXEmpire] -> ta technical analysis for loaded coin, e.g.: ema, macd, rsi, adx, bbands, obv -> qa quantitative analysis, e.g.: decompose, cusum, residuals analysis -> pred prediction techniques e.g.: regression, arima, rnn, lstm, conv1d, monte carlo +> ta technical analysis, e.g.: ema, macd, rsi, adx, bbands, obv +> qa quantitative analysis, e.g.: decompose, cusum, residuals analysis +> pred prediction techniques e.g.: regression, arima, rnn, lstm, conv1d, monte carlo [/dim] Forex brokerages: -> oanda Oanda menu +> oanda Oanda menu