openbb-cli 1.0.0__py3-none-any.whl

openbb_cli/config/constants.py

@@ -0,0 +1,80 @@
+"""Constants module."""
+
+from pathlib import Path
+
+# Paths
+HOME_DIRECTORY = Path.home()
+REPOSITORY_DIRECTORY = Path(__file__).parent.parent.parent.parent
+SRC_DIRECTORY = Path(__file__).parent.parent
+SETTINGS_DIRECTORY = HOME_DIRECTORY / ".openbb_platform"
+ASSETS_DIRECTORY = SRC_DIRECTORY / "assets"
+STYLES_DIRECTORY = ASSETS_DIRECTORY / "styles"
+ENV_FILE_SETTINGS = SETTINGS_DIRECTORY / ".cli.env"
+HIST_FILE_PROMPT = SETTINGS_DIRECTORY / ".cli.his"
+
+
+DEFAULT_ROUTINES_URL = "https://openbb-cms.directus.app/items/Routines"
+TIMEOUT = 30
+CONNECTION_ERROR_MSG = "[red]Connection error.[/red]"
+CONNECTION_TIMEOUT_MSG = "[red]Connection timeout.[/red]"
+SCRIPT_TAGS = [
+    "stocks",
+    "crypto",
+    "etf",
+    "economy",
+    "forex",
+    "fixed income",
+    "alternative",
+    "funds",
+    "bonds",
+    "macro",
+    "mutual funds",
+    "equities",
+    "options",
+    "dark pool",
+    "shorts",
+    "insider",
+    "behavioral analysis",
+    "fundamental analysis",
+    "technical analysis",
+    "quantitative analysis",
+    "forecasting",
+    "government",
+    "comparison",
+    "nft",
+    "on chain",
+    "off chain",
+    "screener",
+    "report",
+    "overview",
+    "rates",
+    "econometrics",
+    "portfolio",
+    "real estate",
+]
+AVAILABLE_FLAIRS = {
+    ":openbb": "(🦋)",
+    ":bug": "(🐛)",
+    ":rocket": "(🚀)",
+    ":diamond": "(💎)",
+    ":stars": "(✨)",
+    ":baseball": "(⚾)",
+    ":boat": "(⛵)",
+    ":phone": "(☎)",
+    ":mercury": "(☿)",
+    ":hidden": "",
+    ":sun": "(☼)",
+    ":moon": "(🌕)",
+    ":nuke": "(☢)",
+    ":hazard": "(☣)",
+    ":tunder": "(☈)",
+    ":king": "(♔)",
+    ":queen": "(♕)",
+    ":knight": "(♘)",
+    ":recycle": "(♻)",
+    ":scales": "(⚖)",
+    ":ball": "(⚽)",
+    ":golf": "(⛳)",
+    ":peace": "(☮)",
+    ":yy": "(☯)",
+}

openbb_cli/config/menu_text.py

