[Release] 4.2.2

.codespell.ignore

@@ -44,3 +44,4 @@ wew
 yeld
 zar
 zlot
+bootup

.codespell.skip

@@ -14,3 +14,5 @@
 ./build/pyinstaller
 ./website/config.toml
 ./**/node_modules
+./frontend-components/**
+./website/content/terminal/reference/crypto/onchain/**

.github/workflows/general-linting.yml

@@ -45,8 +45,8 @@ jobs:
         if: github.event_name == 'pull_request'
         run: |
           # "Checking PR diff"
-          echo "platform_files=$(git diff --diff-filter=d --name-only origin/${{ github.base_ref }}...${{ github.head_ref }} | grep 'openbb_platform/.*\.py$' | grep -v 'openbb_platform/openbb/package' | grep -v 'integration' | grep -v 'tests' | xargs)" >> $GITHUB_ENV
-          echo $platform_files
+          echo "diff_files=$(git diff --diff-filter=d --name-only origin/${{ github.base_ref }}...${{ github.head_ref }} | grep 'openbb_platform/.*\.py$|cli/.*\.py$' | grep -v 'openbb_platform/openbb/package' | grep -v 'integration' | grep -v 'tests' | xargs)" >> $GITHUB_ENV
+          echo $diff_files
 
       - uses: actions/cache@v3
         with:
@@ -58,16 +58,17 @@ jobs:
           pip install openbb-devtools
           pip install types-pytz types-requests types-termcolor types-tabulate types-PyYAML types-python-dateutil types-setuptools types-six
       - run: bandit -x ./tests -r . || true
-      - run: black --diff --check .
       - run: codespell --ignore-words=.codespell.ignore --skip="$(tr '\n' ',' < .codespell.skip | sed 's/,$//')" --quiet-level=2
-      - run: ruff .
       - run: |
-          # Run linters for openbb_platform
-          if [ -n "${{ env.platform_files }}" ]; then
-            pylint ${{ env.platform_files }}
-            pydocstyle ${{ env.platform_files }}
+          # Run linters for openbb_platform | cli
+          if [ -n "${{ env.diff_files }}" ]; then
+            black --diff --check ${{ env.diff_files }}
+            mypy ${{ env.diff_files }}  --ignore-missing-imports  --scripts-are-modules --check-untyped-defs
+            pydocstyle ${{ env.diff_files }}
+            pylint ${{ env.diff_files }}
+            ruff check ${{ env.diff_files }}
           else
-            echo "No Python files changed in openbb_platform"
+            echo "No Python files changed in openbb_platform | cli"
           fi
 
   markdown-link-check:

.pre-commit-config.yaml

@@ -14,7 +14,7 @@ repos:
     hooks:
       - id: black
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "v0.4.4"
+    rev: "v0.4.5"
     hooks:
       - id: ruff
   - repo: https://github.com/pycqa/pydocstyle

README.md

@@ -61,7 +61,7 @@ There are three main ways of contributing to this project. (Hopefully you have s
 
 ### Become a Contributor
 
-* More information on our [Contributing Documentation](https://docs.openbb.co/platform/development/contributing).
+* More information on our [Contributing Documentation](https://docs.openbb.co/platform/developer_guide/contributing).
 
 ### Create a GitHub ticket
 

assets/extensions/provider.json

@@ -67,7 +67,7 @@
         "packageName": "openbb-federal-reserve",
         "optional": false,
         "reprName": "Federal Reserve (FED)",
-        "description": "Access data provided by the Federal Reserve System,\nthe Central Bank of the United States.",
+        "description": "Access data provided by the Federal Reserve System, the Central Bank of the United States.",
         "credentials": [],
         "website": "https://www.federalreserve.gov/data.htm"
     },
@@ -155,9 +155,9 @@
         "packageName": "openbb-oecd",
         "optional": false,
         "reprName": "Organization for Economic Co-operation and Development (OECD)",
-        "description": "OECD.Stat includes data and metadata for OECD countries and selected\nnon-member economies.",
+        "description": "OECD Data Explorer includes data and metadata for OECD countries and selected\nnon-member economies.",
         "credentials": [],
-        "website": "https://stats.oecd.org"
+        "website": "https://data-explorer.oecd.org/"
     },
     {
         "packageName": "openbb-polygon",

build/pypi/openbb_platform/PUBLISH.md

@@ -24,20 +24,21 @@
     > For a single package release, the following steps are optional since the package can be bumped manually.
 
     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`
+    2. For the extension packages run: `python build/pypi/openbb_platform/publish.py --extensions`
     3. For the `openbb` package - **which requires manual publishing** - do the following
-         1. Bump the dependency package versions
+        3.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`
+        3.2. Run `pip install -e .` from `openbb_platform`
+        3.3. 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.4. Run unit tests to validate the existence of deprecated endpoints
+        3.5. Run `poetry publish --build` from `openbb_platform`
+        3.6. 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:

build/pypi/openbb_platform/publish.py

@@ -68,7 +68,7 @@ def publish(dry_run: bool = False, core: bool = False, extensions: bool = False)
     for sub_path in package_paths:
         is_extension = sub_path in EXTENSION_PACKAGES
 
-        for path in PLATFORM_PATH.rglob(f"{sub_path}/**/pyproject.toml"):
+        for path in sorted(PLATFORM_PATH.rglob(f"{sub_path}/**/pyproject.toml")):
             try:
                 # Update dependencies
                 if is_extension and "devtools" not in str(path):

