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

Add terminal-wide report command #1709

Merged
merged 15 commits into from
May 10, 2022
Merged

Add terminal-wide report command #1709

merged 15 commits into from
May 10, 2022

Conversation

minhhoang1023
Copy link
Contributor

@minhhoang1023 minhhoang1023 commented Apr 18, 2022

Description

Confluence page: https://openbb.atlassian.net/wiki/spaces/ENG/pages/80936995/Helpdesk+Implementation

  • Add terminal-wide report command with auto-completion for the commands
  • Connect with Airtable DB for storage

Note:

  • If you want to test it, please send me a DM and I'll share with you the Airtable access keys

  • As next time while collecting feedback, reports should be sent to an API gateway, which is then connected with Airtable. this is such that we don't expose the key with write permissions

  • Summary of the change / bug fix.

  • Link # issue, if applicable.

  • Screenshot of the feature or the bug before/after fix, if applicable.

  • Relevant motivation and context.

  • List any dependencies that are required for this change.

How has this been tested?

  • Please describe the tests that you ran to verify your changes.
  • Provide instructions so we can reproduce.
  • Please also list any relevant details for your test configuration.

Checklist:

Others

  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • My code passes all the checks pylint, flake8, black, ... To speed up development you should run pre-commit install.
  • New and existing unit tests pass locally with my changes. You can test this locally using pytest tests/....

@minhhoang1023 minhhoang1023 added the feat L Large T-Shirt size Feature label Apr 18, 2022
@jmaslek
Copy link
Collaborator

jmaslek commented Apr 20, 2022

Not necessary, but is it possible to use nocoDB as an air table alternative?

(https://github.com/nocodb/nocodb)

Copy link
Collaborator

@DidierRLopes DidierRLopes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This command shouldn't be "report" but "support".

We already use "reports" naming for other features and we don't want to have that confusion here.

@minhhoang1023
Copy link
Contributor Author

Not necessary, but is it possible to use nocoDB as an air table alternative?

(https://github.com/nocodb/nocodb)

Ooh that looks nice! airtable is not cheap, so I could look into this once the engagement grows out of scope for Google Sheets

@minhhoang1023 minhhoang1023 marked this pull request as draft April 22, 2022 12:01
@minhhoang1023 minhhoang1023 marked this pull request as ready for review May 10, 2022 06:16
Copy link
Collaborator

@DidierRLopes DidierRLopes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comments below.

On top of that can you do a quick thing for me?

This is my welcome screen
Screenshot 2022-05-10 at 11 27 35

Can we change it to this and put it inside:
Screenshot 2022-05-10 at 11 30 19

Here is the text:

[info]Get API keys from data providers to access more features.[/info]
    For more instructions use: 'keys' 

On top of that when displaying terminal version, mine is showing vREPLACE_ME, which is not ideal. Can you check if the str is different than REPLACE_ME and if it's not just not display any version?

Thanks!!

openbb_terminal/parent_classes.py Show resolved Hide resolved
openbb_terminal/parent_classes.py Show resolved Hide resolved
openbb_terminal/parent_classes.py Show resolved Hide resolved
openbb_terminal/parent_classes.py Outdated Show resolved Hide resolved
openbb_terminal/parent_classes.py Outdated Show resolved Hide resolved
openbb_terminal/parent_classes.py Outdated Show resolved Hide resolved
openbb_terminal/portfolio/brokers/bro_controller.py Outdated Show resolved Hide resolved
terminal.py Outdated Show resolved Hide resolved
@piiq
Copy link
Contributor

piiq commented May 10, 2022

@DidierRLopes @minhhoang1023 the vREPLACE_ME will be fixed by the time we do the next release. This relates to poetry not installing the openbb_terminal package correctly into the local environment. Known issue. Let's keep it out of the scope of this PR, please

@DidierRLopes
Copy link
Collaborator

@DidierRLopes @minhhoang1023 the vREPLACE_ME will be fixed by the time we do the next release. This relates to poetry not installing the openbb_terminal package correctly into the local environment. Known issue. Let's keep it out of the scope of this PR, please

Thought it would be a 2 liner change and therefore worth the protection added here - seems sloppy currently. Since I use advanced mode I only saw this now.

@piiq
Copy link
Contributor

piiq commented May 10, 2022

@DidierRLopes @minhhoang1023 the vREPLACE_ME will be fixed by the time we do the next release. This relates to poetry not installing the openbb_terminal package correctly into the local environment. Known issue. Let's keep it out of the scope of this PR, please

Thought it would be a 2 liner change and therefore worth the protection added here - seems sloppy currently. Since I use advanced mode I only saw this now.

It's 2 symbols if you hardcode the version number =) . I was trying to fetch the version number from pyproject.toml on boot and it fails in some environments

Copy link
Collaborator

@DidierRLopes DidierRLopes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing 🙌🏽🙌🏽🙌🏽 legooo

@minhhoang1023
Copy link
Contributor Author

BOOM! MERGED!

@minhhoang1023 minhhoang1023 merged commit 2e67fd2 into main May 10, 2022
DidierRLopes added a commit that referenced this pull request May 11, 2022
* fix tz autocomplete

* fix regression introduced by support command #1709

Co-authored-by: James Maslek <[email protected]>
@DidierRLopes DidierRLopes deleted the helpdesk-report branch May 30, 2022 10:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat L Large T-Shirt size Feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants