Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improvements within the Terminal for the Documentation #2048

Merged
merged 26 commits into from
Jul 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
d0b25b9
Change about us to open_terminal_documentation
JerBouma Jul 5, 2022
6546446
Change the home menu to be more compact
JerBouma Jul 5, 2022
44412e6
Make changes to menu layout and change bottom bar
JerBouma Jul 5, 2022
5212570
Change about command to send you to the documentation and add about t…
JerBouma Jul 5, 2022
b38417f
Add in about choices to all menus
JerBouma Jul 5, 2022
7581f13
Adjust wording
JerBouma Jul 5, 2022
0940500
Adjust the website to match terminal commands and make adjustments fo…
JerBouma Jul 5, 2022
e219cf1
Update the website and small change to about command
JerBouma Jul 5, 2022
ed78a75
Small adjustment to about command
JerBouma Jul 5, 2022
5c2f259
Remove update command
JerBouma Jul 5, 2022
0fb4283
Add some more info about arguments
JerBouma Jul 5, 2022
32e837e
Fix broken link
JerBouma Jul 5, 2022
badc337
Add pro tip
JerBouma Jul 5, 2022
dc2e4b5
Update keys to work well with about
JerBouma Jul 5, 2022
e65150e
Fix some common paths
JerBouma Jul 5, 2022
f556298
Merge branch 'main' into argparse_improvements
JerBouma Jul 5, 2022
438eb72
Add back in the update command with exception if packaged application
JerBouma Jul 5, 2022
c542af0
Merge branch 'argparse_improvements' of https://github.com/JerBouma/O…
JerBouma Jul 5, 2022
0279cf0
Merge branch 'main' into argparse_improvements
JerBouma Jul 5, 2022
61de343
Merge branch 'main' into argparse_improvements
JerBouma Jul 5, 2022
ae42106
Merge branch 'main' into argparse_improvements
JerBouma Jul 6, 2022
f68690a
Remove update comment
JerBouma Jul 6, 2022
fc802eb
Fix all the things
JerBouma Jul 6, 2022
0bbbfda
Make about more robust and also add in exe
JerBouma Jul 6, 2022
beac7b4
Make sure that there are actual commands and menus
JerBouma Jul 6, 2022
07a2d4c
Merge branch 'main' into argparse_improvements
JerBouma Jul 6, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
38 changes: 8 additions & 30 deletions i18n/en.yml
Original file line number Diff line number Diff line change
@@ -1,41 +1,16 @@
en:
_home_: >
[info]Get API keys from data providers to access more features.[/info]
For more instructions use: 'keys'.
To see all features follow: https://openbb-finance.github.io/OpenBBTerminal/

[info]Multiple jobs queue (where each '/' denotes a new command).[/info]
E.g. '/stocks $ disc/ugs -n 3/../load tsla/candle'

[info]If you want to jump from crypto/ta to stocks you can use an absolute path that starts with a slash (/).[/info]
E.g. '/crypto/ta $ /stocks'

[info]You can run a standalone .openbb routine file with:[/info]
E.g. '/ $ exe routines/example.openbb'

[info]You can run a .openbb routine file with variable inputs:[/info]
E.g. '/ $ exe routines/example_with_inputs.openbb --input pltr,tsla,nio'


