openbb-cli 1.0.0__py3-none-any.whl

openbb_cli/models/settings.py

@@ -0,0 +1,73 @@
+"""Settings model"""
+
+from typing import Any
+
+from dotenv import dotenv_values, set_key
+from openbb_cli.config.constants import ENV_FILE_SETTINGS
+from pydantic import BaseModel, ConfigDict, model_validator
+
+
+class Settings(BaseModel):
+    """Settings model."""
+
+    # Platform CLI version
+    VERSION: str = "1.0.0"
+
+    # DEVELOPMENT FLAGS
+    TEST_MODE: bool = False
+    DEBUG_MODE: bool = False
+    DEV_BACKEND: bool = False
+
+    # FEATURE FLAGS
+    FILE_OVERWRITE: bool = False
+    SHOW_VERSION: bool = True
+    USE_INTERACTIVE_DF: bool = True
+    USE_CLEAR_AFTER_CMD: bool = False
+    USE_DATETIME: bool = True
+    USE_PROMPT_TOOLKIT: bool = True
+    ENABLE_EXIT_AUTO_HELP: bool = True
+    REMEMBER_CONTEXTS: bool = True
+    ENABLE_RICH_PANEL: bool = True
+    TOOLBAR_HINT: bool = True
+    SHOW_MSG_OBBJECT_REGISTRY: bool = False
+
+    # GENERAL
+    TIMEZONE: str = "America/New_York"
+    FLAIR: str = ":openbb"
+    PREVIOUS_USE: bool = False
+    N_TO_KEEP_OBBJECT_REGISTRY: int = 10
+    N_TO_DISPLAY_OBBJECT_REGISTRY: int = 5
+
+    # STYLE
+    RICH_STYLE: str = "dark"
+
+    # OUTPUT
+    ALLOWED_NUMBER_OF_ROWS: int = 20
+    ALLOWED_NUMBER_OF_COLUMNS: int = 5
+
+    # OPENBB
+    HUB_URL: str = "https://my.openbb.co"
+    BASE_URL: str = "https://payments.openbb.co"
+
+    model_config = ConfigDict(validate_assignment=True)
+
+    def __repr__(self) -> str:
+        """Return a string representation of the model."""
+        return f"{self.__class__.__name__}\n\n" + "\n".join(
+            f"{k}: {v}" for k, v in self.model_dump().items()
+        )
+
+    @model_validator(mode="before")
+    @classmethod
+    def from_env(cls, values: dict) -> dict:
+        """Load settings from .env."""
+        settings = {}
+        settings.update(dotenv_values(ENV_FILE_SETTINGS))
+        settings.update(values)
+        filtered = {k.replace("OPENBB_", ""): v for k, v in settings.items()}
+        return filtered
+
+    def set_item(self, key: str, value: Any) -> None:
+        """Set an item in the model and save to .env."""
+        setattr(self, key, value)
+        set_key(str(ENV_FILE_SETTINGS), "OPENBB_" + key, str(value))

openbb_cli/session.py

