openbb-cli 1.0.0__tar.gz → 1.0.1__tar.gz

{openbb_cli-1.0.0 → openbb_cli-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openbb-cli
-Version: 1.0.0
+Version: 1.0.1
 Summary: Investment Research for Everyone, Anywhere.
 Home-page: https://openbb.co
 License: AGPL-3.0-only
@@ -12,7 +12,7 @@ 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: openbb[all] (>=4.2.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)
@@ -33,11 +33,11 @@ Description-Content-Type: text/markdown
 
 ## Overview
 
-The OpenBB CLI is a command line interface that wraps [OpenBB Platform](https://docs.openbb.co/platform).
+The OpenBB Platform 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).
+Find the most complete documentation, examples, and usage guides for the OpenBB Platform CLI [here](https://docs.openbb.co/cli).
 
 ## Installation
 
@@ -47,9 +47,9 @@ The command below provides access to the all the available OpenBB extensions beh
 pip install openbb-cli
 ```
 
-> Note: Find the most complete installation hints and tips [here](https://my.openbb.co/app/cli/installation).
+> Note: Find the most complete installation hints and tips [here](https://docs.openbb.co/cli/installation).
 
-After the installation is complete, you can deploy the OpenBB CLI by running the following command:
+After the installation is complete, you can deploy the OpenBB Platform CLI by running the following command:
 
 ```bash
 openbb

{openbb_cli-1.0.0 → openbb_cli-1.0.1}/README.md

@@ -10,11 +10,11 @@
 
 ## Overview
 
-The OpenBB CLI is a command line interface that wraps [OpenBB Platform](https://docs.openbb.co/platform).
+The OpenBB Platform 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).
+Find the most complete documentation, examples, and usage guides for the OpenBB Platform CLI [here](https://docs.openbb.co/cli).
 
 ## Installation
 
@@ -24,9 +24,9 @@ The command below provides access to the all the available OpenBB extensions beh
 pip install openbb-cli
 ```
 
-> Note: Find the most complete installation hints and tips [here](https://my.openbb.co/app/cli/installation).
+> Note: Find the most complete installation hints and tips [here](https://docs.openbb.co/cli/installation).
 
-After the installation is complete, you can deploy the OpenBB CLI by running the following command:
+After the installation is complete, you can deploy the OpenBB Platform CLI by running the following command:
 
 ```bash
 openbb

{openbb_cli-1.0.0 → openbb_cli-1.0.1}/openbb_cli/argparse_translator/argparse_class_processor.py

@@ -92,7 +92,6 @@ class ArgparseClassProcessor:
             if name.startswith("__") or name.startswith("_"):
                 continue
             if inspect.ismethod(member):
-
                 class_name = cls._get_class_name(target)
                 methods[f"{class_name}_{name}"] = ArgparseTranslator(
                     func=member,

{openbb_cli-1.0.0 → openbb_cli-1.0.1}/openbb_cli/argparse_translator/argparse_translator.py

@@ -33,7 +33,6 @@ class ArgparseActionType(Enum):
 
 
 class CustomArgument(BaseModel):
-
     name: str
     type: Optional[Any]
     dest: str
@@ -62,7 +61,6 @@ class CustomArgument(BaseModel):
 
     # override
     def model_dump(self, **kwargs):
-
         res = super().model_dump(**kwargs)
 
         # Check if choices is present and if it's an empty tuple remove it
@@ -152,7 +150,6 @@ class ReferenceToCustomArgumentsProcessor:
     def build_custom_groups(self):
         """Build the custom groups from the reference."""
         for route, v in self.reference.items():
-
             for provider, args in v["parameters"].items():
                 if provider == "standard":
                     continue

openbb_cli-1.0.1/openbb_cli/cli.py

@@ -0,0 +1,23 @@
+"""OpenBB Platform CLI entry point."""
+
+import sys
+
+
+def main():
+    """Use the main entry point for the OpenBB Platform CLI."""
+    print("Loading...\n")  # noqa: T201
+
+    # pylint: disable=import-outside-toplevel
+    from openbb_cli.config.setup import bootstrap
+    from openbb_cli.controllers.cli_controller import launch
+
+    bootstrap()
+
+    dev = "--dev" in sys.argv[1:]
+    debug = "--debug" in sys.argv[1:]
+
+    launch(dev, debug)
+
+
+if __name__ == "__main__":
+    main()

{openbb_cli-1.0.0 → openbb_cli-1.0.1}/openbb_cli/controllers/base_controller.py

@@ -4,6 +4,7 @@ import argparse
 import difflib
 import os
 import re
+import shlex
 from abc import ABCMeta, abstractmethod
 from datetime import datetime
 from pathlib import Path
@@ -240,7 +241,7 @@ class BaseController(metaclass=ABCMeta):
         else:
             try:
                 (known_args, other_args) = self.parser.parse_known_args(
-                    an_input.split()
+                    shlex.split(an_input)
                 )
             except Exception as exc:
                 raise SystemExit from exc
@@ -744,11 +745,11 @@ class BaseController(metaclass=ABCMeta):
                 choices_export = ["csv", "json", "xlsx"]
                 help_export = "Export raw data into csv, json, xlsx"
             elif export_allowed == "figures_only":
-                choices_export = ["png", "jpg", "pdf", "svg"]
-                help_export = "Export figure into png, jpg, pdf, svg "
+                choices_export = ["png", "jpg", "svg"]
+                help_export = "Export figure into png, jpg, svg "
             else:
-                choices_export = ["csv", "json", "xlsx", "png", "jpg", "pdf", "svg"]
-                help_export = "Export raw data into csv, json, xlsx and figure into png, jpg, pdf, svg "
+                choices_export = ["csv", "json", "xlsx", "png", "jpg", "svg"]
+                help_export = "Export raw data into csv, json, xlsx and figure into png, jpg, svg "
 
             parser.add_argument(
                 "--export",
@@ -798,11 +799,22 @@ class BaseController(metaclass=ABCMeta):
             return None
 
         try:
-            # If the user uses a comma separated list of arguments, split them
-            for index, arg in enumerate(other_args):
-                if "," in arg:
-                    parts = arg.split(",")
-                    other_args[index : index + 1] = parts
+            # Determine the index of the routine arguments
+            routine_args_index = next(
+                (
+                    i + 1
+                    for i, arg in enumerate(other_args)
+                    if arg in ("-i", "--input")
+                    and "routine_args" in [action.dest for action in parser._actions]
+                ),
+                -1,
+            )
+            # Split comma-separated arguments, except for the argument at routine_args_index
+            other_args = [
+                part
+                for index, arg in enumerate(other_args)
+                for part in (arg.split(",") if index != routine_args_index else [arg])
+            ]
 
             (ns_parser, l_unknown_args) = parser.parse_known_args(other_args)
 
@@ -811,7 +823,7 @@ class BaseController(metaclass=ABCMeta):
                 "raw_data_and_figures",
             ]:
                 ns_parser.is_image = any(
-                    ext in ns_parser.export for ext in ["png", "svg", "jpg", "pdf"]
+                    ext in ns_parser.export for ext in ["png", "svg", "jpg"]
                 )
 
         except SystemExit:

{openbb_cli-1.0.0 → openbb_cli-1.0.1}/openbb_cli/controllers/base_platform_controller.py

@@ -158,7 +158,6 @@ class PlatformController(BaseController):
                     title = f"{self.PATH}{translator.func.__name__}"
 
                     if obbject:
-
                         if isinstance(obbject, OBBject):
                             if session.max_obbjects_exceeded() and obbject.results:
                                 session.obbject_registry.remove()

{openbb_cli-1.0.0 → openbb_cli-1.0.1}/openbb_cli/controllers/choices.py

@@ -58,11 +58,13 @@ def __mock_parse_known_args_and_warn(
             choices_export = ["csv", "json", "xlsx"]
             help_export = "Export raw data into csv, json, xlsx"
         elif export_allowed == "figures_only":
-            choices_export = ["png", "jpg", "pdf", "svg"]
-            help_export = "Export figure into png, jpg, pdf, svg "
+            choices_export = ["png", "jpg", "svg"]
+            help_export = "Export figure into png, jpg, svg "
         else:
-            choices_export = ["csv", "json", "xlsx", "png", "jpg", "pdf", "svg"]
-            help_export = "Export raw data into csv, json, xlsx and figure into png, jpg, pdf, svg "
+            choices_export = ["csv", "json", "xlsx", "png", "jpg", "svg"]
+            help_export = (
+                "Export raw data into csv, json, xlsx and figure into png, jpg, svg "
+            )
 
         parser.add_argument(
             "--export",

{openbb_cli-1.0.0 → openbb_cli-1.0.1}/openbb_cli/controllers/cli_controller.py

@@ -355,7 +355,7 @@ class CLIController(BaseController):
             "--input",
             help="Select multiple inputs to be replaced in the routine and separated by commas. E.g. GME,AMC,BTC-USD",
             dest="routine_args",
-            type=lambda s: [str(item) for item in s.split(",")],
+            type=str,
         )
         parser.add_argument(
             "-e",
@@ -431,17 +431,22 @@ class CLIController(BaseController):
                 with open(routine_path) as fp:
                     raw_lines = list(fp)
 
+                script_inputs = []
                 # Capture ARGV either as list if args separated by commas or as single value
-                if ns_parser.routine_args:
-                    script_inputs = (
-                        ns_parser.routine_args
-                        if "," not in ns_parser.routine_args
-                        else ns_parser.routine_args.split(",")
+                if routine_args := ns_parser.routine_args:
+                    pattern = r"\[(.*?)\]"
+                    matches = re.findall(pattern, routine_args)
+
+                    for match in matches:
+                        routine_args = routine_args.replace(f"[{match}]", "")
+                        script_inputs.append(match)
+
+                    script_inputs.extend(
+                        [val for val in routine_args.split(",") if val]
                     )
 
                 err, parsed_script = parse_openbb_script(
-                    raw_lines=raw_lines,
-                    script_inputs=script_inputs if ns_parser.routine_args else None,
+                    raw_lines=raw_lines, script_inputs=script_inputs
                 )
 
                 # If there err output is not an empty string then it means there was an
@@ -546,7 +551,6 @@ def run_cli(jobs_cmds: Optional[List[str]] = None, test_mode=False):
         t_controller.print_help()
 
     while ret_code:
-
         # There is a command in the queue
         if t_controller.queue and len(t_controller.queue) > 0:
             # If the command is quitting the menu we want to return in here

{openbb_cli-1.0.0 → openbb_cli-1.0.1}/openbb_cli/controllers/utils.py

@@ -901,7 +901,7 @@ def export_data(
                 else:
                     save_to_excel(df, saved_path, sheet_name)
 
-            elif saved_path.suffix in [".jpg", ".pdf", ".png", ".svg"]:
+            elif saved_path.suffix in [".jpg", ".png", ".svg"]:
                 if figure is None:
                     Session().console.print("No plot to export.")
                     continue
@@ -910,7 +910,10 @@ def export_data(
                 Session().console.print("Wrong export file specified.")
                 continue
 
-            Session().console.print(f"Saved file: {saved_path}")
+            if saved_path.exists():
+                Session().console.print(f"Saved file: {saved_path}")
+            else:
+                Session().console.print(f"Failed to save file: {saved_path}")
 
         if figure is not None:
             figure._exported = True  # pylint: disable=protected-access

{openbb_cli-1.0.0 → openbb_cli-1.0.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openbb-cli"
-version = "1.0.0"
+version = "1.0.1"
 description = "Investment Research for Everyone, Anywhere."
 authors = ["OpenBB <hello@openbb.co>"]
 packages = [{ include = "openbb_cli" }]
@@ -17,17 +17,14 @@ openbb = 'openbb_cli.cli:main'
 python = "^3.8.1,<3.12"
 
 # OpenBB dependencies
-openbb = { version = "^4.2.0", extras = ["all"] }
+openbb = { version = "^4.2.1", extras = ["all"] }
 
-# Terminal dependencies
+# CLI dependencies
 prompt-toolkit = "^3.0.16"
 rich = "^13"
 python-dotenv = "^1.0.0"
 openpyxl = "^3.1.2"
 
-[tool.poetry.group.dev.dependencies]
-openbb-devtools = "^1.1.3"
-
 [build-system]
 requires = ["setuptools<65.5.0", "poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"

openbb_cli-1.0.0/openbb_cli/cli.py

@@ -1,20 +0,0 @@
-"""OpenBB Platform CLI entry point."""
-
-import sys
-
-from openbb_cli.config.setup import bootstrap
-from openbb_cli.controllers.cli_controller import launch
-
-
-def main():
-    """Use the main entry point for the OpenBB CLI."""
-    bootstrap()
-
-    dev = "--dev" in sys.argv[1:]
-    debug = "--debug" in sys.argv[1:]
-
-    launch(dev, debug)
-
-
-if __name__ == "__main__":
-    main()