From 11b186f173fb93d69bdf62062c36d7d2d95ed918 Mon Sep 17 00:00:00 2001 From: Pratyush Shukla Date: Thu, 12 Oct 2023 00:22:44 +0530 Subject: [PATCH 1/4] SDK -> Platform in docs --- openbb_platform/extensions/crypto/README.md | 2 +- openbb_platform/extensions/econometrics/README.md | 2 +- openbb_platform/extensions/economy/README.md | 2 +- openbb_platform/extensions/fixedincome/README.md | 2 +- openbb_platform/extensions/forex/README.md | 2 +- openbb_platform/extensions/futures/README.md | 2 +- openbb_platform/extensions/news/README.md | 2 +- openbb_platform/extensions/qa/README.md | 2 +- openbb_platform/extensions/stocks/README.md | 2 +- openbb_platform/extensions/ta/README.md | 2 +- openbb_platform/platform/core/README.md | 10 +++++----- openbb_platform/providers/alpha_vantage/README.md | 2 +- openbb_platform/providers/benzinga/README.md | 2 +- openbb_platform/providers/cboe/README.md | 2 +- openbb_platform/providers/fmp/README.md | 2 +- openbb_platform/providers/fred/README.md | 2 +- openbb_platform/providers/intrinio/README.md | 2 +- openbb_platform/providers/polygon/README.md | 2 +- openbb_platform/providers/quandl/README.md | 2 +- openbb_platform/providers/yfinance/README.md | 2 +- 20 files changed, 24 insertions(+), 24 deletions(-) diff --git a/openbb_platform/extensions/crypto/README.md b/openbb_platform/extensions/crypto/README.md index 56b014eecec2..1a106f973ca4 100644 --- a/openbb_platform/extensions/crypto/README.md +++ b/openbb_platform/extensions/crypto/README.md @@ -1,4 +1,4 @@ -# Crypto data extension for OpenBB SDK +# Crypto data extension for OpenBB Platform This extension provides a set of commands for crypto data retrieval. diff --git a/openbb_platform/extensions/econometrics/README.md b/openbb_platform/extensions/econometrics/README.md index 09d6ac03616c..f35e5229d402 100644 --- a/openbb_platform/extensions/econometrics/README.md +++ b/openbb_platform/extensions/econometrics/README.md @@ -1,4 +1,4 @@ -# Econometrics extension for OpenBB SDK +# Econometrics extension for OpenBB Platform This extension provides a set of econometrics tools. diff --git a/openbb_platform/extensions/economy/README.md b/openbb_platform/extensions/economy/README.md index 2cb24f89f4fc..87a3d69325fe 100644 --- a/openbb_platform/extensions/economy/README.md +++ b/openbb_platform/extensions/economy/README.md @@ -1,6 +1,6 @@ # OpenBB Economy Extension -The Economy extension provides global macroeconomic data access for the OpenBB SDK. +The Economy extension provides global macroeconomic data access for the OpenBB Platform. ## Installation diff --git a/openbb_platform/extensions/fixedincome/README.md b/openbb_platform/extensions/fixedincome/README.md index a14599e09555..fd6fca1153a1 100644 --- a/openbb_platform/extensions/fixedincome/README.md +++ b/openbb_platform/extensions/fixedincome/README.md @@ -1,6 +1,6 @@ # OpenBB Fixed Income Extension -This extension provides fixed income data for the OpenBB SDK. +This extension provides fixed income data for the OpenBB Platform. Features of the Fixed Income extension include information on government bonds and central bank rates. diff --git a/openbb_platform/extensions/forex/README.md b/openbb_platform/extensions/forex/README.md index 6da68a973492..dae104331ffb 100644 --- a/openbb_platform/extensions/forex/README.md +++ b/openbb_platform/extensions/forex/README.md @@ -1,6 +1,6 @@ # OpenBB Forex Extension -This extension provides currency exchange related data for the OpenBB SDK. +This extension provides currency exchange related data for the OpenBB Platform. ## Installation diff --git a/openbb_platform/extensions/futures/README.md b/openbb_platform/extensions/futures/README.md index 5b708852dc4c..9ece6335839f 100644 --- a/openbb_platform/extensions/futures/README.md +++ b/openbb_platform/extensions/futures/README.md @@ -1,4 +1,4 @@ -# Futures data extension for OpenBB SDK +# Futures data extension for OpenBB Platform This extension provides a set of commands for futures data retrieval. diff --git a/openbb_platform/extensions/news/README.md b/openbb_platform/extensions/news/README.md index 4c8b4b7200a6..d84e9bf76116 100644 --- a/openbb_platform/extensions/news/README.md +++ b/openbb_platform/extensions/news/README.md @@ -1,6 +1,6 @@ # OpenBB News Extension -This extension provides news for the OpenBB SDK. +This extension provides news for the OpenBB Platform. ## Installation diff --git a/openbb_platform/extensions/qa/README.md b/openbb_platform/extensions/qa/README.md index ddcea65b53fd..f4af2301b54b 100644 --- a/openbb_platform/extensions/qa/README.md +++ b/openbb_platform/extensions/qa/README.md @@ -1,6 +1,6 @@ # OpenBB QA Extension -This extension provides Quantitative Analysis (QA) tools for the OpenBB SDK. +This extension provides Quantitative Analysis (QA) tools for the OpenBB Platform. Features of the QA extension include various statistical tools and models. diff --git a/openbb_platform/extensions/stocks/README.md b/openbb_platform/extensions/stocks/README.md index 92d171608139..d6406b21d198 100644 --- a/openbb_platform/extensions/stocks/README.md +++ b/openbb_platform/extensions/stocks/README.md @@ -1,6 +1,6 @@ # OpenBB Stocks Extension -This extension provides stock market data tools for the OpenBB SDK. +This extension provides stock market data tools for the OpenBB Platform. Features of the Stocks extension include: diff --git a/openbb_platform/extensions/ta/README.md b/openbb_platform/extensions/ta/README.md index f79558f754fc..938f1e062aca 100644 --- a/openbb_platform/extensions/ta/README.md +++ b/openbb_platform/extensions/ta/README.md @@ -1,6 +1,6 @@ # OpenBB TA Extension -This extension provides Technical Analysis (TA) tools for the OpenBB SDK. +This extension provides Technical Analysis (TA) tools for the OpenBB Platform. Features of the TA extension include various TA indicators and oscillators. diff --git a/openbb_platform/platform/core/README.md b/openbb_platform/platform/core/README.md index 473e75121ecd..0ff751bba5f4 100644 --- a/openbb_platform/platform/core/README.md +++ b/openbb_platform/platform/core/README.md @@ -32,7 +32,7 @@ ## 1. Introduction -This directory contains the OpenBB SDK's core functionality. It allows you to create an [extension](../../extensions/README.md) or a [provider](../../providers/README.md) that will be automatically turned into REST API endpoint and allow sharing data between commands. +This directory contains the OpenBB Platform's core functionality. It allows you to create an [extension](../../extensions/README.md) or a [provider](../../providers/README.md) that will be automatically turned into REST API endpoint and allow sharing data between commands. ## 2. How to install? @@ -297,7 +297,7 @@ from openbb import obb # Login with personal access token obb.account.login(pat="your_pat", remember_me=True) # pragma: allowlist secret -# Login with email, password or SDK token +# Login with email, password or Platform token obb.account.login(email="your_email", password="your_password", remember_me=True) # pragma: allowlist secret # Change a credential @@ -317,7 +317,7 @@ obb.account.logout() How do we execute commands? -OpenBB SDK core is a REST API powered by FastAPI. We use this feature to run commands both in a web server setting and also in the `openbb` python package. +OpenBB Platform core is a REST API powered by FastAPI. We use this feature to run commands both in a web server setting and also in the `openbb` python package. If you are using the `openbb` package, running the command below triggers a "request" to the `CommandRunner` class. The "request" will be similar to the one found in [4.2 Dynamic version](#42-dynamic-version). This will hit the endpoint matching the command and return the result. @@ -335,7 +335,7 @@ obb.stocks.load( ### 4.1.5. Environment variables -The OS environment is only read once before the program starts, so make sure you change the variable before importing the SDK. We use the prefix "OPENBB_" to avoid polluting the environment (no pun intended). +The OS environment is only read once before the program starts, so make sure you change the variable before importing the Platform. We use the prefix "OPENBB_" to avoid polluting the environment (no pun intended). To apply an environment variable use one of the following: @@ -400,7 +400,7 @@ extra: ... # Extra info. ## 5. REST API -OpenBB SDK comes with a ready to use Rest API built with FastAPI. Start the application using this command: +OpenBB Platform comes with a ready to use Rest API built with FastAPI. Start the application using this command: ```bash uvicorn openbb_core.api.rest_api:app --reload diff --git a/openbb_platform/providers/alpha_vantage/README.md b/openbb_platform/providers/alpha_vantage/README.md index 5297e55219ed..3d214308526f 100644 --- a/openbb_platform/providers/alpha_vantage/README.md +++ b/openbb_platform/providers/alpha_vantage/README.md @@ -1,6 +1,6 @@ # OpenBB Alpha Vantage Provider -This extension integrates the [Alpha Vantage](https://www.alphavantage.co/) data provider into the OpenBB SDK. +This extension integrates the [Alpha Vantage](https://www.alphavantage.co/) data provider into the OpenBB Platform. ## Installation diff --git a/openbb_platform/providers/benzinga/README.md b/openbb_platform/providers/benzinga/README.md index 70708de623f3..22c9b119384a 100644 --- a/openbb_platform/providers/benzinga/README.md +++ b/openbb_platform/providers/benzinga/README.md @@ -1,6 +1,6 @@ # OpenBB Benzinga Provider -This extension integrates the [Benzinga](https://www.benzinga.com/) data provider into the OpenBB SDK. +This extension integrates the [Benzinga](https://www.benzinga.com/) data provider into the OpenBB Platform. ## Installation diff --git a/openbb_platform/providers/cboe/README.md b/openbb_platform/providers/cboe/README.md index 61b2b93882e4..3352b5a71a0a 100644 --- a/openbb_platform/providers/cboe/README.md +++ b/openbb_platform/providers/cboe/README.md @@ -1,6 +1,6 @@ # OpenBB CBOE Provider -This extension integrates the [CBOE](https://www.cboe.com/) data provider into the OpenBB SDK. +This extension integrates the [CBOE](https://www.cboe.com/) data provider into the OpenBB Platform. ## Installation diff --git a/openbb_platform/providers/fmp/README.md b/openbb_platform/providers/fmp/README.md index 5ee7727ef925..8a1ff544460b 100644 --- a/openbb_platform/providers/fmp/README.md +++ b/openbb_platform/providers/fmp/README.md @@ -1,6 +1,6 @@ # OpenBB Financial Modeling Prep Provider -This extension integrates the [Financial Modeling Prep](https://site.financialmodelingprep.com/) data provider into the OpenBB SDK. +This extension integrates the [Financial Modeling Prep](https://site.financialmodelingprep.com/) data provider into the OpenBB Platform. ## Installation diff --git a/openbb_platform/providers/fred/README.md b/openbb_platform/providers/fred/README.md index 3b3dcb25cefe..aeaa1de630c9 100644 --- a/openbb_platform/providers/fred/README.md +++ b/openbb_platform/providers/fred/README.md @@ -1,6 +1,6 @@ # OpenBB FRED Provider -This extension integrates the [FRED](https://fred.stlouisfed.org/docs/api/fred/) data provider into the OpenBB SDK. +This extension integrates the [FRED](https://fred.stlouisfed.org/docs/api/fred/) data provider into the OpenBB Platform. ## Installation diff --git a/openbb_platform/providers/intrinio/README.md b/openbb_platform/providers/intrinio/README.md index c11a49b72459..267ab6987c45 100644 --- a/openbb_platform/providers/intrinio/README.md +++ b/openbb_platform/providers/intrinio/README.md @@ -1,6 +1,6 @@ # OpenBB Intrinio Provider -This extension integrates the [Intrinio](https://intrinio.com/) data provider into the OpenBB SDK. +This extension integrates the [Intrinio](https://intrinio.com/) data provider into the OpenBB Platform. ## Installation diff --git a/openbb_platform/providers/polygon/README.md b/openbb_platform/providers/polygon/README.md index 807c19170085..43d90fc8f6f2 100644 --- a/openbb_platform/providers/polygon/README.md +++ b/openbb_platform/providers/polygon/README.md @@ -1,6 +1,6 @@ # OpenBB Polygon Provider -This extension integrates the [Polygon](https://polygon.io/) data provider into the OpenBB SDK. +This extension integrates the [Polygon](https://polygon.io/) data provider into the OpenBB Platform. ## Installation diff --git a/openbb_platform/providers/quandl/README.md b/openbb_platform/providers/quandl/README.md index f64424d90d38..d9071c583961 100644 --- a/openbb_platform/providers/quandl/README.md +++ b/openbb_platform/providers/quandl/README.md @@ -1,6 +1,6 @@ # OpenBB Quandl Provider -This extension integrates the [Quandl](https://data.nasdaq.com/publishers/QDL) data provider into the OpenBB SDK. +This extension integrates the [Quandl](https://data.nasdaq.com/publishers/QDL) data provider into the OpenBB Platform. ## Installation diff --git a/openbb_platform/providers/yfinance/README.md b/openbb_platform/providers/yfinance/README.md index 373a78c58c19..9c997e9b6303 100644 --- a/openbb_platform/providers/yfinance/README.md +++ b/openbb_platform/providers/yfinance/README.md @@ -1,6 +1,6 @@ # OpenBB Yahoo!Finance Provider -This extension integrates the [Yahoo!Finance](https://finance.yahoo.com/) data provider into the OpenBB SDK. +This extension integrates the [Yahoo!Finance](https://finance.yahoo.com/) data provider into the OpenBB Platform. ## Installation From f143a0b6a565db38002c0b03d62103e749955dda Mon Sep 17 00:00:00 2001 From: Pratyush Shukla Date: Thu, 12 Oct 2023 00:24:13 +0530 Subject: [PATCH 2/4] renamed in core --- .../platform/core/openbb_core/api/rest_api.py | 4 ++-- .../openbb_core/app/model/system_settings.py | 2 +- .../core/openbb_core/app/service/hub_service.py | 12 ++++++------ .../openbb_core/app/static/package_builder.py | 16 ++++++++-------- .../core/tests/app/service/test_hub_service.py | 4 ++-- 5 files changed, 19 insertions(+), 19 deletions(-) diff --git a/openbb_platform/platform/core/openbb_core/api/rest_api.py b/openbb_platform/platform/core/openbb_core/api/rest_api.py index 641b91b9a294..0b4b96dc9dd6 100644 --- a/openbb_platform/platform/core/openbb_core/api/rest_api.py +++ b/openbb_platform/platform/core/openbb_core/api/rest_api.py @@ -15,8 +15,8 @@ logger = logging.getLogger("uvicorn.error") app = FastAPI( - title="OpenBB SDK API", - description="This is the OpenBB SDK API.", + title="OpenBB Platform API", + description="This is the OpenBB Platform API.", version="0.0.1", terms_of_service="http://example.com/terms/", contact={ diff --git a/openbb_platform/platform/core/openbb_core/app/model/system_settings.py b/openbb_platform/platform/core/openbb_core/app/model/system_settings.py index 725145005631..1a08500c54d4 100644 --- a/openbb_platform/platform/core/openbb_core/app/model/system_settings.py +++ b/openbb_platform/platform/core/openbb_core/app/model/system_settings.py @@ -25,7 +25,7 @@ class SystemSettings(Tagged): platform: str = FrozenField(default=str(pl.platform())) # OpenBB section - # TODO: Get the version of the SDK from somewhere that's not pyproject.toml + # TODO: Get the version of the Platform from somewhere that's not pyproject.toml version: str = FrozenField(default=VERSION) home_directory: str = FrozenField(default=str(HOME_DIRECTORY)) openbb_directory: str = FrozenField(default=str(OPENBB_DIRECTORY)) diff --git a/openbb_platform/platform/core/openbb_core/app/service/hub_service.py b/openbb_platform/platform/core/openbb_core/app/service/hub_service.py index dfb8f8921865..ebbb3e4ec3de 100644 --- a/openbb_platform/platform/core/openbb_core/app/service/hub_service.py +++ b/openbb_platform/platform/core/openbb_core/app/service/hub_service.py @@ -124,9 +124,9 @@ def _get_session_from_email_password(self, email: str, password: str) -> HubSess raise HTTPException(status_code, detail) def _get_session_from_sdk_token(self, token: str) -> HubSession: - """Get session from SDK personal access token.""" + """Get session from Platform personal access token.""" if not token: - raise OpenBBError("SDK personal access token not found.") + raise OpenBBError("Platform personal access token not found.") self.check_token_expiration(token) @@ -216,7 +216,7 @@ def _put_user_settings( @classmethod def hub2sdk(cls, settings: HubUserSettings) -> Credentials: - """Convert Hub user settings to SDK models.""" + """Convert Hub user settings to Platform models.""" credentials = Credentials( alpha_vantage_api_key=settings.features_keys.API_KEY_ALPHAVANTAGE, fred_api_key=settings.features_keys.API_FRED_KEY, @@ -229,7 +229,7 @@ def hub2sdk(cls, settings: HubUserSettings) -> Credentials: @classmethod def sdk2hub(cls, credentials: Credentials) -> HubUserSettings: - """Convert SDK models to Hub user settings.""" + """Convert Platform models to Hub user settings.""" def get_cred(cred: str) -> Optional[str]: return getattr(credentials, cred, None) @@ -257,6 +257,6 @@ def check_token_expiration(token: str) -> None: options={"verify_signature": False, "verify_exp": True}, ) except ExpiredSignatureError as e: - raise OpenBBError("SDK personal access token expired.") from e + raise OpenBBError("Platform personal access token expired.") from e except JWTError as e: - raise OpenBBError("Failed to decode SDK token.") from e + raise OpenBBError("Failed to decode Platform token.") from e diff --git a/openbb_platform/platform/core/openbb_core/app/static/package_builder.py b/openbb_platform/platform/core/openbb_core/app/static/package_builder.py index f6e35408a11f..406aa590be8f 100644 --- a/openbb_platform/platform/core/openbb_core/app/static/package_builder.py +++ b/openbb_platform/platform/core/openbb_core/app/static/package_builder.py @@ -48,7 +48,7 @@ def log(self, message: str, **kwargs): class PackageBuilder: - """Build the extension package for the SDK.""" + """Build the extension package for the Platform.""" def __init__( self, directory: Optional[Path] = None, lint: bool = True, verbose: bool = False @@ -72,7 +72,7 @@ def build( self, modules: Optional[Union[str, List[str]]] = None, ) -> None: - """Build the extensions for the SDK.""" + """Build the extensions for the Platform.""" self.console.log("\nBuilding extensions package...\n") self.clean_package(modules) ext_map = self.get_extension_map() @@ -170,7 +170,7 @@ def write_to_package(self, code: str, name: str, extension="py") -> None: class ModuleBuilder: - """Build the module for the SDK.""" + """Build the module for the Platform.""" @staticmethod def build(path: str, ext_map: Optional[Dict[str, List[str]]] = None) -> str: @@ -183,7 +183,7 @@ def build(path: str, ext_map: Optional[Dict[str, List[str]]] = None) -> str: class ImportDefinition: - """Build the import definition for the SDK.""" + """Build the import definition for the Platform.""" @staticmethod def filter_hint_type_list(hint_type_list: List[Type]) -> List[Type]: @@ -280,7 +280,7 @@ def build(cls, path: str) -> str: class ClassDefinition: - """Build the class definition for the SDK.""" + """Build the class definition for the Platform.""" @staticmethod def build(path: str, ext_map: Optional[Dict[str, List[str]]] = None) -> str: @@ -515,7 +515,7 @@ def generate( class MethodDefinition: - """Build the method definition for the SDK.""" + """Build the method definition for the Platform.""" @staticmethod def build_class_loader_method(path: str) -> str: @@ -817,7 +817,7 @@ def build_command_method( class PathHandler: - """Handle the paths for the SDK.""" + """Handle the paths for the Platform.""" @staticmethod def build_route_map() -> Dict[str, BaseRoute]: @@ -884,7 +884,7 @@ def build_module_class(cls, path: str) -> str: class Linters: - """Run the linters for the SDK.""" + """Run the linters for the Platform.""" def __init__(self, directory: Path, verbose: bool = False) -> None: self.directory = directory diff --git a/openbb_platform/platform/core/tests/app/service/test_hub_service.py b/openbb_platform/platform/core/tests/app/service/test_hub_service.py index 31166acb9824..234d83b86934 100644 --- a/openbb_platform/platform/core/tests/app/service/test_hub_service.py +++ b/openbb_platform/platform/core/tests/app/service/test_hub_service.py @@ -41,7 +41,7 @@ def test_connect_with_email_password(): def test_connect_with_sdk_token(): - """Test connect with SDK personal access token.""" + """Test connect with Platform personal access token.""" mock_hub_session = MagicMock(spec=HubSession) with patch( "requests.post", return_value=MagicMock(status_code=200, json=lambda: {}) @@ -86,7 +86,7 @@ def test_get_session_from_email_password(): def test_get_session_from_sdk_token(): - """Test get session from SDK personal access token.""" + """Test get session from Platform personal access token.""" with patch( "openbb_core.app.service.hub_service.post", From 5c640130cbcfaac882775d14abf2a93e550b77cb Mon Sep 17 00:00:00 2001 From: Pratyush Shukla Date: Thu, 12 Oct 2023 00:24:47 +0530 Subject: [PATCH 3/4] renamed in openbb `init` --- openbb_platform/openbb/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openbb_platform/openbb/__init__.py b/openbb_platform/openbb/__init__.py index 72ac83f1c158..c46f0490faa5 100644 --- a/openbb_platform/openbb/__init__.py +++ b/openbb_platform/openbb/__init__.py @@ -1,4 +1,4 @@ -"""OpenBB SDK.""" +"""OpenBB Platform.""" # flake8: noqa import os From ec7f022c3cc4efc3a43b6224cdff999abe7e9e76 Mon Sep 17 00:00:00 2001 From: Pratyush Shukla Date: Thu, 12 Oct 2023 00:34:14 +0530 Subject: [PATCH 4/4] `sdk` variable renamed as `platform` --- .../platform/core/openbb_core/app/model/system_settings.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openbb_platform/platform/core/openbb_core/app/model/system_settings.py b/openbb_platform/platform/core/openbb_core/app/model/system_settings.py index 1a08500c54d4..84baf01d997f 100644 --- a/openbb_platform/platform/core/openbb_core/app/model/system_settings.py +++ b/openbb_platform/platform/core/openbb_core/app/model/system_settings.py @@ -33,7 +33,7 @@ class SystemSettings(Tagged): system_settings_path: str = FrozenField(default=str(SYSTEM_SETTINGS_PATH)) # Logging section - logging_app_name: Literal["sdk"] = FrozenField(default="sdk") + logging_app_name: Literal["platform"] = FrozenField(default="platform") logging_commit_hash: Optional[str] = FrozenField(default=None) logging_frequency: Literal["D", "H", "M", "S"] = FrozenField(default="H") logging_handlers: List[str] = FrozenField(default_factory=lambda: ["file"])