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

Reorganize project extras for a pip installable package #3432

Merged
merged 84 commits into from
Nov 22, 2022

Conversation

piiq
Copy link
Contributor

@piiq piiq commented Nov 15, 2022

This PR reorganizes dependencies and updates the documentation to make the package pip-installable on more systems with less pre-requisites.

  • The PR creates an optional extra out of the Portfolio Optimization menu. This will enable the terminal and the SDK to be pip-installable on most of the platforms out-of-the-box (no reliance on the presence of CMake and specific conda packages)
  • The PR also moves most of the forecasting dependencies to pyproject.toml leaving only lightgbm in the conda yaml as it's the only one where arm64 binaries are not provided on pip and are extremely difficult to be built locally.
  • The PR introduces the all extra that would install both the PO and the Forecasting dependencies thus enabling the functionality

  • Move optimization out to extras
  • Implement safeguards that the optimization menu is inaccessible if the toolkit not installed
  • Update forecasting dependencies
  • Ensure tests pass
  • Update relevant documentation (main README & SDK_README)
  • Update test CI
  • Update Installer build CI
  • Update docker build dockerfile

@reviewpad reviewpad bot added the feat M Medium T-Shirt size feature label Nov 15, 2022
@piiq piiq added dependencies Work related to dependencies portfolio Portfolio menu platform OpenBB Platform labels Nov 15, 2022
@reviewpad reviewpad bot added the feat M Medium T-Shirt size feature label Nov 21, 2022
@jmaslek jmaslek merged commit 15d1870 into main Nov 22, 2022
@jmaslek jmaslek deleted the optimization-to-extras branch November 22, 2022 17:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Work related to dependencies feat L Large T-Shirt size Feature feat M Medium T-Shirt size feature platform OpenBB Platform portfolio Portfolio menu
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants