[Feature] OpenBB Platform CLI

.github/PULL_REQUEST_TEMPLATE/terminal_pull_request_template.md

@@ -1,4 +1,4 @@
-# Pull Request the OpenBBTerminal
+# Pull Request the OpenBB Platform CLI
 
 ## Description
 
@@ -14,8 +14,8 @@
 - Please provide instructions so we can reproduce.
 - Please also list any relevant details for your test configuration.
 
-- [ ] Ensure the affected commands still execute in the OpenBB Terminal.
-- [ ] Ensure the Platform (previously named SDK) is working as intended.
+- [ ] Ensure the affected commands still execute in the OpenBB Platform CLI.
+- [ ] Ensure the Platform is working as intended.
 - [ ] Check any related reports.
 
 ## Checklist

.github/pull_request_template.md

@@ -3,5 +3,5 @@
 Please go the the `Preview` tab and select the appropriate PR sub-template:
 
 * [OpenBB Platform](?expand=1&template=platform_pull_request_template.md)
-* [OpenBB Terminal](?expand=1&template=terminal_pull_request_template.md)
+* [OpenBB Platform CLI](?expand=1&template=terminal_pull_request_template.md)
 * [OpenBB Developers](?expand=1&template=obb_developer_pull_request_template.md)

.github/workflows/README.md

@@ -115,7 +115,7 @@ The first job, `code-linting`, runs on an Ubuntu machine and performs several li
 The second job, `markdown-link-check`, runs on an Ubuntu machine and performs linting of the markdown files in the repository. It uses a Docker container `avtodev/markdown-lint` to perform the linting.
 
 ## MacOS Build Workflow
-This GitHub Actions workflow is used to build a version of the OpenBB Terminal for M1 MacOS. The build process includes installing necessary dependencies, building the terminal application using PyInstaller, creating a DMG file for distribution, and running integration tests on the built application.
+This GitHub Actions workflow is used to build a version of the OpenBB Platform CLI for M1 MacOS. The build process includes installing necessary dependencies, building the terminal application using PyInstaller, creating a DMG file for distribution, and running integration tests on the built application.
 
 Jobs
 ----
@@ -161,13 +161,13 @@ The job includes the following steps:
 This workflow also uses a concurrency setting that groups the jobs by the workflow and ref, and cancels any in-progress jobs.
 
 ## Nightly PyPI Publish Workflow
-This workflow is used to publish the latest version of the OpenBB Terminal to PyPI. The workflow is triggered at UTC+0 daily by the GitHub Action schedule event.
+This workflow is used to publish the latest version of the OpenBB Platform CLI to PyPI. The workflow is triggered at UTC+0 daily by the GitHub Action schedule event.
 
 It does this by first updating the `pyproject.toml` file with a pre-determined version string of the form `<currentVersion>.dev<date>`, where `<date>` represents the current day's date as a 8 digit number.
 
 Then, the code installs `pypa/build` and uses `python -m build` to create a binary wheel and a source tarball in the `dist/` directory.
 
-Finally, it uses the PyPA specific action `gh-action-pypi-publish` to publish the created files to PyPI. 
+Finally, it uses the PyPA specific action `gh-action-pypi-publish` to publish the created files to PyPI.
 
 ## PYPI publish Workflow
 The Github Action code `Deploy to PyPI` is used to deploy a Python project to PyPI (Python Package Index) and TestPyPI, which is a separate package index for testing purposes. The code is triggered on two events:
@@ -187,7 +187,7 @@ Similarly, the `deploy-pypi` job is triggered only if the pushed branch starts w
 Note: The code uses the `pypa/build` package for building the binary wheel and source tarball, and the `pypa/gh-action-pypi-publish@release/v1` Github Action for publishing the distributions to PyPI and TestPyPI.
 
 ## Unit Tests Workflow
-This workflow is used to run unit tests on the OpenBB Terminal. The workflow is triggered on the following events:
+This workflow is used to run unit tests on the OpenBB Platform CLI. The workflow is triggered on the following events:
 The events this workflow will respond to are:
 
 1.  Pull requests that are opened, synchronized, edited, or closed. The pull request must be made to the `develop` or `main` branches.
@@ -207,7 +207,7 @@ The next job, `full-test`, uses the GitHub Actions `checkout` action to checkout
 The last job, `tests-conda`, sets up a Miniconda environment using the `setup-miniconda` action. The environment is specified using a YAML file and is activated. Then, the tests are run.
 
 ## Windows 10 Build Workflow
-This is a GitHub Actions workflow file that automates the build and testing process for the OpenBB Terminal on Windows 10. The workflow consists of two jobs:
+This is a GitHub Actions workflow file that automates the build and testing process for the OpenBB Platform CLI on Windows 10. The workflow consists of two jobs:
 
 1.  Windows-Build
 2.  Build-Exe

CONTRIBUTING.md

@@ -115,7 +115,7 @@ from openbb_terminal.helpers import request
 
 logger = logging.getLogger(__name__)
 
-@log_start_end(log=logger)
+
 @check_api_key(["API_KEY_FINANCIALMODELINGPREP"])
 def get_price_targets(cls, symbol: str) -> pd.DataFrame:
     """Get price targets for a company [Source: Financial Modeling Prep]
@@ -178,7 +178,7 @@ In the example below, you can see that we explicitly handle some of them.
 It's not always possible to distinguish error types using `status_code`. So depending on the API provider, you can use either error messages or exceptions.
 
 ```python
-@log_start_end(log=logger)
+
 @check_api_key(["API_NEWS_TOKEN"])
 def get_news(
     query: str,
@@ -240,7 +240,7 @@ should be included in the file `OpenBBTerminal/website/content/terminal/usage/da
 7. Finally, call `export_data` where the variables are export variable, current filename, command name, and dataframe.
 
 ```python
-@log_start_end(log=logger)
+
 @check_api_key(["API_KEY_FINANCIALMODELINGPREP"])
 def display_price_targets(
     symbol: str, limit: int = 10, export: str = "", sheet_name: Optional[str] = None
@@ -350,7 +350,7 @@ Same with limit, we can pass limit=10 to add the `-l` flag with default=10.  Her
 Our new function will be:
 
 ```python
-   @log_start_end(log=logger)
+
     def call_pt(self, other_args: List[str]):
         """Process pt command"""
         parser = argparse.ArgumentParser(
@@ -437,7 +437,7 @@ Now from the terminal, this function can be run as desired:
 When adding a new menu, the code looks like this:
 
 ```python
-@log_start_end(log=logger)
+
 def call_fa(self, _):
     """Process fa command"""
     from openbb_terminal.stocks.fundamental_analysis.fa_controller import (
@@ -1580,11 +1580,11 @@ You can also use the decorator `@log_start_end` to automatically record a messag
 ```python
 import logging
 
-from openbb_terminal.decorators import log_start_end
+
 
 logger = logging.getLogger(__name__)
 
-@log_start_end(log=logger)
+
 def your_function() -> pd.DataFrame:
     pass
 ```