OpenBB Platform v4

.coveragerc

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

.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-list=vai,mis,gard,commun,parana,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,fo,nwe --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: ruff .
       - run: mypy --ignore-missing-imports openbb_terminal
       - run: pylint terminal.py openbb_terminal tests

.github/workflows/sdkv4-core.yml

@@ -0,0 +1,43 @@
+name: Test SDKV4
+
+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_sdk/poetry.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Run tests
+        run: |
+          pip install nox
+          nox -s tests --python ${{ matrix.python_version }}

.gitignore

@@ -1,5 +1,4 @@
 __pycache__/
-logs/
 *.pyc
 .DS_Store
 *.env
@@ -13,6 +12,8 @@ venv/
 !notebooks/jupyter/.gitkeep
 .python-version
 .mypy_cache
+.ruff_cache
+.pytest_cache
 iframe_figures/
 exports/*
 .idea
@@ -46,13 +47,16 @@ openbb_terminal/core/plots/assets/plotly*.js
 **/node_modules/*
 # pyinstaller artifacts
 *.pyo
-dist/*
+**/dist/*
 build/terminal
 build/nsis/app
 DMG/*
 *.dmg
 *.sh
 
+# User settings for the SDK
+user_settings.json
+
 # User stylesheets
 openbb_terminal/miscellaneous/styles/user/hub.richstyle.json
 
@@ -71,3 +75,10 @@ cache/
 
 # lightning logs
 lightning_logs/
+
+# user script to install all extensions and providers
+openbb_sdk/sdk/core/tests/app/model/charts/test_chart_settings.py
+*/mocked_path
+
+# CA certificates
+*.pem

.pre-commit-config.yaml

@@ -17,14 +17,25 @@ repos:
     rev: "v0.0.285"
     hooks:
       - id: ruff
+  - repo: https://github.com/pycqa/pydocstyle
+    rev: 6.3.0
+    hooks:
+      - id: pydocstyle
+        name: pydocstyle
+        entry: pydocstyle
+        language: python
+        types: [python]
+        files: '^openbb_sdk/.*\.py$'
+        exclude: 'tests/.*\.py|openbb_sdk/test_.*\.py'
+        args: ["--config=pyproject.toml"]
   - repo: https://github.com/codespell-project/codespell
     rev: v2.2.5
     hooks:
       - id: codespell
         entry: codespell
         args:
           [
-            "--ignore-words-list=VAI,MIS,shs,gard,te,commun,ro,zar,vie,hel,jewl,zlot,ba,buil,coo,ether,hist,hsi,mape,navagation,operatio,pres,ser,yeld,shold,ist,varian,datas,ake,creat,statics,ket,toke,certi,buidl,ot",
+            "--ignore-words-list=VAI,MIS,shs,gard,te,commun,parana,ro,zar,vie,hel,jewl,zlot,ba,buil,coo,ether,hist,hsi,mape,navagation,operatio,pres,ser,yeld,shold,ist,varian,datas,ake,creat,statics,ket,toke,certi,buidl,ot",
             "--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",
@@ -49,7 +60,7 @@ repos:
     hooks:
       - id: pylint
         name: pylint
-        entry: pylint openbb_terminal terminal.py tests -j 0
+        entry: pylint
         language: system
         types: [python]
   - repo: https://github.com/Yelp/detect-secrets
@@ -61,17 +72,14 @@ repos:
             "--baseline",
             ".secrets.baseline",
             "--exclude-files",
-            "cassettes/*",
-            "--exclude-files",
-            "record/*",
-            "--exclude-files",
-            "website/content/api/*",
+            "cassettes/.*|record/.*|website/content/api/.*|openbb_sdk/extensions/charting/openbb_charting/infrastructure/assets/.*\\.js|openbb_sdk/extensions/charting/openbb_charting/infrastructure/.*\\.html",
           ]
-        exclude: package.lock.json
+    exclude: package.lock.json
   - repo: local
     hooks:
       - id: reserved_args
         name: Check validity of reserved arguments
         entry: python custom_pre_commit/check_reserved_args.py
         language: system
         types: [python]
+        files: .*_controller\.py$

.pylintrc

@@ -388,7 +388,7 @@ max-returns=9
 max-statements=120
 
 # Minimum number of public methods for a class (see R0903).
-min-public-methods=1
+min-public-methods=0
 
 
 [EXCEPTIONS]

CONTRIBUTING.md

@@ -13,7 +13,8 @@ Use your best judgment, and feel free to propose changes to this document in a p
     - [Data sources](#data-sources)
     - [View](#view)
     - [Controller](#controller)
-    - [Add SDK endpoint](#add-sdk-endpoint)
+    - [Add SDK endpoint (V3)](#add-sdk-endpoint-v3)
+    - [Add SDK endpoint (V4)](#add-sdk-endpoint-v4)
     - [Add Unit Tests](#add-unit-tests)
     - [Open a Pull Request](#open-a-pull-request)
     - [Review Process](#review-process)
@@ -452,7 +453,7 @@ The **import only occurs inside this menu call**, this is so that the loading ti
 
 In addition, note the `self.load_class` which allows to not create a new `FundamentalAnalysisController` instance but re-load the previous created one. Unless the arguments `self.ticker`, `self.start` or `self.stock` have changed since. The `self.queue` list of commands is passed around as it contains the commands that the terminal must perform.
 
-### Add SDK endpoint
+### Add SDK endpoint (V3)
 
 In order to add a command to the SDK, follow these steps:
 
@@ -508,6 +509,10 @@ In order to add a command to the SDK, follow these steps:
     python generate_sdk.py sort
     ```
 
+### Add SDK endpoint (V4)
+
+Refer to the documentation [here](openbb_sdk\CONTRIBUTING.md).
+
 ### Add Unit Tests
 
 This is a vital part of the contribution process. We have a set of unit tests that are run on every Pull Request. These tests are located in the `tests` folder.

build/docker/api.dockerfile

@@ -0,0 +1,33 @@
+# ---- Base Python ----
+FROM python:3.10-slim-buster 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 \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
+
+# ---- Copy Files/Build ----
+FROM base AS builder
+
+WORKDIR /openbb
+
+COPY ./openbb_sdk ./openbb_sdk
+
+# Install the SDK
+RUN pip install /openbb/openbb_sdk
+
+# ---- 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/pyinstaller/hooks/hook-rich.py

@@ -1,3 +1,3 @@
-from PyInstaller.utils.hooks import copy_metadata, collect_data_files
+from PyInstaller.utils.hooks import collect_data_files, copy_metadata
 
 datas = copy_metadata("rich") + collect_data_files("rich")

noxfile.py

@@ -0,0 +1,16 @@
+import nox
+
+test_locations = [
+    "openbb_sdk/tests",
+    "openbb_sdk/sdk",
+    "openbb_sdk/providers",
+]
+
+
+@nox.session(python=["3.8", "3.9", "3.10", "3.11"])
+def tests(session):
+    session.install("poetry", "toml")
+    session.run("python", "./openbb_sdk/dev_install.py", "-e", "all", external=True)
+    session.install("pytest")
+    session.install("pytest-cov")
+    session.run("pytest", *test_locations, "--cov=openbb_sdk/")