cli/openbb_cli/argparse_translator/argparse_argument.py

@@ -0,0 +1,63 @@
+"""Pydantic models for argparse arguments and argument groups."""
+
+from typing import (
+    Any,
+    List,
+    Literal,
+    Optional,
+    Tuple,
+)
+
+from pydantic import BaseModel, model_validator
+
+SEP = "__"
+
+
+class ArgparseArgumentModel(BaseModel):
+    """Pydantic model for an argparse argument."""
+
+    name: str
+    type: Any
+    dest: str
+    default: Any
+    required: bool
+    action: Literal["store_true", "store"]
+    help: Optional[str]
+    nargs: Optional[Literal["+"]]
+    choices: Optional[Tuple]
+
+    @model_validator(mode="after")  # type: ignore
+    @classmethod
+    def validate_action(cls, values: "ArgparseArgumentModel"):
+        """Validate the action based on the type."""
+        if values.type is bool and values.action != "store_true":
+            raise ValueError('If type is bool, action must be "store_true"')
+        return values
+
+    @model_validator(mode="after")  # type: ignore
+    @classmethod
+    def remove_props_on_store_true(cls, values: "ArgparseArgumentModel"):
+        """Remove type, nargs, and choices if action is store_true."""
+        if values.action == "store_true":
+            values.type = None
+            values.nargs = None
+            values.choices = None
+        return values
+
+    # override
+    def model_dump(self, **kwargs):
+        """Override the model_dump method to remove empty choices."""
+        res = super().model_dump(**kwargs)
+
+        # Check if choices is present and if it's an empty tuple remove it
+        if "choices" in res and not res["choices"]:
+            del res["choices"]
+
+        return res
+
+
+class ArgparseArgumentGroupModel(BaseModel):
+    """Pydantic model for a custom argument group."""
+
+    name: str
+    arguments: List[ArgparseArgumentModel]

cli/openbb_cli/argparse_translator/argparse_class_processor.py

@@ -1,19 +1,19 @@
+"""Module for the ArgparseClassProcessor class."""
+
 import inspect
 from typing import Any, Dict, Optional, Type
 
 # TODO: this needs to be done differently
 from openbb_core.app.static.container import Container
 
-from openbb_cli.argparse_translator.argparse_translator import (
-    ArgparseTranslator,
-    ReferenceToCustomArgumentsProcessor,
+from openbb_cli.argparse_translator.argparse_translator import ArgparseTranslator
+from openbb_cli.argparse_translator.reference_processor import (
+    ReferenceToArgumentsProcessor,
 )
 
 
 class ArgparseClassProcessor:
-    """
-    Process a target class to create ArgparseTranslators for its methods.
-    """
+    """Process a target class to create ArgparseTranslators for its methods."""
 
     # reference variable used to create custom groups for the ArgpaseTranslators
     _reference: Dict[str, Any] = {}
@@ -77,7 +77,7 @@ def _custom_groups_from_reference(cls, class_name: str, function_name: str) -> D
         reference = {route: cls._reference[route]} if route in cls._reference else {}
         if not reference:
             return {}
-        rp = ReferenceToCustomArgumentsProcessor(reference)
+        rp = ReferenceToArgumentsProcessor(reference)
         return rp.custom_groups.get(route, {})  # type: ignore
 
     @classmethod