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

[IMPROVE] Remove Python remarks in the Installer version #1823

Closed
JerBouma opened this issue May 16, 2022 · 1 comment
Closed

[IMPROVE] Remove Python remarks in the Installer version #1823

JerBouma opened this issue May 16, 2022 · 1 comment
Assignees

Comments

@JerBouma
Copy link
Contributor

JerBouma commented May 16, 2022

What's the feature that should be improved?
There are comments about Python in the installer that shouldn't be there (e.g. '$ python terminal.py /stocks/disc/ugs -n 3/../load tsla/candle'):

╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Home ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│                                                                                                                                                                                                                                                                      │
│ Get API keys from data providers to access more features.                                                                                                                                                                                                            │
│     For more instructions use: 'keys'.                                                                                                                                                                                                                               │
│     To see all features follow: https://openbb-finance.github.io/OpenBBTerminal/                                                                                                                                                                                     │
│                                                                                                                                                                                                                                                                      │
│ Multiple jobs queue (where each '/' denotes a new command).                                                                                                                                                                                                          │
│     E.g. '/stocks $ disc/ugs -n 3/../load tsla/candle'                                                                                                                                                                                                               │
│                                                                                                                                                                                                                                                                      │
│ If you want to jump from crypto/ta to stocks you can use an absolute path that starts with a slash (/).                                                                                                                                                              │
│     E.g. '/crypto/ta $ /stocks'                                                                                                                                                                                                                                      │
│                                                                                                                                                                                                                                                                      │
│ The previous logic also holds for when launching the terminal.                                                                                                                                                                                                       │
│     E.g. '$ python terminal.py /stocks/disc/ugs -n 3/../load tsla/candle'                                                                                                                                                                                            │
│                                                                                                                                                                                                                                                                      │
│ You can run a standalone .openbb routine file with:                                                                                                                                                                                                                  │
│     E.g. '$ python terminal.py routines/example.openbb'                                                                                                                                                                                                              │
│                                                                                                                                                                                                                                                                      │
│ You can run a .openbb routine file with variable inputs:                                                                                                                                                                                                             │
│     E.g. '$ python terminal.py routines/example_with_inputs.gst --input pltr,tsla,nio'                                                                                                                                                                               │
│                                                                                                                                                                                                                                                                      │
│ The main commands you should be aware when navigating through the terminal are:                                                                                                                                                                                      │
│     cls             clear the screen                                                                                                                                                                                                                                 │
│     help / h / ?    help menu                                                                                                                                                                                                                                        │
│     quit / q / ..   quit this menu and go one menu above                                                                                                                                                                                                             │
│     exit            exit the terminal                                                                                                                                                                                                                                │
│     reset / r       reset the terminal and reload configs from the current location                                                                                                                                                                                  │
│     resources       only available on main contexts (not sub-menus)                                                                                                                                                                                                  │
│     support         pre-populate support ticket for our team to evaluate                                                                                                                                                                                             │
│                                                                                                                                                                                                                                                                      │
│     about           about us                                                                                                                                                                                                                                         │
│     update          update terminal automatically                                                                                                                                                                                                                    │
│     tz              set different timezone                                                                                                                                                                                                                           │
│     export          select export folder to output data                                                                                                                                                                                                              │
│     exe             execute automated routine script                                                                                                                                                                                                                 │
│ >   settings        set feature flags and style charts                                                                                                                                                                                                               │
│ >   keys            set API keys and check their validity          

Describe how you would like the feature improved
Remove this if the installer package is created or find a replacement command.

Bonus: note the .gst in '$ python terminal.py routines/example_with_inputs.gst --input pltr,tsla,nio', that should be .openbb

@DidierRLopes DidierRLopes self-assigned this May 21, 2022
@DidierRLopes
Copy link
Collaborator

I have fixed this in #1852, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants