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

SDK : faster and simpler architecture #3289

Merged
merged 71 commits into from
Nov 9, 2022

Conversation

Chavithra
Copy link
Contributor

Description

Currently the SDK contains different features:

  • shortcuts
  • selection between model and view : according to the chart=True/False parameter
  • documentation of the module
  • documentation of the functions
  • logging

All these parts are entangled, which makes it hard to check/change one specific part.

GOAL
This PR is meant to make code more team work friendly.

SIDE EFFECT
The loading time of the SDK is reduced.

@Chavithra Chavithra added the feat L Large T-Shirt size Feature label Nov 3, 2022
@piiq
Copy link
Contributor

piiq commented Nov 4, 2022

Is this mergeable?

P.S. How do we import the sdk after this change?

@Chavithra Chavithra added the do not merge Label to prevent pull request merge label Nov 9, 2022
Copy link
Contributor

@hjoaquim hjoaquim left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@hjoaquim
Copy link
Contributor

hjoaquim commented Nov 9, 2022

@montezdesousa @jmaslek this is ready imo, but since I was also pushing some commits, would be cool if one of you took a look at this! Tks!

@hjoaquim
Copy link
Contributor

hjoaquim commented Nov 9, 2022

Also, @jmaslek we're keeping the from openbb_terminal.sdk import openbb so there are no changes from the user's perspective!

@Chavithra Chavithra removed the do not merge Label to prevent pull request merge label Nov 9, 2022
@Chavithra Chavithra merged commit b93671a into OpenBB-finance:main Nov 9, 2022
@Chavithra Chavithra deleted the sdk_update branch November 9, 2022 21:25
noubre pushed a commit to noubre/OpenBBTerminal that referenced this pull request Dec 13, 2022
* SDK : split features

* Fix linting

* SDK : remove functions

* SDK : update openbb object building

* SDK : comments

* Typing

* Typing

* Typing

* SDK : update logs

* SDK : Breadcrumb

* SDK : Breadcrumb + Operation

* SDK : spell

* Linting

* Tests : SDK

* SDK : Operation

* SDK : Operation

* Linting

* enable wrong import position

* added logging info

* added log supression

* reverted the order

* SDK : update trail_map

* log suppresion as configuration

* changes reports to use the new sdk

* changes dashboards to use the new sdk

* changes dashboards to use the new sdk

* updated the documentation

* Tests + Linting

* Replace old sdk by new sdk

* Linting

* SDK : import + map_dict

* Linting

* Linting

* SDK : sdk + trail_map

* Linting

* SDK : forecasting

* SDK : update import path

* SDK

* SDK : md

* Linting

* removed unused functions

* trunc args to a max of 100 characters

* added logging when exceptions

* .md files

* SDK : add signature on operation + linting + remove trail on Breadcrumb

* Linting

* Move tests

* Linting

* Linting

* Linting

* Linting

* Linting

* Linting

* Linting

Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt>
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.

5 participants