openbb-cli 1.0.4__tar.gz → 1.1.1__tar.gz

{openbb_cli-1.0.4 → openbb_cli-1.1.1}/PKG-INFO

@@ -1,30 +1,32 @@
 Metadata-Version: 2.1
 Name: openbb-cli
-Version: 1.0.4
+Version: 1.1.1
 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
+Requires-Python: >=3.9,<3.13
 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.3,<5.0.0)
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: openbb[all] (>=4.3.1,<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: pywry (>=0.6.2,<0.7.0)
 Requires-Dist: rich (>=13,<14)
-Project-URL: Documentation, https://docs.openbb.co/terminal
-Project-URL: Repository, https://github.com/OpenBB-finance/OpenBBTerminal
+Project-URL: Documentation, https://docs.openbb.co/cli
+Project-URL: Repository, https://github.com/OpenBB-finance/OpenBB
 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)
+[![LatestRelease](https://badge.fury.io/py/openbb.svg)](https://github.com/OpenBB-finance/OpenBB)
 
 | OpenBB is committed to build the future of investment research by focusing on an open source infrastructure accessible to everyone, everywhere. |
 | :---------------------------------------------------------------------------------------------------------------------------------------------: |
@@ -57,7 +59,7 @@ openbb
 
 Which should result in the following output:
 
-![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/48914296/f606bb6e-fa00-4fc8-bad2-8269bb4fc38e)
+![image](https://github.com/OpenBB-finance/OpenBB/assets/48914296/f606bb6e-fa00-4fc8-bad2-8269bb4fc38e)
 
 ## API keys
 

{openbb_cli-1.0.4 → openbb_cli-1.1.1}/README.md

@@ -1,7 +1,7 @@
 # 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)
+[![LatestRelease](https://badge.fury.io/py/openbb.svg)](https://github.com/OpenBB-finance/OpenBB)
 
 | OpenBB is committed to build the future of investment research by focusing on an open source infrastructure accessible to everyone, everywhere. |
 | :---------------------------------------------------------------------------------------------------------------------------------------------: |
@@ -34,7 +34,7 @@ openbb
 
 Which should result in the following output:
 
-![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/48914296/f606bb6e-fa00-4fc8-bad2-8269bb4fc38e)
+![image](https://github.com/OpenBB-finance/OpenBB/assets/48914296/f606bb6e-fa00-4fc8-bad2-8269bb4fc38e)
 
 ## API keys
 

{openbb_cli-1.0.4 → openbb_cli-1.1.1}/openbb_cli/argparse_translator/argparse_translator.py

@@ -400,22 +400,23 @@ class ArgparseTranslator:
         """
         kwargs = self._unflatten_args(vars(parsed_args))
         kwargs = self._update_with_custom_types(kwargs)
-
         provider = kwargs.get("provider")
-        provider_args = []
+        provider_args: List = []
         if provider and provider in self.provider_parameters:
             provider_args = self.provider_parameters[provider]
         else:
             for args in self.provider_parameters.values():
                 provider_args.extend(args)
 
-        # remove kwargs that doesn't match the signature or provider parameters
+        # remove kwargs not matching the signature, provider parameters, or are empty.
         kwargs = {
             key: value
             for key, value in kwargs.items()
-            if key in self.signature.parameters or key in provider_args
+            if (
+                (key in self.signature.parameters or key in provider_args)
+                and (value or value is False)
+            )
         }
-
         return self.func(**kwargs)
 
     def parse_args_and_execute(self) -> Any:
@@ -426,6 +427,7 @@ class ArgparseTranslator:
             Any: The return value of the original function.
         """
         parsed_args = self._parser.parse_args()
+
         return self.execute_func(parsed_args)
 
     def translate(self) -> Callable:

{openbb_cli-1.0.4 → openbb_cli-1.1.1}/openbb_cli/config/menu_text.py

@@ -79,8 +79,8 @@ class MenuText:
                 self.warnings.append(
                     {
                         "warning": "Command name too long",
-                        "command": name,
-                        "trimmed_command": new_name,
+                        "actual command": f"`{name}`",
+                        "displayed command": f"`{new_name}`",
                     }
                 )
                 name = new_name

{openbb_cli-1.0.4 → openbb_cli-1.1.1}/openbb_cli/controllers/base_controller.py

@@ -8,7 +8,7 @@ import shlex
 from abc import ABCMeta, abstractmethod
 from datetime import datetime
 from pathlib import Path
-from typing import Any, Dict, List, Literal, Optional, Union
+from typing import Any, Dict, List, Literal, Optional, Tuple, Union
 
 import pandas as pd
 from openbb_cli.config.completer import NestedCompleter
@@ -19,7 +19,9 @@ from openbb_cli.controllers.utils import (
     check_file_type_saved,
     check_positive,
     get_flair_and_username,
+    handle_obbject_display,
     parse_and_split_input,
+    parse_unknown_args_to_dict,
     print_guest_block_msg,
     print_rich_table,
     remove_file,
@@ -373,7 +375,7 @@ class BaseController(metaclass=ABCMeta):
         if other_args and "-" not in other_args[0][0]:
             other_args.insert(0, "-n")
 
-        ns_parser = self.parse_simple_args(parser, other_args)
+        ns_parser, _ = self.parse_simple_args(parser, other_args)
 
         if ns_parser:
             if not ns_parser.name:
@@ -472,7 +474,7 @@ class BaseController(metaclass=ABCMeta):
             description="Stop recording session into .openbb routine file",
         )
         # This is only for auto-completion purposes
-        _ = self.parse_simple_args(parser, other_args)
+        _, _ = self.parse_simple_args(parser, other_args)
 
         if "-h" not in other_args and "--help" not in other_args:
             global RECORD_SESSION  # noqa: PLW0603
@@ -603,7 +605,7 @@ class BaseController(metaclass=ABCMeta):
             prog="whoami",
             description="Show current user",
         )
-        ns_parser = self.parse_simple_args(parser, other_args)
+        ns_parser, _ = self.parse_simple_args(parser, other_args)
 
         if ns_parser:
             current_user = session.user
@@ -635,11 +637,27 @@ class BaseController(metaclass=ABCMeta):
             "--chart", action="store_true", dest="chart", help="Display chart."
         )
         parser.add_argument(
-            "--export", dest="export", help="Export data.", nargs="+", default=None
+            "--export",
+            default="",
+            type=check_file_type_saved(["csv", "json", "xlsx", "png", "jpg"]),
+            dest="export",
+            help="Export raw data into csv, json, xlsx and figure into png or jpg.",
+            nargs="+",
+        )
+        parser.add_argument(
+            "--sheet-name",
+            dest="sheet_name",
+            default=None,
+            nargs="+",
+            help="Name of excel sheet to save data to. Only valid for .xlsx files.",
+        )
+
+        ns_parser, unknown_args = self.parse_simple_args(
+            parser, other_args, unknown_args=True
         )
 
-        ns_parser = self.parse_simple_args(parser, other_args)
         if ns_parser:
+            kwargs = parse_unknown_args_to_dict(unknown_args)
             if not ns_parser.index and not ns_parser.key:
                 results = session.obbject_registry.all
                 if results:
@@ -657,21 +675,13 @@ class BaseController(metaclass=ABCMeta):
                     index = int(ns_parser.index)
                     obbject = session.obbject_registry.get(index)
                     if obbject:
-                        if ns_parser.chart and obbject.chart:
-                            obbject.show()
-                        else:
-                            title = obbject.extra.get("command", "")
-                            df = obbject.to_dataframe()
-                            print_rich_table(
-                                df=df,
-                                show_index=True,
-                                title=title,
-                                export=ns_parser.export,
-                            )
-                            if ns_parser.chart and not obbject.chart:
-                                session.console.print(
-                                    "[info]No chart available.[/info]"
-                                )
+                        handle_obbject_display(
+                            obbject=obbject,
+                            chart=ns_parser.chart,
+                            export=ns_parser.export,
+                            sheet_name=ns_parser.sheet_name,
+                            **kwargs,
+                        )
                     else:
                         session.console.print(
                             f"[info]No result found at index {index}.[/info]"
@@ -683,26 +693,24 @@ class BaseController(metaclass=ABCMeta):
             elif ns_parser.key:
                 obbject = session.obbject_registry.get(ns_parser.key)
                 if obbject:
-                    if ns_parser.chart and obbject.chart:
-                        obbject.show()
-                    else:
-                        title = obbject.extra.get("command", "")
-                        df = obbject.to_dataframe()
-                        print_rich_table(
-                            df=df,
-                            show_index=True,
-                            title=title,
-                            export=ns_parser.export,
-                        )
-                        if ns_parser.chart and not obbject.chart:
-                            session.console.print("[info]No chart available.[/info]")
+                    handle_obbject_display(
+                        obbject=obbject,
+                        chart=ns_parser.chart,
+                        export=ns_parser.export,
+                        sheet_name=ns_parser.sheet_name,
+                        **kwargs,
+                    )
                 else:
                     session.console.print(
                         f"[info]No result found with key '{ns_parser.key}'.[/info]"
                     )
 
     @staticmethod
-    def parse_simple_args(parser: argparse.ArgumentParser, other_args: List[str]):
+    def parse_simple_args(
+        parser: argparse.ArgumentParser,
+        other_args: List[str],
+        unknown_args: bool = False,
+    ) -> Tuple[Optional[argparse.Namespace], Optional[List[str]]]:
         """Parse list of arguments into the supplied parser.
 
         Parameters
@@ -711,11 +719,15 @@ class BaseController(metaclass=ABCMeta):
             Parser with predefined arguments
         other_args: List[str]
             List of arguments to parse
+        unknown_args: bool
+            Flag to indicate if unknown arguments should be returned
 
         Returns
         -------
-        ns_parser:
+        ns_parser: argparse.Namespace
             Namespace with parsed arguments
+        l_unknown_args: List[str]
+            List of unknown arguments
         """
         parser.add_argument(
             "-h", "--help", action="store_true", help="show this help message"
@@ -729,19 +741,18 @@ class BaseController(metaclass=ABCMeta):
         except SystemExit:
             # In case the command has required argument that isn't specified
             session.console.print("\n")
-            return None
+            return None, None
 
         if ns_parser.help:
             txt_help = parser.format_help()
             session.console.print(f"[help]{txt_help}[/help]")
-            return None
+            return None, None
 
-        if l_unknown_args:
+        if l_unknown_args and not unknown_args:
             session.console.print(
                 f"The following args couldn't be interpreted: {l_unknown_args}\n"
             )
-
-        return ns_parser
+        return ns_parser, l_unknown_args
 
     @classmethod
     def parse_known_args_and_warn(

{openbb_cli-1.0.4 → openbb_cli-1.1.1}/openbb_cli/controllers/base_platform_controller.py

@@ -232,6 +232,8 @@ class PlatformController(BaseController):
                                 fig = obbject.chart.fig if obbject.chart else None
                                 if not export:
                                     obbject.show()
+                            elif session.settings.USE_INTERACTIVE_DF and not export:
+                                obbject.charting.table()
                             else:
                                 if isinstance(df.columns, pd.RangeIndex):
                                     df.columns = [str(i) for i in df.columns]
@@ -379,9 +381,7 @@ class PlatformController(BaseController):
 
         session.console.print(text=mt.menu_text, menu=self.PATH)
 
-        settings = session.settings
-        dev_mode = settings.DEBUG_MODE or settings.TEST_MODE
-        if mt.warnings and dev_mode:
+        if mt.warnings:
             session.console.print("")
             for w in mt.warnings:
                 w_str = str(w).replace("{", "").replace("}", "").replace("'", "")

{openbb_cli-1.0.4 → openbb_cli-1.1.1}/openbb_cli/controllers/choices.py

@@ -4,7 +4,7 @@ from argparse import SUPPRESS, ArgumentParser
 from contextlib import contextmanager
 from inspect import isfunction, unwrap
 from types import MethodType
-from typing import Callable, List, Literal
+from typing import Callable, List, Literal, Tuple
 from unittest.mock import patch
 
 from openbb_cli.controllers.utils import (
@@ -110,7 +110,7 @@ def __mock_parse_known_args_and_warn(
     )
 
 
-def __mock_parse_simple_args(parser: ArgumentParser, other_args: List[str]) -> None:
+def __mock_parse_simple_args(parser: ArgumentParser, other_args: List[str]) -> Tuple:
     """Add arguments.
 
     Add the arguments that would have normally added by:
@@ -127,6 +127,7 @@ def __mock_parse_simple_args(parser: ArgumentParser, other_args: List[str]) -> N
         "-h", "--help", action="store_true", help="show this help message"
     )
     _ = other_args
+    return None, None
 
 
 def __get_command_func(controller, command: str):
@@ -216,7 +217,7 @@ def __patch_controller_functions(controller):
             target=controller,
             attribute="parse_simple_args",
             side_effect=__mock_parse_simple_args,
-            return_value=None,
+            return_value=(None, None),
         ),
         patch.object(
             target=controller,

{openbb_cli-1.0.4 → openbb_cli-1.1.1}/openbb_cli/controllers/cli_controller.py

@@ -205,10 +205,11 @@ class CLIController(BaseController):
             choices["results"] = {
                 "--help": None,
                 "-h": "--help",
-                "--export": None,
+                "--export": {c: None for c in ["csv", "json", "xlsx", "png", "jpg"]},
                 "--index": None,
                 "--key": None,
                 "--chart": None,
+                "--sheet_name": None,
             }
 
             self.update_completer(choices)

{openbb_cli-1.0.4 → openbb_cli-1.1.1}/openbb_cli/controllers/settings_controller.py

@@ -80,7 +80,7 @@ class SettingsController(BaseController):
                 description=field["description"],
                 add_help=False,
             )
-            ns_parser = self.parse_simple_args(parser, other_args)
+            ns_parser, _ = self.parse_simple_args(parser, other_args)
             if ns_parser:
                 session.settings.set_item(
                     field_name, not getattr(session.settings, field_name)
@@ -113,7 +113,7 @@ class SettingsController(BaseController):
                 type=type_,  # type: ignore[arg-type]
                 choices=choices,
             )
-            ns_parser = self.parse_simple_args(parser, other_args)
+            ns_parser, _ = self.parse_simple_args(parser, other_args)
             if ns_parser:
                 if ns_parser.value:
                     # Console style is applied immediately

{openbb_cli-1.0.4 → openbb_cli-1.1.1}/openbb_cli/controllers/utils.py

@@ -16,11 +16,9 @@ from typing import TYPE_CHECKING, Dict, List, Optional, Tuple, Union
 import numpy as np
 import pandas as pd
 import requests
-from openbb import obb
-from openbb_charting.core.backend import create_backend, get_backend
 from openbb_cli.config.constants import AVAILABLE_FLAIRS, ENV_FILE_SETTINGS
 from openbb_cli.session import Session
-from openbb_core.app.model.charts.charting_settings import ChartingSettings
+from openbb_core.app.model.obbject import OBBject
 from pytz import all_timezones, timezone
 from rich.table import Table
 
@@ -302,20 +300,6 @@ def return_colored_value(value: str):
     return f"{value}"
 
 
-def _get_backend():
-    """Get the Platform charting backend."""
-    try:
-        return get_backend()
-    except ValueError:
-        # backend might not be created yet
-        charting_settings = ChartingSettings(
-            system_settings=obb.system, user_settings=obb.user  # type: ignore
-        )
-        create_backend(charting_settings)
-        get_backend().start(debug=charting_settings.debug_mode)
-        return get_backend()
-
-
 # pylint: disable=too-many-arguments
 def print_rich_table(  # noqa: PLR0912
     df: pd.DataFrame,
@@ -384,7 +368,7 @@ def print_rich_table(  # noqa: PLR0912
                 isinstance(df[col].iloc[x], pd.Timestamp)
                 for x in range(min(10, len(df)))
             ):
-                df[col] = pd.to_numeric(df[col], errors="ignore")
+                df[col] = df[col].apply(pd.to_numeric)
         except (ValueError, TypeError):
             df[col] = df[col].astype(str)
 
@@ -395,7 +379,7 @@ def print_rich_table(  # noqa: PLR0912
             output = list(_headers)
         if len(output) != len(df.columns):
             raise ValueError("Length of headers does not match length of DataFrame.")
-        return output
+        return output  # type: ignore
 
     if session.settings.USE_INTERACTIVE_DF:
         df_outgoing = df.copy()
@@ -413,10 +397,7 @@ def print_rich_table(  # noqa: PLR0912
             if col == "":
                 df_outgoing = df_outgoing.rename(columns={col: "  "})
 
-        # ensure everything on the dataframe is a string
-        df_outgoing = df_outgoing.applymap(str)
-
-        _get_backend().send_table(
+        session._backend.send_table(  # type: ignore  # pylint: disable=protected-access
             df_table=df_outgoing,
             title=title,
             theme=session.user.preferences.table_style,
@@ -974,3 +955,78 @@ def request(
         timeout=timeout,
         **kwargs,
     )
+
+
+def parse_unknown_args_to_dict(unknown_args: Optional[List[str]]) -> Dict[str, str]:
+    """Parse unknown arguments to a dictionary."""
+    unknown_args_dict = {}
+    if unknown_args:
+        for idx, arg in enumerate(unknown_args):
+            if arg.startswith("--"):
+                if idx + 1 < len(unknown_args):
+                    try:
+                        unknown_args_dict[arg.replace("--", "")] = (
+                            eval(  # noqa: S307, E501 pylint: disable=eval-used
+                                unknown_args[idx + 1]
+                            )
+                        )
+                    except Exception:
+                        unknown_args_dict[arg] = unknown_args[idx + 1]
+                else:
+                    session.console.print(
+                        f"Missing value for argument {arg}. Skipping this argument."
+                    )
+    return unknown_args_dict
+
+
+def handle_obbject_display(
+    obbject: OBBject,
+    chart: bool = False,
+    export: str = "",
+    sheet_name: str = "",
+    **kwargs,
+):
+    """Handle the display of an OBBject."""
+    df: pd.DataFrame = pd.DataFrame()
+    fig: Optional[OpenBBFigure] = None
+    if chart:
+        try:
+            if obbject.chart:
+                obbject.show(**kwargs)
+            else:
+                obbject.charting.to_chart(**kwargs)  # type: ignore
+            if export:
+                fig = obbject.chart.fig  # type: ignore
+                df = obbject.to_dataframe()
+        except Exception as e:
+            session.console.print(f"Failed to display chart: {e}")
+    elif session.settings.USE_INTERACTIVE_DF:
+        obbject.charting.table()  # type: ignore
+    else:
+        df = obbject.to_dataframe()
+        print_rich_table(
+            df=df,
+            show_index=True,
+            title=obbject.extra.get("command", ""),
+            export=bool(export),
+        )
+    if export and not df.empty:
+        if sheet_name and isinstance(sheet_name, list):
+            sheet_name = sheet_name[0]
+
+        func_name = (
+            obbject.extra.get("command", "")
+            .replace("/", "_")
+            .replace(" ", "_")
+            .replace("--", "_")
+        )
+        export_data(
+            export_type=",".join(export),
+            dir_path=os.path.dirname(os.path.abspath(__file__)),
+            func_name=func_name,
+            df=df,
+            sheet_name=sheet_name,
+            figure=fig,
+        )
+    elif export and df.empty:
+        session.console.print("[yellow]No data to export.[/yellow]")

{openbb_cli-1.0.4 → openbb_cli-1.1.1}/openbb_cli/session.py

@@ -5,7 +5,9 @@ from pathlib import Path
 from typing import Optional
 
 from openbb import obb
+from openbb_charting.core.backend import create_backend, get_backend
 from openbb_core.app.model.abstract.singleton import SingletonMeta
+from openbb_core.app.model.charts.charting_settings import ChartingSettings
 from openbb_core.app.model.user_settings import UserSettings as User
 from prompt_toolkit import PromptSession
 
@@ -17,11 +19,26 @@ from openbb_cli.config.style import Style
 from openbb_cli.models.settings import Settings
 
 
+def _get_backend():
+    """Get the Platform charting backend."""
+    try:
+        return get_backend()
+    except ValueError:
+        # backend might not be created yet
+        charting_settings = ChartingSettings(
+            system_settings=obb.system, user_settings=obb.user  # type: ignore
+        )
+        create_backend(charting_settings)
+        get_backend().start(debug=charting_settings.debug_mode)  # type: ignore
+        return get_backend()
+
+
 class Session(metaclass=SingletonMeta):
     """Session class."""
 
     def __init__(self):
         """Initialize session."""
+
         self._obb = obb
         self._settings = Settings()
         self._style = Style(
@@ -34,6 +51,8 @@ class Session(metaclass=SingletonMeta):
         self._prompt_session = self._get_prompt_session()
         self._obbject_registry = Registry()
 
+        self._backend = _get_backend()
+
     @property
     def user(self) -> User:
         """Get platform user."""

{openbb_cli-1.0.4 → openbb_cli-1.1.1}/pyproject.toml

@@ -1,30 +1,31 @@
 [tool.poetry]
 name = "openbb-cli"
-version = "1.0.4"
+version = "1.1.1"
 description = "Investment Research for Everyone, Anywhere."
 authors = ["OpenBB <hello@openbb.co>"]
 packages = [{ include = "openbb_cli" }]
 license = "AGPL-3.0-only"
 readme = "README.md"
 homepage = "https://openbb.co"
-repository = "https://github.com/OpenBB-finance/OpenBBTerminal"
-documentation = "https://docs.openbb.co/terminal"
+repository = "https://github.com/OpenBB-finance/OpenBB"
+documentation = "https://docs.openbb.co/cli"
 
 [tool.poetry.scripts]
 openbb = 'openbb_cli.cli:main'
 
 [tool.poetry.dependencies]
-python = "^3.8.1,<3.12"
+python = "^3.9,<3.13"
 
 # OpenBB dependencies
-openbb = { version = "^4.2.3", extras = ["all"] }
+openbb = { version = "^4.3.1", extras = ["all"] }
 
 # CLI dependencies
 prompt-toolkit = "^3.0.16"
 rich = "^13"
 python-dotenv = "^1.0.0"
 openpyxl = "^3.1.2"
+pywry = "^0.6.2"
 
 [build-system]
-requires = ["setuptools<65.5.0", "poetry-core>=1.0.0"]
+requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"