@@ -0,0 +1,92 @@
+"""Settings module."""
+
+import sys
+from pathlib import Path
+from typing import Optional
+
+from openbb import obb
+from openbb_core.app.model.abstract.singleton import SingletonMeta
+from openbb_core.app.model.user_settings import UserSettings as User
+from prompt_toolkit import PromptSession
+
+from openbb_cli.argparse_translator.obbject_registry import Registry
+from openbb_cli.config.completer import CustomFileHistory
+from openbb_cli.config.console import Console
+from openbb_cli.config.constants import HIST_FILE_PROMPT
+from openbb_cli.config.style import Style
+from openbb_cli.models.settings import Settings
+
+
+class Session(metaclass=SingletonMeta):
+    """Session class."""
+
+    def __init__(self):
+        """Initialize session."""
+        self._obb = obb
+        self._settings = Settings()
+        self._style = Style(
+            style=self._settings.RICH_STYLE,
+            directory=Path(self._obb.user.preferences.user_styles_directory),  # type: ignore[union-attr]
+        )
+        self._console = Console(
+            settings=self._settings, style=self._style.console_style
+        )
+        self._prompt_session = self._get_prompt_session()
+        self._obbject_registry = Registry()
+
+    @property
+    def user(self) -> User:
+        """Get platform user."""
+        return self._obb.user  # type: ignore[union-attr]
+
+    @property
+    def settings(self) -> Settings:
+        """Get CLI settings."""
+        return self._settings
+
+    @property
+    def style(self) -> Style:
+        """Get CLI style."""
+        return self._style
+
+    @property
+    def console(self) -> Console:
+        """Get console."""
+        return self._console
+
+    @property
+    def obbject_registry(self) -> Registry:
+        """Get obbject registry."""
+        return self._obbject_registry
+
+    @property
+    def prompt_session(self) -> Optional[PromptSession]:
+        """Get prompt session."""
+        return self._prompt_session
+
+    def _get_prompt_session(self) -> Optional[PromptSession]:
+        """Initialize prompt session."""
+        try:
+            if sys.stdin.isatty():
+                prompt_session: Optional[PromptSession] = PromptSession(
+                    history=CustomFileHistory(str(HIST_FILE_PROMPT))
+                )
+            else:
+                prompt_session = None
+        except Exception:
+            prompt_session = None
+
+        return prompt_session
+
+    def is_local(self) -> bool:
+        """Check if user is local."""
+        return not bool(self.user.profile.hub_session)
+
+    def reset(self) -> None:
+        pass
+
+    def max_obbjects_exceeded(self) -> bool:
+        """Check if max obbjects exceeded."""
+        return (
+            len(self.obbject_registry.all) >= self.settings.N_TO_KEEP_OBBJECT_REGISTRY
+        )

openbb_cli-1.0.0.dist-info/METADATA

@@ -0,0 +1,91 @@
+Metadata-Version: 2.1
+Name: openbb-cli
+Version: 1.0.0
+Summary: Investment Research for Everyone, Anywhere.
+Home-page: https://openbb.co
+License: AGPL-3.0-only
+Author: OpenBB
+Author-email: hello@openbb.co
+Requires-Python: >=3.8.1,<3.12
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: openbb[all] (>=4.2.0,<5.0.0)
+Requires-Dist: openpyxl (>=3.1.2,<4.0.0)
+Requires-Dist: prompt-toolkit (>=3.0.16,<4.0.0)
+Requires-Dist: python-dotenv (>=1.0.0,<2.0.0)
+Requires-Dist: rich (>=13,<14)
+Project-URL: Documentation, https://docs.openbb.co/terminal
+Project-URL: Repository, https://github.com/OpenBB-finance/OpenBBTerminal
+Description-Content-Type: text/markdown
+
+# OpenBB Platform CLI
+
+[![Downloads](https://static.pepy.tech/badge/openbb)](https://pepy.tech/project/openbb)
+[![LatestRelease](https://badge.fury.io/py/openbb.svg)](https://github.com/OpenBB-finance/OpenBBTerminal)
+
+| OpenBB is committed to build the future of investment research by focusing on an open source infrastructure accessible to everyone, everywhere. |
+| :---------------------------------------------------------------------------------------------------------------------------------------------: |
+|              ![OpenBBLogo](https://user-images.githubusercontent.com/25267873/218899768-1f0964b8-326c-4f35-af6f-ea0946ac970b.png)               |
+|                                                 Check our website at [openbb.co](www.openbb.co)                                                 |
+
+## Overview
+
+The OpenBB CLI is a command line interface that wraps [OpenBB Platform](https://docs.openbb.co/platform).
+
+It offers a convenient way to interact with the OpenBB Platform and its extensions, as well as automate data collection via OpenBB Routine Scripts.
+
+Find the most complete documentation, examples, and usage guides for the OpenBB Platform CLI [here](https://my.openbb.co/app/cli).
+
+## Installation
+
+The command below provides access to the all the available OpenBB extensions behind the OpenBB Platform, find the complete list [here](https://my.openbb.co/app/platform/extensions).
+
+```bash
+pip install openbb-cli
+```
+
+> Note: Find the most complete installation hints and tips [here](https://my.openbb.co/app/cli/installation).
+
+After the installation is complete, you can deploy the OpenBB CLI by running the following command:
+
+```bash
+openbb
+```
+
+Which should result in the following output:
+
+![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/48914296/f606bb6e-fa00-4fc8-bad2-8269bb4fc38e)
+
+## API keys
+
+To fully leverage the OpenBB Platform you need to get some API keys to connect with data providers. Here are the 3 options on where to set them:
+
+1. OpenBB Hub
+2. Local file
+
+### 1. OpenBB Hub
+
+Set your keys at [OpenBB Hub](https://my.openbb.co/app/platform/credentials) and get your personal access token from <https://my.openbb.co/app/platform/pat> to connect with your account.
+
+> Once you log in, on the Platform CLI (through the `/account` menu, all your credentials will be in sync with the OpenBB Hub.)
+
+### 2. Local file
+
+You can specify the keys directly in the `~/.openbb_platform/user_settings.json` file.
+
+Populate this file with the following template and replace the values with your keys:
+
+```json
+{
+  "credentials": {
+    "fmp_api_key": "REPLACE_ME",
+    "polygon_api_key": "REPLACE_ME",
+    "benzinga_api_key": "REPLACE_ME",
+    "fred_api_key": "REPLACE_ME"
+  }
+}
+```
+

openbb_cli-1.0.0.dist-info/RECORD

@@ -0,0 +1,42 @@
+openbb_cli/__init__.py,sha256=gbA56dhVOj-ob23owhMfED0XZxasLQ5ODTdS-JhjU-w,19
+openbb_cli/argparse_translator/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+openbb_cli/argparse_translator/argparse_class_processor.py,sha256=oBwuRRuE_3BOgIjCvk7qLOTfdYawTZaM92pskihmlO8,4766
+openbb_cli/argparse_translator/argparse_translator.py,sha256=wYP6HblhDGFKL3cLeq2l7J3MpBBS2r5WkpUgVTmrlMU,23229
+openbb_cli/argparse_translator/obbject_registry.py,sha256=uRUEvHvaOpbdNVdMCyAeSAR2uxcYh0trFk05F5OwM_Q,3479
+openbb_cli/assets/routines/routine_example.openbb,sha256=jMfqAjkOGUEM9jM_oam5L34bUJ20ewXEwfOGOvcdmwE,439
+openbb_cli/assets/styles/default/Consolas.ttf,sha256=QjUEaVo94fgMYY4-bq0hWmuJG-BsF5vwSLtagNXQ7aM,358460
+openbb_cli/assets/styles/default/dark.mpfstyle.json,sha256=IRLxbC7vhKxQG7QD6dLA6eX_guMleMqDfjsAqd96ZmE,972
+openbb_cli/assets/styles/default/dark.mplrc.json,sha256=jRGp8oi4GRqX5hPq0smMfvvK1D20nS22TmcxMCLsMR4,182
+openbb_cli/assets/styles/default/dark.mplstyle,sha256=5BN172FVPH2t5zi_VEuYE7S8pLOvzGuSdlfc1iacn-8,2086
+openbb_cli/assets/styles/default/dark.pltstyle.json,sha256=2XnTlltoy3_6spvpIKO2DDc3UNwKwyEeCLQnLjBiTwc,3204
+openbb_cli/assets/styles/default/dark.richstyle.json,sha256=pi8mFD_gJqewF5jiMG9JGh3cEQ-m8H33TYx6-AZjt4c,203
+openbb_cli/assets/styles/default/light.mpfstyle.json,sha256=AsXkl-zVew8BSKWGnzQYkdsbXkFpid7LmC47M9RQquw,970
+openbb_cli/assets/styles/default/light.mplrc.json,sha256=lFoF47KM9tiNBDmLOA4v4aOASJH1Rd7_0chd9J58jL8,182
+openbb_cli/assets/styles/default/light.mplstyle,sha256=QgppXlJ8lRtnmBeihS99Jylt0oVLQiWOn18fdwVoVeQ,2035
+openbb_cli/assets/styles/default/light.pltstyle.json,sha256=O0DPZejsKA0_ZcivNabJZ_D08YuLJifmstwVvvGiQfE,23603
+openbb_cli/assets/styles/default/light.richstyle.json,sha256=vkWoYglghPWQoIOZmYJVJ12CTBwb54ovZMIZKHZE-N0,202
+openbb_cli/assets/styles/default/tables.pltstyle.json,sha256=cDDUmyyou4y9gFss-GsG6zeGa2QGXr60DiKz0ZgGInU,2505
+openbb_cli/assets/styles/user/openbb.richstyle.json,sha256=xJfzMfeHfTCYiI_NtXKn1Bz8ksekM9_Vl3rF0ldUJ3s,186
+openbb_cli/cli.py,sha256=sf7DuuVdHl-20edvY7K1POwjnWIwqy3WOClCdhEIx2Y,377
+openbb_cli/config/__init__.py,sha256=olw5X5u70moAHx2YwXhCvNhWnekM6q6OuLtBejTEH34,24
+openbb_cli/config/completer.py,sha256=ixPhmaSBJEBlfAZbKYzTONXLTzrxVPALKUqU3VR5pLk,17847
+openbb_cli/config/console.py,sha256=E0YYw4TcYuxYlI9oDH4gQye3uh_GvoJOkDy0TAbWsC8,3020
+openbb_cli/config/constants.py,sha256=yy4dGF2m57LKyWDHTvLXGzEMwFMQFPBWSy7CJRgpUlk,1811
+openbb_cli/config/menu_text.py,sha256=xdU7Popo0ytiau5fR2Jd5ziCJWY65_RUDmmoFZHx98E,5434
+openbb_cli/config/setup.py,sha256=wDGMZXY1RCt90R8eO_yymuCiHKoHlLPEPu9_-hJc0UM,319
+openbb_cli/config/style.py,sha256=dYf2BKEs5L4l0uK2NlxGaCvO1mR_BsnmnhW5p9epqh4,3537
+openbb_cli/controllers/base_controller.py,sha256=3NsDK_ywpY9gxUqOCjGkbo2mek5JNlvrF3LkPC3DbGk,35379
+openbb_cli/controllers/base_platform_controller.py,sha256=TpAG6lVzl0nGZBZBVwwS5vvZ1xBvnRuntParXOWiLaQ,13687
+openbb_cli/controllers/choices.py,sha256=CthHbhRdCF7vewGloNoWSsV8ABFL-8WQM9IY33SloRQ,9697
+openbb_cli/controllers/cli_controller.py,sha256=HclwM1suQNE-V3T_rqGjLaEQ2Tt6CpvoyZM50YQjVxg,34231
+openbb_cli/controllers/hub_service.py,sha256=IMVYaBSWoaZTTpHtdsiR7N8dV7RG9m6WbzkmZzmYNGs,3364
+openbb_cli/controllers/platform_controller_factory.py,sha256=BK6C2dN6U4txTt9cKitg9fC2710nZL2mtcjyIHYLfIk,2098
+openbb_cli/controllers/script_parser.py,sha256=CVZRhBW-Si-tbN55xg4K81xy-YQ0fivHQ_AtdlZpGps,20452
+openbb_cli/controllers/settings_controller.py,sha256=xgCWialksocP2eO-vsHshuRZe5S6KZp0ogfaASXxzpQ,12776
+openbb_cli/controllers/utils.py,sha256=lu_LWHCpQ_QRN9D4AvJirbJYKVO3YHzeO7RiduB-Pqc,31575
+openbb_cli/models/settings.py,sha256=ejWbQhhMr8Pgm-TX8-hm-M89BM7QB_HLGfmp0Y6bii4,2116
+openbb_cli/session.py,sha256=G3QzuNSzsuhTt-e5b1hJVjpotABMqqBsWVa65wFRZTE,2762
+openbb_cli-1.0.0.dist-info/METADATA,sha256=sCERav_LZc--hizAGJC0FJOpBAoKfMI_SUHelEHr1i8,3634
+openbb_cli-1.0.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+openbb_cli-1.0.0.dist-info/entry_points.txt,sha256=gDLcvTaYkUWnl_IVdJrE5WRY-fm4FXWcrYw9tZb5RJc,46
+openbb_cli-1.0.0.dist-info/RECORD,,

openbb_cli-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.0
+Root-Is-Purelib: true
+Tag: py3-none-any

openbb_cli-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+openbb=openbb_cli.cli:main
+