OpenBB Platform v4

.codespell.ignore

@@ -0,0 +1,44 @@
+ake
+alle
+ba
+brin
+buda
+buidl
+buil
+certi
+commun
+coo
+creat
+datas
+ether
+fo
+gard
+hel
+hist
+hsi
+ist
+jewl
+ket
+mape
+mis
+navagation
+nd
+nwe
+operatio
+ot
+parana
+pres
+ro
+ser
+shold
+shs
+statics
+te
+toke
+vai
+varian
+vie
+welp
+yeld
+zar
+zlot

.codespell.skip

@@ -0,0 +1,16 @@
+./tests
+.git
+*.css
+*.csv
+*.html
+*.ini
+*.ipynb
+*.js
+*.json
+*.lock
+*.scss
+*.txt
+*.yaml
+./build/pyinstaller
+./website/config.toml
+./**/node_modules

.coveragerc

@@ -2,4 +2,6 @@
 omit =
     env/*
     tests/*
+    **/tests/**
+    **/package/**
 source = .

.github/pull_request_template.md

@@ -1,31 +1,80 @@
-# Description
+# Pull Request OpenBB
 
-- [ ] Summary of the change / bug fix.
+## The OpenBBTerminal
+
+<details>
+<summary> Pull Request for the OpenBBTerminal</summary>
+
+### Description
+
+- [ ] Summary of the change/ bug fix.
 - [ ] Link # issue, if applicable.
 - [ ] Screenshot of the feature or the bug before/after fix, if applicable.
 - [ ] Relevant motivation and context.
 - [ ] List any dependencies that are required for this change.
 
+### How has this been tested?
 
-# How has this been tested?
+- Please describe the tests that you ran to verify your changes.
+- Please provide instructions so we can reproduce.
+- Please also list any relevant details for your test configuration.
 
-* Please describe the tests that you ran to verify your changes.
-* Provide instructions so we can reproduce.
-* Please also list any relevant details for your test configuration.
-- [ ] Make sure affected commands still run in terminal
-- [ ] Ensure the SDK still works
-- [ ] Check any related reports
+- [ ] Ensure the affected commands still execute in the OpenBB Terminal.
+- [ ] Ensure the Platform (previously named SDK) is working as intended.
+- [ ] Check any related reports.
 
+### Checklist
 
-# Checklist:
-
+- [ ] I ensure I have self-reviewed my code.
+- [ ] I have commented/documented my code, particularly in hard-to-understand sections.
 - [ ] I have adhered to the GitFlow naming convention and my branch name is in the format of `feature/feature-name` or `hotfix/hotfix-name`.
 - [ ] Update [our documentation](https://openbb-finance.github.io/OpenBBTerminal/) following [these guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/website).  Update any user guides that are affected by the changes.
 - [ ] Update our tests following [these guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/tests).
 - [ ] Make sure you are following our [CONTRIBUTING guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/CONTRIBUTING.md).
 - [ ] If a feature was added make sure to add it to the corresponding [integration test script](https://github.com/OpenBB-finance/OpenBBTerminal/tree/develop/openbb_terminal/miscellaneous/integration_tests_scripts).
 
+</details>
+
+## The OpenBB Platform
+
+<details>
+<summary> Pull Request for the OpenBB Platform</summary>
+
+### Description
+
+- [ ] Summary of the change/ bug fix.
+- [ ] Link # issue, if applicable.
+- [ ] Screenshot of the feature or the bug before/after fix, if applicable.
+- [ ] Relevant motivation and context.
+- [ ] List any dependencies that are required for this change.
+
+### How has this been tested?
+
+- Please describe the tests that you ran to verify your changes.
+- Please provide instructions so we can reproduce.
+- Please also list any relevant details for your test configuration.
+
+- [ ] Ensure all unit and integration tests pass.
+- If you modified/added command(s):
+  - [ ] Ensure the command(s) execute with the expected output.
+    - [ ] API.
+    - [ ] Python Interface.
+  - [ ] If applicable, please add new tests for the command (see [CONTRIBUTING.md](/openbb_platform/CONTRIBUTING.md) to leverage semi-automated testing).
+- If a new provider was introduced or a new fetcher was added to an existing provider:
+  - [ ] Ensure the existing tests pass.
+  - [ ] Ensure the new provider and/or fetcher is stable and usable.
+  - [ ] If applicable, please add new tests for the provider and/or fetcher (see [CONTRIBUTING.md](/openbb_platform/CONTRIBUTING.md) to leverage semi-automated testing).
+- If a new provider or extension was added:
+  - [ ] Update the list of [Extensions](/openbb_platform/EXTENSIONS.md).
+  - [ ] Update the list of [Providers](/openbb_platform/PROVIDERS.md).
+  - [ ] If it's a community extension or provider, update the [integration tests GitHub Action workflow](/.github/workflows/platform-api-integration-test.yml).
+
+### Checklist
 
-# Others
 - [ ] I have performed a self-review of my own code.
 - [ ] I have commented my code, particularly in hard-to-understand areas.
+- [ ] I have adhered to the GitFlow naming convention and my branch name is in the format of `feature/feature-name` or `hotfix/hotfix-name`.
+- [ ] I ensure that I am following th [CONTRIBUTING guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/CONTRIBUTING.md).
+  - [ ] (If applicable) I have updated tests following [these guidelines](/openbb_platform/CONTRIBUTING.md#qa-your-extension).
+
+</details>

.github/workflows/linting.yml

@@ -12,9 +12,9 @@ on:
     types: [opened, synchronize, edited]
   push:
     branches:
-      - 'feature/*'
-      - 'hotfix/*'
-      - 'release/*'
+      - "feature/*"
+      - "hotfix/*"
+      - "release/*"
   merge_group:
     types: [checks_requested]
 
@@ -48,7 +48,7 @@ jobs:
           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-list=vai,mis,gard,commun,statics,ro,zar,zlot,jewl,ba,buil,coo,ether,hist,hsi,mape,navagation,operatio,pres,ser,yeld,shold,ist,varian,datas,ake,creat,vie,hel,ket,toke,certi,buidl,ot,te,buda,shs,welp --quiet-level=2 --skip=./tests,.git,*.css,*.csv,*.html,*.ini,*.ipynb,*.js,*.json,*.lock,*.scss,*.txt,*.yaml,./build/pyinstaller,./website/config.toml -x openbb_terminal/economy/fedreserve_model.py
+      - run: codespell --ignore-words=.codespell.ignore --skip="$(tr '\n' ',' < .codespell.skip | sed 's/,$//')" --quiet-level=2
       - run: ruff .
       - run: mypy --ignore-missing-imports openbb_terminal
       - run: pylint terminal.py openbb_terminal tests

.github/workflows/platform-api-integration-test.yml

@@ -50,26 +50,8 @@ jobs:
         run: |
           python -m venv runner_env
           source runner_env/bin/activate
-          pip install pytest poetry\
-            ./openbb_platform \
-            ./openbb_platform/providers/alpha_vantage \
-            ./openbb_platform/providers/cboe \
-            ./openbb_platform/providers/quandl \
-            ./openbb_platform/providers/fmp \
-            ./openbb_platform/providers/yfinance \
-            ./openbb_platform/providers/intrinio \
-            ./openbb_platform/extensions/futures \
-            ./openbb_platform/extensions/qa \
-            ./openbb_platform/extensions/ta \
-            ./openbb_platform/extensions/econometrics
-            pip uninstall -y openbb_core
-            pip uninstall -y openbb_provider
-            cd openbb_platform/platform/core
-            pip install -U .
-            cd ../provider/
-            pip install -U .
-            cd ../../../
-            pip install -U pydantic
+          pip install poetry toml
+          python openbb_platform/dev_install.py -e all
 
       - name: Populate System Setting Files
         run: |
@@ -83,12 +65,15 @@ jobs:
           touch ~/.openbb_platform/user_settings.json
           echo '{
             "credentials": {
-              "benzinga_api_key": ${{ secrets.BENZINGA_API_KEY }},
+              "benzinga_api_key": "${{ secrets.BENZINGA_API_KEY }}",
               "fmp_api_key": "${{ secrets.FMP_API_KEY }}",
               "polygon_api_key": "${{ secrets.POLYGON_API_KEY }}",
               "alpha_vantage_api_key": "${{ secrets.ALPHA_VANTAGE_API_KEY }}",
               "fred_api_key": "${{ secrets.FRED_API_KEY }}",
-              "intrinio_api_key": "${{ secrets.INTRINIO_API_KEY }}"
+              "intrinio_api_key": "${{ secrets.INTRINIO_API_KEY }}",
+              "tradingeconomics_api_key": "${{ secrets.TRADINGECONOMICS_API_KEY }}",
+              "quandl_api_key": "${{ secrets.QUANDL_API_KEY }}",
+              "biztoc_api_key": "${{ secrets.BIZTOC_API_KEY }}"
             }
           }' > ~/.openbb_platform/user_settings.json
 
@@ -98,8 +83,8 @@ jobs:
           pip list
           uvicorn openbb_core.api.rest_api:app --host 0.0.0.0 --port 8000 --reload &
 
-      - name: Wait for 10 seconds
-        run: sleep 10
+      - name: Wait for 42 seconds
+        run: sleep 42
 
       - name: Run API Integration Tests
         run: |

.github/workflows/platform-core.yml

@@ -0,0 +1,43 @@
+name: Test Platform V4
+
+on:
+  pull_request:
+    branches:
+      - feature/openbb-sdk-v4
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
+    cancel-in-progress: true
+
+jobs:
+  unit_tests:
+    runs-on: ubuntu-latest
+    strategy:
+        fail-fast: false
+        matrix:
+          python_version:
+            ["3.8", "3.9", "3.10", "3.11"]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
+      - name: Install Python ${{ matrix.python_version }}
+        uses: actions/setup-python@v4
+        with:
+            python-version: ${{ matrix.python_version }}
+            allow-prereleases: true
+            cache: "pip"
+
+      - name: Cache pip packages
+        uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('openbb_platform/poetry.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Run tests
+        run: |
+          pip install nox
+          nox -s tests --python ${{ matrix.python_version }}