@@ -0,0 +1,165 @@
+"""Rich Module."""
+
+__docformat__ = "numpy"
+
+from typing import Dict, List
+
+from openbb import obb
+
+# https://rich.readthedocs.io/en/stable/appendix/colors.html#appendix-colors
+# https://rich.readthedocs.io/en/latest/highlighting.html#custom-highlighters
+
+
+RICH_TAGS = [
+    "[menu]",
+    "[/menu]",
+    "[cmds]",
+    "[/cmds]",
+    "[info]",
+    "[/info]",
+    "[param]",
+    "[/param]",
+    "[src]",
+    "[/src]",
+    "[help]",
+    "[/help]",
+]
+
+
+class MenuText:
+    """Create menu text with rich colors to be displayed by CLI."""
+
+    CMD_NAME_LENGTH = 23
+    CMD_DESCRIPTION_LENGTH = 65
+    CMD_PROVIDERS_LENGTH = 23
+    SECTION_SPACING = 4
+
+    def __init__(self, path: str = ""):
+        """Initialize menu help."""
+        self.menu_text = ""
+        self.menu_path = path
+        self.warnings: List[Dict[str, str]] = []
+
+    @staticmethod
+    def _get_providers(command_path: str) -> List:
+        """Return the preferred provider for the given command.
+
+        Parameters
+        ----------
+        command_path: str
+            The command to find the provider for. E.g. "/equity/price/historical
+
+        Returns
+        -------
+        List
+            The list of providers for the given command.
+        """
+        command_reference = obb.reference.get("paths", {}).get(command_path, {})  # type: ignore
+        if command_reference:
+            providers = list(command_reference["parameters"].keys())
+            return [provider for provider in providers if provider != "standard"]
+        return []
+
+    def _format_cmd_name(self, name: str) -> str:
+        """Truncate command name length if it is too long."""
+        if len(name) > self.CMD_NAME_LENGTH:
+            new_name = name[: self.CMD_NAME_LENGTH]
+
+            if "_" in name:
+                name_split = name.split("_")
+
+                new_name = (
+                    "_".join(name_split[:2]) if len(name_split) > 2 else name_split[0]
+                )
+
+                if len(new_name) > self.CMD_NAME_LENGTH:
+                    new_name = new_name[: self.CMD_NAME_LENGTH]
+
+            if new_name != name:
+                self.warnings.append(
+                    {
+                        "warning": "Command name too long",
+                        "command": name,
+                        "trimmed_command": new_name,
+                    }
+                )
+                name = new_name
+
+        return name
+
+    def _format_cmd_description(
+        self, name: str, description: str, trim: bool = True
+    ) -> str:
+        """Truncate command description length if it is too long."""
+        if not description or description == f"{self.menu_path}{name}":
+            description = ""
+        return (
+            description[: self.CMD_DESCRIPTION_LENGTH - 3] + "..."
+            if len(description) > self.CMD_DESCRIPTION_LENGTH and trim
+            else description
+        )
+
+    def add_raw(self, text: str, left_spacing: bool = False):
+        """Append raw text (without translation)."""
+        if left_spacing:
+            self.menu_text += f"{self.SECTION_SPACING * ' '}{text}\n"
+        else:
+            self.menu_text += text
+
+    def add_info(self, text: str):
+        """Append information text (after translation)."""
+        self.menu_text += f"[info]{text}:[/info]\n"
+
+    def add_cmd(self, name: str, description: str = "", disable: bool = False):
+        """Append command text (after translation)."""
+        formatted_name = self._format_cmd_name(name)
+        name_padding = (self.CMD_NAME_LENGTH - len(formatted_name)) * " "
+        providers = self._get_providers(f"{self.menu_path}{name}")
+        formatted_description = self._format_cmd_description(
+            formatted_name,
+            description,
+            bool(providers),
+        )
+        description_padding = (
+            self.CMD_DESCRIPTION_LENGTH - len(formatted_description)
+        ) * " "
+        spacing = self.SECTION_SPACING * " "
+        description_padding = (
+            self.CMD_DESCRIPTION_LENGTH - len(formatted_description)
+        ) * " "
+        cmd = f"{spacing}{formatted_name + name_padding}{spacing}{formatted_description+description_padding}"
+        cmd = f"[unvl]{cmd}[/unvl]" if disable else f"[cmds]{cmd}[/cmds]"
+
+        if providers:
+            cmd += rf"{spacing}[src]\[{', '.join(providers)}][/src]"
+
+        self.menu_text += cmd + "\n"
+
+    def add_menu(
+        self,
+        name: str,
+        description: str = "",
+        disable: bool = False,
+    ):
+        """Append menu text (after translation)."""
+        spacing = (self.CMD_NAME_LENGTH - len(name) + self.SECTION_SPACING) * " "
+
+        if not description or description == f"{self.menu_path}{name}":
+            description = ""
+
+        if len(description) > self.CMD_DESCRIPTION_LENGTH:
+            description = description[: self.CMD_DESCRIPTION_LENGTH - 3] + "..."
+
+        menu = f"{name}{spacing}{description}"
+        tag = "unvl" if disable else "menu"
+        self.menu_text += f"[{tag}]>   {menu}[/{tag}]\n"
+
+    def add_setting(self, name: str, status: bool = True, description: str = ""):
+        """Append menu text (after translation)."""
+        spacing = (self.CMD_NAME_LENGTH - len(name) + self.SECTION_SPACING) * " "
+        indentation = self.SECTION_SPACING * " "
+        color = "green" if status else "red"
+
+        self.menu_text += (
+            f"[{color}]{indentation}{name}{spacing}{description}[/{color}]\n"
+        )

