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

[Feature] - Create repo assets directory #6384

Merged
merged 31 commits into from
May 10, 2024
Merged

Conversation

montezdesousa
Copy link
Contributor

@montezdesousa montezdesousa commented May 9, 2024

  1. Why?

    • providers.json needed to be manually updated
    • Information about extensions and providers is required by OpenBB Hub
  2. What?

    • Instructions and v3_credentials are now defined in the Provider class
    • Creates assets folder for the repo. Applications that need to know any repo information should rely on this folder only.
    • This avoids downstream applications to scrape the repo and then be broken by a file that is randomly deleted.
    • We know which files need to be maintained
    • Deletes PROVIDERS.md and EXTENSIONS.md. These were not maintained and info is duplicated in multiple places
  3. Impact:

    • providers.json was already read by OpenBB Hub to provide credential hints, need to update that website before merging this code to main
  4. Testing Done:

python assets/scripts/generate_extensions_data.py

@github-actions github-actions bot added enhancement Enhancement platform OpenBB Platform v4 PRs for v4 labels May 9, 2024
@montezdesousa montezdesousa added the do not merge Label to prevent pull request merge label May 9, 2024
@deeleeramone
Copy link
Contributor

@montezdesousa, should we include the /examples folder too? Would we need to move the JSON file there?

https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/examples/content.json

Copy link
Contributor

@IgorWounds IgorWounds left a comment

Choose a reason for hiding this comment

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

This is good!

Knowing that V3 is deprecated and discontinued, for how long should we keep the v3 credential mapping in our v4 architecture and mapping?

Should we migrate to the mapping of v4 at a certain point? cc: @andrewkenreich

@montezdesousa
Copy link
Contributor Author

montezdesousa commented May 10, 2024

@montezdesousa, should we include the /examples folder too? Would we need to move the JSON file there?

https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/examples/content.json

Sounds good, is it auto-generated or we can just move it and redirect on the Hub?

Edit: merged this to unblock the PR.

@montezdesousa montezdesousa changed the title [Feature] - Create scripts to generate repo assets [Feature] - Create repo assets directory May 10, 2024
@montezdesousa montezdesousa removed the do not merge Label to prevent pull request merge label May 10, 2024
@montezdesousa montezdesousa marked this pull request as ready for review May 10, 2024 19:15
@montezdesousa montezdesousa added this pull request to the merge queue May 10, 2024
Merged via the queue into develop with commit 5b74280 May 10, 2024
10 of 11 checks passed
@montezdesousa montezdesousa deleted the feature/repo-assets branch May 10, 2024 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhancement platform OpenBB Platform v4 PRs for v4
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants