openbb-cli 1.0.0__tar.gz

openbb_cli-1.0.0/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.1
+Name: openbb-cli
+Version: 1.0.0
+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
+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.0,<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: rich (>=13,<14)
+Project-URL: Documentation, https://docs.openbb.co/terminal
+Project-URL: Repository, https://github.com/OpenBB-finance/OpenBBTerminal
+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)
+
+| OpenBB is committed to build the future of investment research by focusing on an open source infrastructure accessible to everyone, everywhere. |
+| :---------------------------------------------------------------------------------------------------------------------------------------------: |
+|              ![OpenBBLogo](https://user-images.githubusercontent.com/25267873/218899768-1f0964b8-326c-4f35-af6f-ea0946ac970b.png)               |
+|                                                 Check our website at [openbb.co](www.openbb.co)                                                 |
+
+## Overview
+
+The OpenBB 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).
+
+## Installation
+
+The command below provides access to the all the available OpenBB extensions behind the OpenBB Platform, find the complete list [here](https://my.openbb.co/app/platform/extensions).
+
+```bash
+pip install openbb-cli
+```
+
+> Note: Find the most complete installation hints and tips [here](https://my.openbb.co/app/cli/installation).
+
+After the installation is complete, you can deploy the OpenBB CLI by running the following command:
+
+```bash
+openbb
+```
+
+Which should result in the following output:
+
+![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/48914296/f606bb6e-fa00-4fc8-bad2-8269bb4fc38e)
+
+## API keys
+
+To fully leverage the OpenBB Platform you need to get some API keys to connect with data providers. Here are the 3 options on where to set them:
+
+1. OpenBB Hub
+2. Local file
+
+### 1. OpenBB Hub
+
+Set your keys at [OpenBB Hub](https://my.openbb.co/app/platform/credentials) and get your personal access token from <https://my.openbb.co/app/platform/pat> to connect with your account.
+
+> Once you log in, on the Platform CLI (through the `/account` menu, all your credentials will be in sync with the OpenBB Hub.)
+
+### 2. Local file
+
+You can specify the keys directly in the `~/.openbb_platform/user_settings.json` file.
+
+Populate this file with the following template and replace the values with your keys:
+
+```json
+{
+  "credentials": {
+    "fmp_api_key": "REPLACE_ME",
+    "polygon_api_key": "REPLACE_ME",
+    "benzinga_api_key": "REPLACE_ME",
+    "fred_api_key": "REPLACE_ME"
+  }
+}
+```
+

openbb_cli-1.0.0/README.md

@@ -0,0 +1,67 @@
+# 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)
+
+| OpenBB is committed to build the future of investment research by focusing on an open source infrastructure accessible to everyone, everywhere. |
+| :---------------------------------------------------------------------------------------------------------------------------------------------: |
+|              ![OpenBBLogo](https://user-images.githubusercontent.com/25267873/218899768-1f0964b8-326c-4f35-af6f-ea0946ac970b.png)               |
+|                                                 Check our website at [openbb.co](www.openbb.co)                                                 |
+
+## Overview
+
+The OpenBB 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).
+
+## Installation
+
+The command below provides access to the all the available OpenBB extensions behind the OpenBB Platform, find the complete list [here](https://my.openbb.co/app/platform/extensions).
+
+```bash
+pip install openbb-cli
+```
+
+> Note: Find the most complete installation hints and tips [here](https://my.openbb.co/app/cli/installation).
+
+After the installation is complete, you can deploy the OpenBB CLI by running the following command:
+
+```bash
+openbb
+```
+
+Which should result in the following output:
+
+![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/48914296/f606bb6e-fa00-4fc8-bad2-8269bb4fc38e)
+
+## API keys
+
+To fully leverage the OpenBB Platform you need to get some API keys to connect with data providers. Here are the 3 options on where to set them:
+
+1. OpenBB Hub
+2. Local file
+
+### 1. OpenBB Hub
+
+Set your keys at [OpenBB Hub](https://my.openbb.co/app/platform/credentials) and get your personal access token from <https://my.openbb.co/app/platform/pat> to connect with your account.
+
+> Once you log in, on the Platform CLI (through the `/account` menu, all your credentials will be in sync with the OpenBB Hub.)
+
+### 2. Local file
+
+You can specify the keys directly in the `~/.openbb_platform/user_settings.json` file.
+
+Populate this file with the following template and replace the values with your keys:
+
+```json
+{
+  "credentials": {
+    "fmp_api_key": "REPLACE_ME",
+    "polygon_api_key": "REPLACE_ME",
+    "benzinga_api_key": "REPLACE_ME",
+    "fred_api_key": "REPLACE_ME"
+  }
+}
+```

openbb_cli-1.0.0/openbb_cli/__init__.py

@@ -0,0 +1 @@
+"""Package init"""

openbb_cli-1.0.0/openbb_cli/argparse_translator/argparse_class_processor.py

@@ -0,0 +1,148 @@
+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,
+)
+
+
+class ArgparseClassProcessor:
+    """
+    Process a target class to create ArgparseTranslators for its methods.
+    """
+
+    # reference variable used to create custom groups for the ArgpaseTranslators
+    _reference: Dict[str, Any] = {}
+
+    def __init__(
+        self,
+        target_class: Type,
+        add_help: bool = False,
+        reference: Optional[Dict[str, Any]] = None,
+    ):
+        """
+        Initialize the ArgparseClassProcessor.
+
+        Parameters
+        ----------
+        target_class : Type
+            The target class whose methods will be processed.
+        add_help : Optional[bool]
+            Whether to add help to the ArgparseTranslators.
+        """
+        self._target_class: Type = target_class
+        self._add_help: bool = add_help
+        self._translators: Dict[str, ArgparseTranslator] = {}
+        self._paths: Dict[str, str] = {}
+
+        ArgparseClassProcessor._reference = reference or {}
+
+        self._translators = self._process_class(
+            target=self._target_class, add_help=self._add_help
+        )
+        self._paths[self._get_class_name(self._target_class)] = "path"
+        self._build_paths(target=self._target_class)
+
+    @property
+    def translators(self) -> Dict[str, ArgparseTranslator]:
+        """
+        Get the ArgparseTranslators associated with the target class.
+
+        Returns
+        -------
+        Dict[str, ArgparseTranslator]
+            The ArgparseTranslators associated with the target class.
+        """
+        return self._translators
+
+    @property
+    def paths(self) -> Dict[str, str]:
+        """
+        Get the paths associated with the target class.
+
+        Returns
+        -------
+        Dict[str, str]
+            The paths associated with the target class.
+        """
+        return self._paths
+
+    @classmethod
+    def _custom_groups_from_reference(cls, class_name: str, function_name: str) -> Dict:
+        route = f"/{class_name.replace('_', '/')}/{function_name}"
+        reference = {route: cls._reference[route]} if route in cls._reference else {}
+        if not reference:
+            return {}
+        rp = ReferenceToCustomArgumentsProcessor(reference)
+        return rp.custom_groups.get(route, {})  # type: ignore
+
+    @classmethod
+    def _process_class(
+        cls,
+        target: type,
+        add_help: bool = False,
+    ) -> Dict[str, ArgparseTranslator]:
+        methods = {}
+
+        for name, member in inspect.getmembers(target):
+            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,
+                    add_help=add_help,
+                    custom_argument_groups=cls._custom_groups_from_reference(  # type: ignore
+                        class_name=class_name, function_name=name
+                    ),
+                )
+            elif isinstance(member, Container):
+                methods = {
+                    **methods,
+                    **cls._process_class(
+                        target=getattr(target, name), add_help=add_help
+                    ),
+                }
+
+        return methods
+
+    @staticmethod
+    def _get_class_name(target: type) -> str:
+        return (
+            str(type(target))
+            .rsplit(".", maxsplit=1)[-1]
+            .replace("'>", "")
+            .replace("ROUTER_", "")
+            .lower()
+        )
+
+    def get_translator(self, command: str) -> ArgparseTranslator:
+        """
+        Retrieve the ArgparseTranslator object associated with a specific menu and command.
+
+        Parameters
+        ----------
+        command : str
+            The command associated with the ArgparseTranslator.
+
+        Returns
+        -------
+        ArgparseTranslator
+            The ArgparseTranslator associated with the specified menu and command.
+        """
+        return self._translators[command]
+
+    def _build_paths(self, target: type, depth: int = 1):
+        for name, member in inspect.getmembers(target):
+            if name.startswith("__") or name.startswith("_"):
+                continue
+            if inspect.ismethod(member):
+                pass
+            elif isinstance(member, Container):
+                self._build_paths(target=getattr(target, name), depth=depth + 1)
+                self._paths[f"{name}"] = "sub" * depth + "path"