From 3eb640cd21e2cc29944a3c4258a435e7072f7476 Mon Sep 17 00:00:00 2001 From: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Date: Tue, 5 Dec 2023 17:07:16 +0000 Subject: [PATCH] Feature/add version (#5861) * add version to base doc * clean account doc * consistency --- openbb_platform/core/openbb_core/api/rest_api.py | 2 +- .../core/openbb_core/app/static/account.py | 14 ++++++-------- .../core/openbb_core/app/static/app_factory.py | 15 ++++++++------- 3 files changed, 15 insertions(+), 16 deletions(-) diff --git a/openbb_platform/core/openbb_core/api/rest_api.py b/openbb_platform/core/openbb_core/api/rest_api.py index b03e22f0938..48a95877798 100644 --- a/openbb_platform/core/openbb_core/api/rest_api.py +++ b/openbb_platform/core/openbb_core/api/rest_api.py @@ -61,7 +61,7 @@ async def startup(): banner = rf""" ███╗ - █████████████████╔══█████████████████╗ OpenBB Platform {system.version} + █████████████████╔══█████████████████╗ OpenBB Platform v{system.version} ███╔══════════███║ ███╔══════════███║ █████████████████║ █████████████████║ Authentication: {auth} ╚═════════════███║ ███╔═════════════╝ diff --git a/openbb_platform/core/openbb_core/app/static/account.py b/openbb_platform/core/openbb_core/app/static/account.py index fd9ad5ce106..7507185a2af 100644 --- a/openbb_platform/core/openbb_core/app/static/account.py +++ b/openbb_platform/core/openbb_core/app/static/account.py @@ -1,4 +1,4 @@ -"""Account service.""" +"""Account.""" # pylint: disable=W0212:protected-access import json from functools import wraps @@ -18,13 +18,11 @@ if TYPE_CHECKING: class Account: - """The account service handles the following commands. - - /account - login - logout - save - refresh + """/account + login + logout + save + refresh """ SESSION_FILE = ".hub_session.json" diff --git a/openbb_platform/core/openbb_core/app/static/app_factory.py b/openbb_platform/core/openbb_core/app/static/app_factory.py index 5d39f6d6327..dbf8f7d0da0 100644 --- a/openbb_platform/core/openbb_core/app/static/app_factory.py +++ b/openbb_platform/core/openbb_core/app/static/app_factory.py @@ -1,3 +1,4 @@ +"""App factory.""" from typing import Optional, Type, TypeVar from openbb_core.app.command_runner import CommandRunner @@ -6,13 +7,10 @@ from openbb_core.app.model.user_settings import UserSettings from openbb_core.app.static.account import Account from openbb_core.app.static.container import Container from openbb_core.app.static.coverage import Coverage +from openbb_core.app.version import VERSION E = TypeVar("E", bound=Type[Container]) - - -class BaseApp: - # fmt: off - """OpenBB Platform +BASE_DOC = f"""OpenBB Platform v{VERSION} Utilities: /account @@ -20,7 +18,10 @@ Utilities: /system /coverage """ - # fmt: on + + +class BaseApp: + """Base app.""" def __init__(self, command_runner: CommandRunner): self._command_runner = command_runner @@ -58,6 +59,6 @@ def create_app(extensions: Optional[E] = None) -> Type[BaseApp]: def __repr__(self) -> str: # pylint: disable=E1101 ext_doc = extensions.__doc__ if extensions else "" - return (super().__doc__ or "") + (ext_doc or "") + return BASE_DOC + (ext_doc or "") return App(command_runner=CommandRunner())