openbb_cli/config/setup.py

@@ -0,0 +1,11 @@
+"""Configuration for the CLI."""
+
+from pathlib import Path
+
+from openbb_cli.config.constants import ENV_FILE_SETTINGS, SETTINGS_DIRECTORY
+
+
+def bootstrap():
+    """Setup pre-launch configurations for the CLI."""
+    SETTINGS_DIRECTORY.mkdir(parents=True, exist_ok=True)
+    Path(ENV_FILE_SETTINGS).touch(exist_ok=True)

openbb_cli/config/style.py

@@ -0,0 +1,108 @@
+"""Chart and style helpers for Plotly."""
+
+# pylint: disable=C0302,R0902,W3301
+import json
+from pathlib import Path
+from typing import Any, Dict, List, Optional
+
+from rich.console import Console
+
+from openbb_cli.config.constants import STYLES_DIRECTORY
+
+console = Console()
+
+
+class Style:
+    """The class that helps with handling of style configurations.
+
+    It serves styles for 2 libraries. For `Plotly` this class serves absolute paths
+    to the .pltstyle files. For `Plotly` and `Rich` this class serves custom
+    styles as python dictionaries.
+    """
+
+    STYLES_REPO = STYLES_DIRECTORY
+
+    console_styles_available: Dict[str, Path] = {}
+    console_style: Dict[str, Any] = {}
+
+    line_color: str = ""
+    up_color: str = ""
+    down_color: str = ""
+    up_colorway: List[str] = []
+    down_colorway: List[str] = []
+    up_color_transparent: str = ""
+    down_color_transparent: str = ""
+
+    line_width: float = 1.5
+
+    def __init__(
+        self,
+        style: Optional[str] = "",
+        directory: Optional[Path] = None,
+    ):
+        """Initialize the class."""
+        self._load(directory)
+        self.apply(style, directory)
+
+    def apply(
+        self, style: Optional[str] = None, directory: Optional[Path] = None
+    ) -> None:
+        """Apply the style to the console."""
+        if style:
+            if style in self.console_styles_available:
+                json_path: Optional[Path] = self.console_styles_available[style]
+            else:
+                self._load(directory)
+                if style in self.console_styles_available:
+                    json_path = self.console_styles_available[style]
+                else:
+                    console.print(f"\nInvalid console style '{style}', using default.")
+                    json_path = self.console_styles_available.get("dark", None)
+
+            if json_path:
+                self.console_style = self._from_json(json_path)
+            else:
+                console.print("Error loading default.")
+
+    def _from_directory(self, folder: Optional[Path]) -> None:
+        """Load custom styles from folder.
+
+        Parses the styles/default and styles/user folders and loads style files.
+        To be recognized files need to follow a naming convention:
+        *.pltstyle        - plotly stylesheets
+        *.richstyle.json  - rich stylesheets
+
+        Parameters
+        ----------
+        folder : str
+            Path to the folder containing the stylesheets
+        """
+        if not folder or not folder.exists():
+            return
+
+        for attr, ext in zip(
+            ["console_styles_available"],
+            [".richstyle.json"],
+        ):
+            for file in folder.rglob(f"*{ext}"):
+                getattr(self, attr)[file.name.replace(ext, "")] = file
+
+    def _load(self, directory: Optional[Path] = None) -> None:
+        """Load custom styles from default and user folders."""
+        self._from_directory(self.STYLES_REPO)
+        self._from_directory(directory)
+
+    def _from_json(self, file: Path) -> Dict[str, Any]:
+        """Load style from json file."""
+        with open(file) as f:
+            json_style: dict = json.load(f)
+            for key, value in json_style.items():
+                json_style[key] = value.replace(
+                    " ", ""
+                )  # remove whitespaces so Rich can parse it
+            return json_style
+
+    @property
+    def available_styles(self) -> List[str]:
+        """Return available styles."""
+        return list(self.console_styles_available.keys())