diff --git a/openbb_sdk/README.md b/openbb_sdk/README.md index c408bdfec1b..fbf14c7def5 100644 --- a/openbb_sdk/README.md +++ b/openbb_sdk/README.md @@ -68,8 +68,8 @@ You can also specify your keys at runtime: ```python from openbb import obb -obb.settings.credentials.fmp_api_key = "REPLACE_ME" -obb.settings.credentials.polygon_api_key = "REPLACE_ME" +obb.user.credentials.fmp_api_key = "REPLACE_ME" +obb.user.credentials.polygon_api_key = "REPLACE_ME" ``` ### 3. From OpenBB Hub diff --git a/openbb_sdk/sdk/core/README.md b/openbb_sdk/sdk/core/README.md index e20b9766a01..96b68b375c8 100644 --- a/openbb_sdk/sdk/core/README.md +++ b/openbb_sdk/sdk/core/README.md @@ -237,10 +237,10 @@ These are your user settings, you can change them anytime and they will be appli ```python from openbb import obb -obb.settings.profile -obb.settings.credentials -obb.settings.preferences -obb.settings.defaults +obb.user.profile +obb.user.credentials +obb.user.preferences +obb.user.defaults ``` #### System @@ -298,7 +298,7 @@ obb.account.login(pat="your_pat", remember_me=True) # pragma: allowlist secret obb.account.login(email="your_email", password="your_password", remember_me=True) # pragma: allowlist secret # Change a credential -obb.account.settings.credentials.polygon_api_key = "new_key" # pragma: allowlist secret +obb.user.credentials.polygon_api_key = "new_key" # pragma: allowlist secret # Save account changes obb.account.save() diff --git a/openbb_sdk/sdk/core/openbb_core/api/rest_api.py b/openbb_sdk/sdk/core/openbb_core/api/rest_api.py index 2c4d85d722b..0ae5f009de3 100644 --- a/openbb_sdk/sdk/core/openbb_core/api/rest_api.py +++ b/openbb_sdk/sdk/core/openbb_core/api/rest_api.py @@ -6,8 +6,8 @@ from openbb_core.api.dependency.user import get_user_service from openbb_core.api.router.account import router as router_account from openbb_core.api.router.commands import router as router_commands from openbb_core.api.router.coverage import router as router_coverage -from openbb_core.api.router.settings import router as router_settings from openbb_core.api.router.system import router as router_system +from openbb_core.api.router.user import router as router_user from openbb_core.app.model.abstract.error import OpenBBError from openbb_core.app.model.profile import Profile from openbb_core.app.model.user_settings import UserSettings @@ -28,7 +28,7 @@ app = FastAPI( }, ) app.include_router(router=router_account, prefix="/api/v1") -app.include_router(router=router_settings, prefix="/api/v1") +app.include_router(router=router_user, prefix="/api/v1") app.include_router(router=router_system, prefix="/api/v1") app.include_router(router=router_coverage, prefix="/api/v1") app.include_router(router=router_commands, prefix="/api/v1") diff --git a/openbb_sdk/sdk/core/openbb_core/api/router/settings.py b/openbb_sdk/sdk/core/openbb_core/api/router/user.py similarity index 94% rename from openbb_sdk/sdk/core/openbb_core/api/router/settings.py rename to openbb_sdk/sdk/core/openbb_core/api/router/user.py index 79e8e844751..e98ccda6850 100644 --- a/openbb_sdk/sdk/core/openbb_core/api/router/settings.py +++ b/openbb_sdk/sdk/core/openbb_core/api/router/user.py @@ -4,7 +4,7 @@ from openbb_core.app.model.credentials import Credentials from openbb_core.app.model.user_settings import UserSettings from typing_extensions import Annotated -router = APIRouter(prefix="/settings", tags=["Settings"]) +router = APIRouter(prefix="/user", tags=["User"]) @router.get("") diff --git a/openbb_sdk/sdk/core/openbb_core/app/static/app_factory.py b/openbb_sdk/sdk/core/openbb_core/app/static/app_factory.py index 10a59f3b005..ea2a0c45e8f 100644 --- a/openbb_sdk/sdk/core/openbb_core/app/static/app_factory.py +++ b/openbb_sdk/sdk/core/openbb_core/app/static/app_factory.py @@ -25,12 +25,12 @@ def create_app(): Basic utility menus: - account - - settings + - user - system - coverage Built-in extensions: - - charting: utility extension common to all built-in extensions + - charting - crypto - economy - fixedincome @@ -50,7 +50,7 @@ def create_app(): return self._account @property - def settings(self) -> UserSettings: + def user(self) -> UserSettings: return self._command_runner_session.user_settings @property diff --git a/openbb_sdk/sdk/core/tests/api/router/test_settings.py b/openbb_sdk/sdk/core/tests/api/router/test_router_user.py similarity index 91% rename from openbb_sdk/sdk/core/tests/api/router/test_settings.py rename to openbb_sdk/sdk/core/tests/api/router/test_router_user.py index f7d48b8b21f..e02c1603106 100644 --- a/openbb_sdk/sdk/core/tests/api/router/test_settings.py +++ b/openbb_sdk/sdk/core/tests/api/router/test_router_user.py @@ -2,7 +2,7 @@ import asyncio from unittest.mock import Mock -from openbb_core.api.router.settings import patch_user_credentials, read_users_settings +from openbb_core.api.router.user import patch_user_credentials, read_users_settings from openbb_core.app.model.credentials import Credentials from openbb_core.app.model.user_settings import UserSettings