[info]The main commands you should be aware when navigating through the terminal are:[/info]
cls: clear the screen
help: help menu ('h' or '?' also works)
quit: quit this menu and go one menu above ('q' or '..' also works)
exit: exit the terminal
reset: reset the terminal and reload configs from the current location ('r' also works)
resources: only available on main contexts (not sub-menus)
support: pre-populate support ticket for our team to evaluate
about: amore information about OpenBB
update: update terminal automatically (when using GitHub)
tz: set different timezone
export: select export folder to output data
[info]Information, guides and support for the OpenBB Terminal[/info]
about: discover the capabilities of the OpenBB Terminal (https://openbb.co/docs)
support: pre-populate a support ticket for our team to evaluate
update: attempt to update the terminal automatically (GitHub version)
exe: execute automated routine script
settings: tune settings (export folder, timezone, language, plot size)
featflags: enable and disable feature flags
keys: set API keys and check their validity
_configure_: Configure your own terminal
_main_menu_: Main menu
keys/_keys_: Set API keys. Type <API> -h for usage details
keys/_keys_: This menu allows you to set your own API keys. Type 'about' for more information
defined, test passed: defined, test passed
defined, test failed: defined, test failed
not defined: not defined
Expand Down Expand Up @@ -65,6 +40,8 @@ en:
settings/_flair: Flair
settings/lang: terminal language
settings/_language: Language
settings/export: select export folder to output data
settings/tz: set different timezone
settings/dpi: dots per inch
settings/backend: plotting backend (None, tkAgg, MacOSX, Qt5Agg)
settings/height: select plot height
Expand Down Expand Up @@ -797,6 +774,7 @@ en:
economy/index: find and plot any (major) index on the market
economy/treasury: obtain U.S. treasury rates
economy/ycrv: show sovereign yield curves
economy/ecocal: display economic calendar
economy/plot: plot data from the above commands together
economy/rtps: real-time performance sectors
economy/valuation: valuation of sectors, industry, country
Expand Down
1 change: 1 addition & 0 deletions openbb_terminal/alternative/alt_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ def __init__(self, queue: List[str] = None):
if session and obbff.USE_PROMPT_TOOLKIT:
choices: dict = {c: {} for c in self.controller_choices}
choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
1 change: 1 addition & 0 deletions openbb_terminal/cryptocurrency/crypto_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ def __init__(self, queue: List[str] = None):
# choices["prt"]["--vs"] = {c: {} for c in coingecko_coin_ids} # list is huge. makes typing buggy

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
1 change: 1 addition & 0 deletions openbb_terminal/cryptocurrency/defi/defi_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ def __init__(self, queue: List[str] = None):
}

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ def __init__(self, queue: List[str] = None):
}

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@ def __init__(
choices["news"]["-s"] = {c: None for c in cryptopanic_model.SORT_FILTERS}

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
1 change: 1 addition & 0 deletions openbb_terminal/cryptocurrency/nft/nft_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ def __init__(self, queue: List[str] = None):
choices: dict = {c: {} for c in self.controller_choices}

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ def __init__(self, queue: List[str] = None):
choices["baas"]["-s"] = {c: None for c in bitquery_model.BAAS_FILTERS}

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ def __init__(self, queue: List[str] = None):
choices["wfpe"] = {c: None for c in withdrawalfees_model.POSSIBLE_CRYPTOS}

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ def __init__(
choices["mc"]["--dist"] = {c: {} for c in mc_model.DISTRIBUTIONS}

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ def __init__(
choices["load"]["-r"] = {c: {} for c in c_help.INTERVALS}

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ def __init__(
choices: dict = {c: {} for c in self.controller_choices}

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
1 change: 1 addition & 0 deletions openbb_terminal/cryptocurrency/tools/tools_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ def __init__(self, queue: List[str] = None):
choices: dict = {c: {} for c in self.controller_choices}

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
1 change: 1 addition & 0 deletions openbb_terminal/custom/custom_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ def __init__(self, queue: List[str] = None):
self.choices = choices

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ def __init__(
self.choices = choices

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ def __init__(
self.choices = choices

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
1 change: 1 addition & 0 deletions openbb_terminal/dashboards/dashboards_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ def __init__(self, queue: List[str] = None):
choices: dict = {c: {} for c in self.controller_choices}

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
3 changes: 2 additions & 1 deletion openbb_terminal/econometrics/econometrics_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@

logger = logging.getLogger(__name__)

# pylint: disable=R0902
# pylint: disable=R0902,C0302


class EconometricsController(BaseController):
Expand Down Expand Up @@ -188,6 +188,7 @@ def __init__(self, queue: List[str] = None):
self.choices = choices

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
1 change: 1 addition & 0 deletions openbb_terminal/economy/economy_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,7 @@ def __init__(self, queue: List[str] = None):
self.choices["map"]["--period"] = {c: None for c in self.map_period_list}

self.choices["support"] = self.SUPPORT_CHOICES
self.choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(self.choices)

Expand Down
1 change: 1 addition & 0 deletions openbb_terminal/economy/prediction/pred_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ def __init__(
choices["pick"]["-c"] = {c: {} for c in self.options}

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ def __init__(
choices["pick"]["-c"] = {c: {} for c in self.options}

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
1 change: 1 addition & 0 deletions openbb_terminal/etf/discovery/disc_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ def __init__(self, queue: List[str] = None):
choices: dict = {c: {} for c in self.controller_choices}

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
1 change: 1 addition & 0 deletions openbb_terminal/etf/etf_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ def __init__(self, queue: List[str] = None):
choices: dict = {c: {} for c in self.controller_choices}

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ def __init__(
choices["mc"]["--dist"] = {c: {} for c in mc_model.DISTRIBUTIONS}

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
1 change: 1 addition & 0 deletions openbb_terminal/etf/screener/screener_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ def __init__(self, queue: List[str] = None):
}

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
1 change: 1 addition & 0 deletions openbb_terminal/etf/technical_analysis/ta_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ def __init__(
choices: dict = {c: {} for c in self.controller_choices}

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
1 change: 1 addition & 0 deletions openbb_terminal/forex/forex_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ def __init__(self, queue: List[str] = None):
choices["load"] = {c: None for c in FX_TICKERS}
choices["load"]["-t"] = {c: None for c in FX_TICKERS}
choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
1 change: 1 addition & 0 deletions openbb_terminal/forex/oanda/oanda_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ def __init__(self, queue: List[str] = None):
choices["from"] = {c: None for c in forex_helper.YF_CURRENCY_LIST}

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ def __init__(
choices["mc"]["--dist"] = {c: {} for c in mc_model.DISTRIBUTIONS}

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ def __init__(
choices["pick"] = {c: None for c in list(data.columns)}

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
1 change: 1 addition & 0 deletions openbb_terminal/forex/technical_analysis/ta_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ def __init__(
choices: dict = {c: {} for c in self.controller_choices}

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
1 change: 1 addition & 0 deletions openbb_terminal/mutual_funds/mutual_fund_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ def __init__(self, queue: List[str] = None):
choices["search"]["--sortby"] = {c: None for c in self.search_cols}

choices["support"] = self.SUPPORT_CHOICES
choices["about"] = self.ABOUT_CHOICES

self.completer = NestedCompleter.from_nested_dict(choices)

Expand Down
Loading