Release/4.2.1

.devcontainer/devcontainer.json

@@ -0,0 +1,13 @@
+{
+    "name": "OpenBB Platform Dev Container",
+    "image": "mcr.microsoft.com/devcontainers/python:1-3.10-bookworm",
+    "postCreateCommand": "python3 -m venv obb && . obb/bin/activate && pip install poetry && python3 openbb_platform/dev_install.py --extras --cli",
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "ms-python.python",
+                "ms-python.vscode-pylance"
+            ]
+        }
+    }
+}

.gitignore

@@ -52,3 +52,6 @@ cli/openbb_cli/assets/styles/user/hub.richstyle.json
 
 # Platform
 openbb_platform/openbb/package/*
+
+# Dev Container env
+obb/*

.pre-commit-config.yaml

@@ -10,11 +10,11 @@ repos:
       - id: check-merge-conflict
       - id: detect-private-key
   - repo: https://github.com/psf/black
-    rev: 24.1.0
+    rev: 24.4.2
     hooks:
       - id: black
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "v0.0.285"
+    rev: "v0.4.4"
     hooks:
       - id: ruff
   - repo: https://github.com/pycqa/pydocstyle
@@ -26,7 +26,7 @@ repos:
         entry: pydocstyle
         language: python
         types: [python]
-        files: '^openbb_platform/.*\.py$'
+        files: '^(openbb_platform/|cli/).*\.py$'
         exclude: 'tests/.*\.py|openbb_platform/test_.*\.py'
         args: ["--config=ruff.toml"]
   - repo: https://github.com/codespell-project/codespell
@@ -41,7 +41,8 @@ repos:
             "--skip=./**/tests/**,./**/test_*.py,.git,*.css,*.csv,*.html,*.ini,*.ipynb,*.js,*.json,*.lock,*.scss,*.txt,*.yaml,build/pyinstaller/*,./website/config.toml",
             "-x=.github/workflows/general-linting.yml"
           ]
-  - repo: local
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: "v1.6.1"
     hooks:
       - id: mypy
         name: mypy
@@ -50,6 +51,7 @@ repos:
         language: python
         "types_or": [python, pyi]
         args: ["--ignore-missing-imports", "--scripts-are-modules", "--check-untyped-defs"]
+        additional_dependencies: ["types-requests", "types-setuptools"]
         require_serial: true
   - repo: https://github.com/kynan/nbstripout
     rev: 0.6.1

README.md

@@ -1,17 +1,3 @@
-## Announcement
-
-OpenBB Terminal v3.2.5 will be the last release made available.
-
-As we transition our focus to the OpenBB Platform, this repository will soon be rebranded as OpenBB-finance/OpenBBPlatform.
-
-However, we are committed to continuing our mission to democratize investment research by helping users and contributors with financial data integration and standardization.
-
-To achieve that, we are working on a new CLI tool built on top of the OpenBB Platform that will soon be available to everyone for free.
-
-[![GitHub release](https://img.shields.io/github/release/OpenBB-finance/OpenBBTerminal.svg?maxAge=3600)](https://github.com/OpenBB-finance/OpenBBTerminal/releases)
-
----
-
 <br />
 <img src="https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/images/platform-light.svg?raw=true#gh-light-mode-only" alt="OpenBB Terminal logo" width="600">
 <img src="https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/images/platform-dark.svg?raw=true#gh-dark-mode-only" alt="OpenBB Terminal logo" width="600">

build/docker/api.dockerfile

@@ -0,0 +1,47 @@
+# ---- Base Python ----
+    FROM python:3.11-slim-bullseye AS base
+
+    # set work directory
+    WORKDIR /openbb
+
+    # set environment variables
+    ENV PYTHONDONTWRITEBYTECODE 1
+    ENV PYTHONUNBUFFERED 1
+
+    # install dependencies
+    RUN apt-get update \
+        && apt-get install -y --no-install-recommends build-essential openssh-client curl \
+        && apt-get clean \
+        && rm -rf /var/lib/apt/lists/*
+
+    # install toml and poetry
+    RUN pip install toml poetry
+
+    # ---- Copy Files/Build ----
+    FROM base AS builder
+
+    WORKDIR /openbb
+
+    # install Rust
+    RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y \
+        && apt-get update \
+        && apt-get install -y --no-install-recommends libwebkit2gtk-4.0-dev \
+        && apt-get clean \
+        && rm -rf /var/lib/apt/lists/*
+
+    # add Rust to PATH
+    ENV PATH="/root/.cargo/bin:${PATH}"
+
+    COPY ./openbb_platform ./openbb_platform
+
+    # Install the SDK
+    RUN pip install /openbb/openbb_platform[all]
+    RUN pip install openbb-devtools
+
+    # ---- Copy Files ----
+    FROM base
+
+    COPY --from=builder /usr/local /usr/local
+
+    # Specify the command to run
+    CMD ["uvicorn", "openbb_core.api.rest_api:app", "--host", "0.0.0.0", "--port", "8000", "--reload"]

build/pypi/openbb_platform/PUBLISH.md

@@ -11,15 +11,6 @@
 2. Ensure all the CI workflows pass.
 3. Ensure all unit tests pass: `pytest openbb_platform -m "not integration"`
 4. Ensure all integration tests pass: `pytest openbb_platform -m integration`
-5. Run `python -c "import openbb; openbb.build()"` to build the static assets. Make sure that only required extensions are installed.
-
-    > **Note**: Run `python -c "import openbb"` after building the static to check that no additional static is being built.
-
-6. Finally, check if everything works:
-
-   1. Install the packages locally using `python openbb_platform/dev_install.py` command and test them in a new environment.
-   2. Check if all the `pyproject.toml` files are correct, including the `openbb_platform` one.
-   3. Double check if there is any new extension or provider that needs to be added to [integration tests GitHub Action workflow](/.github/workflows/platform-api-integration-test.yml).
 
 ## Release procedure
 
@@ -35,11 +26,18 @@
     1. For the core package run: `python build/pypi/openbb_platform/publish.py --core`
     2. For the extension and provider packages run: `python build/pypi/openbb_platform/publish.py --extensions`
     3. For the `openbb` package - **which requires manual publishing** - do the following
-         - Bump the dependency package versions
-         - Re-build the static assets that are bundled with the package
-         - Run unit tests to validate the existence of deprecated endpoints
-         - Run `poetry publish --build` from `openbb_platform`
-         - Run `poetry lock` from `openbb_platform`
+         1. Bump the dependency package versions
+
+        > [!WARNING]
+        > Create a new environment before proceeding.
+        > Make sure that only required extensions are installed
+
+         2. Re-build the static assets that are bundled with the package: `python -c "import openbb; openbb.build()"`
+            - Run `python -c "import openbb"` after building the static to check that no additional static is being built.
+            - Run any command to smoke test if the static assets are being built correctly.
+         3. Run unit tests to validate the existence of deprecated endpoints
+         4. Run `poetry publish --build` from `openbb_platform`
+         5. Run `poetry lock` from `openbb_platform`
 
     > [!TIP]
     > Note that, in order for packages to pick up the latest versions of dependencies, it is advised to clear the local cache of the dependencies:

cli/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

cli/openbb_cli/argparse_translator/argparse_class_processor.py

@@ -92,7 +92,6 @@ def _process_class(
             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,

cli/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 @@ def remove_props_on_store_true(cls, values: "CustomArgument"):
 
     # 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 @@ def _get_choices(self, type_: str, custom_choices: Any) -> Tuple:
     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

cli/openbb_cli/cli.py

@@ -2,12 +2,15 @@
 
 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."""
+    """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:]

cli/openbb_cli/controllers/base_controller.py

@@ -4,6 +4,7 @@
 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 @@ def switch(self, an_input: str) -> List[str]:
         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 @@ def 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",
@@ -798,11 +799,22 @@ def parse_known_args_and_warn(
             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 @@ def parse_known_args_and_warn(
                 "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:

cli/openbb_cli/controllers/base_platform_controller.py

@@ -158,7 +158,6 @@ def method(self, other_args: List[str], translator=translator):
                     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()

cli/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",

cli/openbb_cli/controllers/cli_controller.py

@@ -355,7 +355,7 @@ def call_exe(self, other_args: List[str]):
             "--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 @@ def call_exe(self, other_args: List[str]):
                 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