mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-04 08:22:26 +00:00
Merge
This commit is contained in:
Igor Radovanovic
123
.github/workflows/api-integration-test.yml
vendored
123
.github/workflows/api-integration-test.yml
vendored
@@ -1,123 +0,0 @@
|
||||
name: API Integration Tests
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- feature/openbb-sdk-v4
|
||||
workflow_dispatch:
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
api-integration-tests:
|
||||
runs-on: ubuntu-latest
|
||||
env:
|
||||
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
|
||||
|
||||
steps:
|
||||
- name: Slack Notification - Starting
|
||||
uses: act10ns/slack@v1
|
||||
with:
|
||||
status: starting
|
||||
channel: "#workflows"
|
||||
message: Starting API Integration Test...
|
||||
if: always()
|
||||
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Checkout specific ref
|
||||
if: github.event_name == 'pull_request'
|
||||
run: git fetch origin ${{ github.event.pull_request.head.ref }} && git checkout FETCH_HEAD
|
||||
|
||||
# - name: Setup Python 3.9
|
||||
# uses: actions/setup-python@v4
|
||||
# with:
|
||||
# python-version: "3.9"
|
||||
# architecture: x64
|
||||
|
||||
# - name: Install Poetry
|
||||
# uses: snok/install-poetry@v1
|
||||
# with:
|
||||
# version: 1.4.0
|
||||
# virtualenvs-create: true
|
||||
# virtualenvs-in-project: true
|
||||
|
||||
- name: Setup Conda
|
||||
run: |
|
||||
wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh
|
||||
bash miniconda.sh -b -p $HOME/miniconda
|
||||
echo "$HOME/miniconda/bin" >> $GITHUB_PATH
|
||||
|
||||
- name: Create and Activate Conda Environment
|
||||
run: |
|
||||
conda create -n obb-38 python=3.8 -y
|
||||
echo "conda activate obb-38" >> ~/.bashrc
|
||||
source ~/.bashrc
|
||||
|
||||
# - name: Configure Poetry
|
||||
# run: poetry config virtualenvs.in-project true
|
||||
|
||||
- name: Install Python Dependencies
|
||||
run: |
|
||||
pip install toml pytest uvicorn importlib-metadata requests
|
||||
|
||||
# - name: Load cached venv
|
||||
# id: cached-poetry-dependencies
|
||||
# uses: actions/cache@v3
|
||||
# with:
|
||||
# path: .venv
|
||||
# key: venv-${{ runner.os }}-v1-${{ hashFiles('**/poetry.lock', '**/dev_install.py') }}
|
||||
|
||||
- name: Install obb Dependencies
|
||||
run: |
|
||||
python ${{ github.workspace }}/openbb_platform/dev_install.py -e
|
||||
|
||||
- name: Populate System Setting Files
|
||||
run: |
|
||||
mkdir -p ${{ github.workspace }}/.openbb_platform
|
||||
touch ${{ github.workspace }}/.openbb_platform/system_settings.json
|
||||
echo '{"log_collect":false}' > ${{ github.workspace }}/.openbb_platform/system_settings.json
|
||||
|
||||
- name: Create and Populate user_settings.json from GitHub Secrets
|
||||
run: |
|
||||
touch ${{ github.workspace }}/.openbb_platform/user_settings.json
|
||||
echo '{
|
||||
"credentials": {
|
||||
"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 }}"
|
||||
}
|
||||
}' > ${{ github.workspace }}/.openbb_platform/user_settings.json
|
||||
|
||||
- name: Launch the Uvicorn Process
|
||||
run: |
|
||||
uvicorn openbb_core.api.rest_api:app --host 0.0.0.0 --port 8000 --reload &
|
||||
|
||||
- name: Wait for 1 minute
|
||||
run: sleep 60
|
||||
|
||||
- name: Run Integration Tests
|
||||
run: |
|
||||
pytest ${{ github.workspace }}/openbb_platform -m integration
|
||||
|
||||
# - name: Upload summary to Slack
|
||||
# uses: adrey/slack-file-upload-action@master
|
||||
# with:
|
||||
# token: ${{ secrets.SLACK_API_TOKEN }}
|
||||
# initial_comment: "API Integration test summary"
|
||||
# title: "Integration test summary"
|
||||
# path: summary.txt
|
||||
# channel: ${{ secrets.SLACK_CHANNEL_ID }}
|
||||
|
||||
# - name: Slack Notification - Success/Failure
|
||||
# uses: act10ns/slack@v1
|
||||
# with:
|
||||
# status: ${{ job.status }}
|
||||
# steps: ${{ toJson(steps) }}
|
||||
# channel: '#workflows'
|
||||
# if: always()
|
||||
102
.github/workflows/platform-api-integration-test.yml
vendored
Normal file
102
.github/workflows/platform-api-integration-test.yml
vendored
Normal file
@@ -0,0 +1,102 @@
|
||||
name: API Integration Tests
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- feature/openbb-sdk-v4
|
||||
workflow_dispatch:
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
api-integration-tests:
|
||||
runs-on: ubuntu-latest
|
||||
env:
|
||||
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
|
||||
|
||||
steps:
|
||||
- name: Slack Notification - Starting
|
||||
uses: act10ns/slack@v1
|
||||
with:
|
||||
status: starting
|
||||
channel: "#workflows"
|
||||
message: Starting API Integration Test...
|
||||
if: always()
|
||||
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Checkout specific ref
|
||||
if: github.event_name == 'pull_request'
|
||||
run: git fetch origin ${{ github.event.pull_request.head.ref }} && git checkout FETCH_HEAD
|
||||
|
||||
- name: Setup Python 3.9
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: "3.9"
|
||||
architecture: x64
|
||||
|
||||
- name: Load cached venv
|
||||
id: cached-python-environment
|
||||
uses: actions/cache@v3
|
||||
with:
|
||||
path: ${{ github.workspace }}/.venv
|
||||
key: venv-${{ runner.os }}-v1-${{ hashFiles('**/poetry.lock', '**/dev_install.py') }}
|
||||
|
||||
- name: Install Dependencies
|
||||
if: steps.cached-python-environment.outputs.cache-hit != 'true'
|
||||
run: |
|
||||
python -m pip install -U virtualenv pip
|
||||
python -m virtualenv ${{ github.workspace }}/.venv
|
||||
${{ github.workspace }}/.venv/bin/python -m pip install pytest \
|
||||
./openbb_platform
|
||||
# Add the extensions you want to test within this workflow here
|
||||
|
||||
- name: Populate System Setting Files
|
||||
run: |
|
||||
mkdir -p ${{ github.workspace }}/.openbb_platform
|
||||
touch ${{ github.workspace }}/.openbb_platform/system_settings.json
|
||||
echo '{"log_collect":false}' > ${{ github.workspace }}/.openbb_platform/system_settings.json
|
||||
|
||||
- name: Create and Populate user_settings.json from GitHub Secrets
|
||||
run: |
|
||||
touch ${{ github.workspace }}/.openbb_platform/user_settings.json
|
||||
echo '{
|
||||
"credentials": {
|
||||
"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 }}"
|
||||
}
|
||||
}' > ${{ github.workspace }}/.openbb_platform/user_settings.json
|
||||
|
||||
- name: Launch the Uvicorn Process
|
||||
run: |
|
||||
uvicorn openbb_core.api.rest_api:app --host 0.0.0.0 --port 8000 --reload &
|
||||
|
||||
- name: Wait for 1 minute
|
||||
run: sleep 60
|
||||
|
||||
- name: Run API Integration Tests
|
||||
run: |
|
||||
${{ github.workspace }}/.venv/bin/pytest ${{ github.workspace }}/openbb_platform -m integration
|
||||
|
||||
- name: Upload summary to Slack
|
||||
uses: adrey/slack-file-upload-action@master
|
||||
with:
|
||||
token: ${{ secrets.SLACK_API_TOKEN }}
|
||||
initial_comment: "API Integration test summary"
|
||||
title: "Integration test summary"
|
||||
path: summary.txt
|
||||
channel: ${{ secrets.SLACK_CHANNEL_ID }}
|
||||
|
||||
- name: Slack Notification - Success/Failure
|
||||
uses: act10ns/slack@v1
|
||||
with:
|
||||
status: ${{ job.status }}
|
||||
steps: ${{ toJson(steps) }}
|
||||
channel: "#workflows"
|
||||
if: always()
|
||||
757
openbb_platform/CONTRIBUTING.md
vendored
757
openbb_platform/CONTRIBUTING.md
vendored
@@ -1,65 +1,186 @@
|
||||
# CONTRIBUTING - THIS IS A WORK IN PROGRESS
|
||||
|
||||
- [CONTRIBUTING - THIS IS A WORK IN PROGRESS](#contributing---this-is-a-work-in-progress)
|
||||
- [Get started contributing with a template](#get-started-contributing-with-a-template)
|
||||
- [Cookiecuter, a closer look](#cookiecuter-a-closer-look)
|
||||
- [Get your data](#get-your-data)
|
||||
- [Platform commands: query and output your data](#platform-commands-query-and-output-your-data)
|
||||
- [Adding a new data point](#adding-a-new-data-point)
|
||||
- [Identify which type of data you want to add](#identify-which-type-of-data-you-want-to-add)
|
||||
- [What is the Standardization Framework?](#what-is-the-standardization-framework)
|
||||
- [Standardization Caveats](#standardization-caveats)
|
||||
- [Quick look into the OpenBB Platform](#quick-look-into-the-openbb-platform)
|
||||
- [What is the Standardization Framework?](#what-is-the-standardization-framework)
|
||||
- [Standardization Caveats](#standardization-caveats)
|
||||
- [Standard QueryParams Example](#standard-queryparams-example)
|
||||
- [Standard Data Example](#standard-data-example)
|
||||
- [Check if the standard model exists](#check-if-the-standard-model-exists)
|
||||
- [Refer to the API documentation and start developing](#refer-to-the-api-documentation-and-start-developing)
|
||||
- [How to use the standardization framework?](#how-to-use-the-standardization-framework)
|
||||
- [Query Parameters](#query-parameters)
|
||||
- [Data Output](#data-output)
|
||||
- [Build the Fetcher](#build-the-fetcher)
|
||||
- [Make the new provider visible to the Platform](#make-the-new-provider-visible-to-the-platform)
|
||||
- [Using other extension as a dependency](#using-other-extension-as-a-dependency)
|
||||
- [Using our internal extension](#using-our-internal-extension)
|
||||
- [Adding an external extension](#adding-an-external-extension)
|
||||
- [The charting extension](#the-charting-extension)
|
||||
- [Add a visualization to an existing Platform command](#add-a-visualization-to-an-existing-platform-command)
|
||||
- [Using the `to_chart` OBBject method](#using-the-to_chart-obbject-method)
|
||||
- [Environment and dependencies](#environment-and-dependencies)
|
||||
- [Python package](#python-package)
|
||||
- [Overview](#overview)
|
||||
- [What is an extension?](#what-is-an-extension)
|
||||
- [Types of extensions](#types-of-extensions)
|
||||
- [How to build OpenBB extensions?](#how-to-build-openbb-extensions)
|
||||
- [Add a custom data source](#add-a-custom-data-source)
|
||||
- [OpenBB Platform commands](#openbb-platform-commands)
|
||||
- [QA your extension](#qa-your-extension)
|
||||
- [Unit tests](#unit-tests)
|
||||
- [Integration tests](#integration-tests)
|
||||
- [Import time](#import-time)
|
||||
- [Sharing your extension](#sharing-your-extension)
|
||||
- [Publish your extension to PyPI](#publish-your-extension-to-pypi)
|
||||
- [Setup](#setup)
|
||||
- [Release](#release)
|
||||
- [Publish](#publish)
|
||||
- [How to contribute to the OpenBB Platform?](#how-to-contribute-to-the-openbb-platform)
|
||||
- [Manage environment and dependencies](#manage-environment-and-dependencies)
|
||||
- [Add a new data point](#add-a-new-data-point)
|
||||
- [Identify which type of data you want to add](#identify-which-type-of-data-you-want-to-add)
|
||||
- [Check if the standard model exists](#check-if-the-standard-model-exists)
|
||||
- [Create Query Parameters model](#create-query-parameters-model)
|
||||
- [Create Data Output model](#create-data-output-model)
|
||||
- [Build the Fetcher](#build-the-fetcher)
|
||||
- [Make the provider visible](#make-the-provider-visible)
|
||||
- [Manage extensions](#manage-extensions)
|
||||
- [Add an extension as a dependency](#add-an-extension-as-a-dependency)
|
||||
- [How to create a PR?](#how-to-create-a-pr)
|
||||
- [Install pre-commit hooks](#install-pre-commit-hooks)
|
||||
- [Branch Naming Conventions](#branch-naming-conventions)
|
||||
|
||||
## Get started contributing with a template
|
||||
# Quick look into the OpenBB Platform
|
||||
|
||||
In order to get started contributing we have setup a Cookiecutter template that will help you get started.
|
||||
The OpenBB Platform is built by the Open-Source community and is characterized by its core and extensions. The core handles data integration and standardization, while the extensions enable customization and advanced functionalities. The OpenBB Platform is designed to be used both from a Python interface and a REST API.
|
||||
|
||||
The REST API is built on top of FastAPI and can be started by running the following command from the root:
|
||||
|
||||
```bash
|
||||
uvicorn openbb_platform.platform.core.openbb_core.api.rest_api:app --host 0.0.0.0 --port 8000 --reload
|
||||
```
|
||||
|
||||
The Python interfaces we provide to users is the `openbb` python package.
|
||||
|
||||
The code you will find in this package is generated from a script and it is just a wrapper around the `openbb-core` and any installed extensions.
|
||||
|
||||
When the user runs `import openbb`, `from openbb import obb` or other variants, the script that generates the packaged code is triggered. It detects if there are new extensions installed in the environment and rebuilds the packaged code accordingly. If new extensions are not found, it just uses the current packaged version.
|
||||
|
||||
When you are developing chances are you want to manually trigger the package rebuild.
|
||||
|
||||
You can do that with:
|
||||
|
||||
```python
|
||||
python -c "import openbb; openbb.build()"
|
||||
```
|
||||
|
||||
The Python interface can be imported with:
|
||||
|
||||
```python
|
||||
from openbb import obb
|
||||
```
|
||||
|
||||
This document will take you through two types of contributions:
|
||||
|
||||
1. Building a custom extension
|
||||
2. Contributing directly to the OpenBB Platform
|
||||
|
||||
Before moving forward, please take a look at the high-level view of the OpenBB Platform architecture. We will go over each bit in this document.
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/OpenBB-finance/OpenBBTerminal/assets/74266147/c9a5a92a-28b6-4257-aefc-deaebe635c6a">
|
||||
<img alt="OpenBB Platform High-Level Architecture" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/74266147/c9a5a92a-28b6-4257-aefc-deaebe635c6a">
|
||||
</picture>
|
||||
|
||||
## What is the Standardization Framework?
|
||||
|
||||
The Standardization Framework is a set of tools and guidelines that enable the user to query and obtain data in a consistent way across multiple providers.
|
||||
|
||||
Each data model should inherit from a [standard data](platform/provider/openbb_provider/standard_models) model that is already defined inside the OpenBB Platform. All standard models are created and maintained by the OpenBB team.
|
||||
|
||||
Usage of these models will unlock a set of perks that are only available to standardized data, namely:
|
||||
|
||||
- Can query and output data in a standardized way.
|
||||
- Can expect extensions that follow standardization to work out-of-the-box.
|
||||
- Can expect transparently defined schemas for the data that is returned by the API.
|
||||
- Can expect consistent data types and validation.
|
||||
- Will work seamlessly with other providers that use the same standard model.
|
||||
|
||||
The standard models are defined under the `/OpenBBTerminal/openbb_platform/platform/core/provider/openbb_provider/standard_models/` directory.
|
||||
|
||||
They define the [`QueryParams`](platform/provider/openbb_provider/abstract/query_params.py) and [`Data`](platform/provider/openbb_provider/abstract/data.py) models, which are used to query and output data. They are pydantic and you can leverage all the pydantic features such as validators.
|
||||
|
||||
### Standardization Caveats
|
||||
|
||||
The standardization framework is a very powerful tool, but it has some caveats that you should be aware of:
|
||||
|
||||
- We standardize fields that are shared between two or more providers. If there is a third provider that doesn't share the same fields, we will declare it as an `Optional` field.
|
||||
- When mapping the column names from a provider-specific model to the standard model, the CamelCase to snake_case conversion is done automatically. If the column names are not the same, you'll need to manually map them. (e.g. `o` -> `open`)
|
||||
- The standard models are created and maintained by the OpenBB team. If you want to add a new field to a standard model, you'll need to open a PR to the OpenBB Platform.
|
||||
|
||||
### Standard QueryParams Example
|
||||
|
||||
```python
|
||||
class StockHistoricalQueryParams(QueryParams):
|
||||
"""Stock end of day Query."""
|
||||
symbol: str = Field(description=QUERY_DESCRIPTIONS.get("symbol", ""))
|
||||
start_date: Optional[date] = Field(
|
||||
description=QUERY_DESCRIPTIONS.get("start_date", ""), default=None
|
||||
)
|
||||
end_date: Optional[date] = Field(
|
||||
description=QUERY_DESCRIPTIONS.get("end_date", ""), default=None
|
||||
)
|
||||
```
|
||||
|
||||
The `QueryParams` is an abstract class that just tells us that we are dealing with query parameters
|
||||
|
||||
The OpenBB Platform dynamically knows where the standard models begin in the inheritance tree, so you don't need to worry about it.
|
||||
|
||||
### Standard Data Example
|
||||
|
||||
```python
|
||||
class StockHistoricalData(Data):
|
||||
"""Stock end of day price Data."""
|
||||
|
||||
date: datetime = Field(description=DATA_DESCRIPTIONS.get("date", ""))
|
||||
open: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("open", ""))
|
||||
high: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("high", ""))
|
||||
low: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("low", ""))
|
||||
close: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("close", ""))
|
||||
volume: float = Field(description=DATA_DESCRIPTIONS.get("volume", ""))
|
||||
vwap: Optional[PositiveFloat] = Field(description=DATA_DESCRIPTIONS.get("vwap", ""), default=None)
|
||||
```
|
||||
|
||||
The `Data` class is an abstract class that tells us the expected output data. Here we can see a `vwap` field that is `Optional`. This is because not all providers share this field while it is shared between two or more providers.
|
||||
|
||||
## What is an extension?
|
||||
|
||||
An extension adds functionality to the OpenBB Platform. It can be a new data source, a new command, a new visualization, etc.
|
||||
|
||||
### Types of extensions
|
||||
|
||||
We primarily have 3 types of extensions:
|
||||
|
||||
1. OpenBB Extensions - built and maintained by the OpenBB team (e.g. `openbb-stocks`)
|
||||
2. Community Extensions - built by anyone and primarily maintained by OpenBB (e.g. `openbb-yfinance`)
|
||||
3. Independent Extensions - built and maintained independently by anyone
|
||||
|
||||
If your extension is of high quality and you think that it would be a good community extension, you can open a PR to the OpenBB Platform repository and we'll review it.
|
||||
|
||||
We encourage independent extensions to be shared with the community by publishing them to PyPI.
|
||||
|
||||
# How to build OpenBB extensions?
|
||||
|
||||
We have a Cookiecutter template that will help you get started. It serves as a jumpstart for your extension development, so you can focus on the data and not on the boilerplate.
|
||||
|
||||
Please refer to the [Cookiecutter template](https://github.com/OpenBB-finance/openbb-cookiecutter) and follow the instructions there.
|
||||
|
||||
This document will walk you through the steps of adding a new custom extension to the Platform. The high level steps are:
|
||||
This document will walk you through the steps of adding a new extension to the OpenBB Platform.
|
||||
|
||||
The high level steps are:
|
||||
|
||||
- Generate the extension structure
|
||||
- Install your dependencies
|
||||
- Install your new package
|
||||
- Use your extension (either from Python or the API interface)
|
||||
- QA your extension
|
||||
- Share your extension with the community
|
||||
|
||||
## Cookiecuter, a closer look
|
||||
## Add a custom data source
|
||||
|
||||
The Cookiecutter template generates a set of files in which we can find instructions and explanations.
|
||||
You will get your data either from a CSV file, local database or from an API endpoint.
|
||||
|
||||
> Note that the code is functional, so you can just run it and start playing with it.
|
||||
If you don't want or don't need to partake in the data standardization framework, you have the option to add all the logic straight inside the router file. This is usually the case when you are returning custom data from your local CSV file, or similar. Keep in mind that we also serve the REST API and that you shouldn't send non-serializable objects as a response (e.g. a pandas dataframe).
|
||||
|
||||
### Get your data
|
||||
|
||||
Either from a CSV file, local database or from an API endpoint, you'll need to get your data.
|
||||
|
||||
If you don't want to partake in the data standardization framework, you can simply write all the logic straight inside the router file. This is usually the case when you are adding unique data that isn't easily standardizable.
|
||||
|
||||
Saying that, we recommend following the standardization framework, as it will make your life easier in the long run and unlock a set of features that are only available to standardized data.
|
||||
Saying that, we highly recommend following the standardization framework, as it will make your life easier in the long run and unlock a set of features that are only available to standardized data.
|
||||
|
||||
When standardizing, all data is defined using two different pydantic models:
|
||||
|
||||
1. Define the [query parameters](openbb_platform\platform\provider\openbb_provider\abstract\query_params.py) model.
|
||||
2. Define the resulting [data schema](openbb_platform\platform\provider\openbb_provider\abstract\data.py) model.
|
||||
1. Define the [query parameters](platform/provider/openbb_provider/abstract/query_params.py) model.
|
||||
2. Define the resulting [data schema](platform/provider/openbb_provider/abstract/data.py) model.
|
||||
|
||||
> The models can be entirely custom, or inherit from the OpenBB standardized models.
|
||||
> They enforce a safe and consistent data structure, validation and type checking.
|
||||
@@ -72,28 +193,28 @@ After you've defined both models, you'll need to define a `Fetcher` class which
|
||||
2. `extract_data` - makes the request to the API endpoint and returns the raw data.
|
||||
3. `transform_data` - transforms the raw data into the defined data model.
|
||||
|
||||
> Note that the `Fetcher` should inherit from the [`Fetcher`](openbb_platform\platform\provider\openbb_provider\abstract\`Fetcher`.py) class, which is a generic class that receives the query parameters and the data model as type parameters.
|
||||
> Note that the `Fetcher` should inherit from the [`Fetcher`](platform/provider/openbb_provider/abstract/fetcher.py) class, which is a generic class that receives the query parameters and the data model as type parameters.
|
||||
|
||||
After finalizing your models you need to make them visible to the Platform. This is done by adding the `Fetcher` to the `__init__.py` file of the `<your_package_name>/<your_module_name>` folder as part of the [`Provider`](openbb_platform\platform\provider\openbb_provider\abstract\provider.py).
|
||||
After finalizing your models, you need to make them visible to the Openbb Platform. This is done by adding the `Fetcher` to the `__init__.py` file of the `<your_package_name>/<your_module_name>` folder as part of the [`Provider`](platform/provider/openbb_provider/abstract/provider.py).
|
||||
|
||||
Any command using the `Fetcher` class you've just defined, will be calling the `transform_query`, `extract_data` and `transform_data` methods under the hood in order to get the data and output it do the end user.
|
||||
Any command, that uses the `Fetcher` class you've just defined, will be calling the `transform_query`, `extract_data` and `transform_data` methods under the hood in order to get the data and output it do the end user.
|
||||
|
||||
If you're not sure what's a command and why is it even using the `Fetcher` class, follow along!
|
||||
|
||||
### Platform commands: query and output your data
|
||||
### OpenBB Platform commands
|
||||
|
||||
The Platform will enable you to query and output your data in a very simple way.
|
||||
The OpenBB Platform will enable you to query and output your data in a very simple way.
|
||||
|
||||
> Any Platform endpoint will be available both from a Python interface and the API.
|
||||
|
||||
The command definition on the Platform follows [FastAPI](https://fastapi.tiangolo.com/) conventions, meaning that you'll be defining **endpoints** similar to like FastAPI.
|
||||
The command definition on the Platform follows [FastAPI](https://fastapi.tiangolo.com/) conventions, meaning that you'll be creating **endpoints**.
|
||||
|
||||
The Cookiecutter template generates for you a `router.py` file with a set of examples that you can follow, namely:
|
||||
|
||||
- Perform a simple `GET` and `POST` request - without worrying on any custom data definition.
|
||||
- Using a custom data definition so you get your data the exact way you want it.
|
||||
|
||||
You can expect the following when using a `Fetcher`:
|
||||
You can expect the following endpoint structure when using a `Fetcher` to serve the data:
|
||||
|
||||
```python
|
||||
@router.command(model="Example")
|
||||
@@ -109,172 +230,293 @@ def model_example(
|
||||
|
||||
Let's break it down:
|
||||
|
||||
- `@router.command(...)` - this tells the Platform that this is a command that can be called.
|
||||
- `model="Example"` - this is the name of the data model that will be used to validate the data.
|
||||
- `cc: CommandContext` - this is a parameter that is passed to the command. It contains a set of user and system settings that maybe useful during the execution of the command - eg. api keys.
|
||||
- `@router.command(...)` - this tells the OpenBB Platform that this is a command.
|
||||
- `model="Example"` - this is the name of the `Fetcher` dictionary key that you've defined in the `__init__.py` file of the `<your_package_name>/<your_module_name>` folder.
|
||||
- `cc: CommandContext` - this contains a set of user and system settings that is useful during the execution of the command - eg. api keys.
|
||||
- `provider_choices: ProviderChoices` - all the providers that implement the `Example` `Fetcher`.
|
||||
- `standard_params: StandardParams` - standardized parameters that are common to all providers that implement the `Example` `Fetcher`.
|
||||
- `extra_params: ExtraParams` - this is a parameter that is passed to the command and it contains the provider specific arguments.
|
||||
- `extra_params: ExtraParams` - it contains the provider specific arguments that are not standardized.
|
||||
|
||||
You only need to change the `model` parameter to the name of the `Fetcher` dictionary key that you've defined in the `__init__.py` file of the `<your_package_name>/<your_module_name>` folder.
|
||||
You only need to change the `model` parameter to the name of the `Fetcher` dictionary key and everything else will be handled by the OpenBB Platform.
|
||||
|
||||
## Adding a new data point
|
||||
## QA your extension
|
||||
|
||||
In the above section, we've seen how to get started with a template.
|
||||
We are strong believers in the QA process and we want to make sure that all the extensions that are added to the OpenBB Platform are of high quality. To ensure this, we have a set of QA tools that you can use to test your extension.
|
||||
|
||||
In this section, we'll be adding a new data point to the Platform. We will add a new provider with an existing [standard data](openbb_platform\platform\provider\openbb_provider\standard_models) model.
|
||||
Primarily, we have tools that semi-automate the creation of unit and integration tests.
|
||||
|
||||
> The QA tools are still in development and we are constantly improving them.
|
||||
|
||||
### Unit tests
|
||||
|
||||
Each `Fetcher` comes equipped with a `test` method that will ensure that it is implemented correctly and that it is returning the expected data. It also ensures that all types are correct and that the data is valid.
|
||||
|
||||
To create unit tests for your Fetchers, you can run the following command:
|
||||
|
||||
```bash
|
||||
python openbb_platform/providers/tests/utils/unit_test_generator.py
|
||||
```
|
||||
|
||||
> Note that you should be running this file from the root of the repository.
|
||||
|
||||
The automatic unit test generation will add unit tests for all the fetchers available in a given provider.
|
||||
|
||||
> Note that sometimes manual intervention is needed. For example, adjusting out-of-top level imports or adding specific arguments for a given fetcher.
|
||||
|
||||
### Integration tests
|
||||
|
||||
The integration tests are a bit more complex than the unit tests, as we want to test both the Python interface and the API interface. For this, we have two scripts that will help you generate the integration tests.
|
||||
|
||||
To generate the integration tests for the Python interface, you can run the following command:
|
||||
|
||||
```bash
|
||||
python openbb_platform/extensions/tests/utils/integration_tests_generator.py
|
||||
```
|
||||
|
||||
To generate the integration tests for the API interface, you can run the following command:
|
||||
|
||||
```bash
|
||||
python openbb_platform/extensions/tests/utils/integration_tests_api_generator.py
|
||||
```
|
||||
|
||||
When testing the API interface, you'll need to run the OpenBB Platform locally before running the tests. To do so, you can run the following command:
|
||||
|
||||
```bash
|
||||
uvicorn openbb_platform.platform.core.openbb_core.api.rest_api:app --host 0.0.0.0 --port 8000 --reload
|
||||
```
|
||||
|
||||
These automated tests are a great way to reduce the amount of code you need to write, but they are not a replacement for manual testing and might require tweaking. That's why we have unit tests that test the generated integration tests to ensure they cover all providers and parameters.
|
||||
|
||||
To run the tests we can do:
|
||||
|
||||
- Unit tests only:
|
||||
|
||||
```bash
|
||||
pytest openbb_platform -m "not integration"
|
||||
```
|
||||
|
||||
- Integration tests only:
|
||||
|
||||
```bash
|
||||
pytest openbb_platform -m integration
|
||||
```
|
||||
|
||||
- Both integration and unit tests:
|
||||
|
||||
```bash
|
||||
pytest openbb_platform
|
||||
```
|
||||
|
||||
### Import time
|
||||
|
||||
We aim to have a short import time for the package. To measure that we use `tuna`.
|
||||
|
||||
- <https://pypi.org/project/tuna/>
|
||||
|
||||
To visualize the import time breakdown by module and find potential bottlenecks, run the
|
||||
following commands from `openbb_platform` directory:
|
||||
|
||||
```bash
|
||||
pip install tuna
|
||||
python -X importtime openbb/__init__.py 2> import.log
|
||||
tuna import.log
|
||||
```
|
||||
|
||||
## Sharing your extension
|
||||
|
||||
We encourage you to share your extension with the community. You can do that by publishing it to PyPI.
|
||||
|
||||
### Publish your extension to PyPI
|
||||
|
||||
To publish your extension to PyPI, you'll need to have a PyPI account and a PyPI API token.
|
||||
|
||||
#### Setup
|
||||
|
||||
Create an account and get an API token from <https://pypi.org/manage/account/token/>
|
||||
Store the token with
|
||||
|
||||
```bash
|
||||
poetry config pypi-token.pypi pypi-YYYYYYYY
|
||||
```
|
||||
|
||||
#### Release
|
||||
|
||||
`cd` into the directory where your extension `pyproject.toml` lives and make sure that the `pyproject.toml` specifies the version tag you want to release and run.
|
||||
|
||||
```bash
|
||||
poetry build
|
||||
```
|
||||
|
||||
This will create a `/dist` folder in the directory, which will contain the `.whl` and `tar.gz` files matching the version to release.
|
||||
|
||||
If you want to test your package locally you can do it with
|
||||
|
||||
```bash
|
||||
pip install dist/openbb_[FILE_NAME].whl
|
||||
```
|
||||
|
||||
#### Publish
|
||||
|
||||
To publish your package to PyPI run:
|
||||
|
||||
```bash
|
||||
poetry publish
|
||||
```
|
||||
|
||||
Now, you can pip install your package from PyPI with:
|
||||
|
||||
```bash
|
||||
pip install openbb-some_ext
|
||||
```
|
||||
|
||||
# How to contribute to the OpenBB Platform?
|
||||
|
||||
There are many ways to contribute to the OpenBB Platform. You can add a new data point, add a new command, add a new visualization, add a new extension, fix a bug etc.
|
||||
|
||||
In this document, we'll be focusing on adding a new data point to the OpenBB Platform.
|
||||
|
||||
## Manage environment and dependencies
|
||||
|
||||
In order to contribute to the OpenBB Platform, you need to setup your environment to ensure a smooth development experience.
|
||||
|
||||
<details>
|
||||
<summary>Need help setting up Miniconda or Git?</summary>
|
||||
|
||||
Sometimes, installing Miniconda or Git can be a bit tricky, so we've prepared a set of instructions to help you get started.
|
||||
|
||||
Please refer to [OpenBBTerminal docs](https://docs.openbb.co/terminal/installation/source) for more information.
|
||||
</details>
|
||||
|
||||
1. Clone the repository:
|
||||
|
||||
```bash
|
||||
git clone git@github.com:OpenBB-finance/OpenBBTerminal.git
|
||||
```
|
||||
|
||||
2. Create and activate a virtual environment:
|
||||
|
||||
```bash
|
||||
conda create -n "obb-dev" python=3.9.13
|
||||
conda activate obb-dev
|
||||
```
|
||||
|
||||
> Supported python versions: python = ">=3.8,<3.12"
|
||||
|
||||
3. Manage your environment with [Poetry](https://python-poetry.org/):
|
||||
|
||||
```bash
|
||||
pip install poetry
|
||||
```
|
||||
|
||||
4. Install the packages using the `dev_install.py` script located in the `openbb_platform` folder:
|
||||
|
||||
```bash
|
||||
python dev_install.py
|
||||
```
|
||||
|
||||
> To install all the packages, including extras, use the `-e` argument with the above script.
|
||||
|
||||
5. Setup your API keys locally by adding them to 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"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
> You can also setup and use your keys from the OpenBB Hub and the Python interface at runtime. Follow the steps in [API Keys](./README.md#api-keys) section to know more about it.
|
||||
|
||||
## Add a new data point
|
||||
|
||||
In this section, we'll be adding a new data point to the OpenBB Platform. We will add a new provider with an existing [standard data](platform/provider/openbb_provider/standard_models) model.
|
||||
|
||||
### Identify which type of data you want to add
|
||||
|
||||
In this example, we'll be adding OHLC stock data that is used by the `stocks/load` command.
|
||||
In this example, we'll be adding OHLC stock data that is used by the `obb.stocks.load` command.
|
||||
|
||||
Note that, if no command exists for your data, we need to add one under the right router.
|
||||
Each router is categorized into different extensions (stocks, forex, crypto, etc.).
|
||||
|
||||
### What is the Standardization Framework?
|
||||
|
||||
The Standardization Framework is a set of tools and guidelines that enable the user to query and obtain data in a consistent way across several providers.
|
||||
|
||||
Each data model should inherit from a [standard data](openbb_platform\platform\provider\openbb_provider\standard_models) that is already defined in the Platform. This will unlock a set of perks that are only available to standardized data, namely:
|
||||
|
||||
- Can query and output data in a standardized way.
|
||||
- Can expect extensions that follow standardization to work out-of-the-box.
|
||||
- Can expect transparently defined schemas for the data that is returned by the API.
|
||||
- Can expect consistent data types and validation.
|
||||
- Will work seamlessly with other providers that implement the same standard model.
|
||||
|
||||
The standard models are defined under the `./platform/core/provider/openbb_provider/standard_models/` directory.
|
||||
|
||||
They implement the [`QueryParams`](openbb_platform\platform\provider\openbb_provider\abstract\query_params.py) and [`Data`](openbb_platform\platform\provider\openbb_provider\abstract\data.py) models, which are the models that are used to query and output data, respectively. They are pydantic models under the hood, so you can leverage all the pydantic features such as validators.
|
||||
|
||||
#### Standardization Caveats
|
||||
|
||||
The standardization framework is a very powerful tool, but it has some caveats that you should be aware of:
|
||||
|
||||
- We standardize fields that are shared between two or more providers. If there is a third provider that doesn't share the same fields, we will declare it as an `Optional` field.
|
||||
- When mapping the column names from a provider-specific model to the standard model, the CamelCase to snake_case conversion is done automatically. If the column names are not the same, you'll need to manually map them. (e.g. `o` -> `open`)
|
||||
- The standard models are created and maintained by the OpenBB team. If you want to add a new field to a standard model, you'll need to open a PR to the Platform.
|
||||
|
||||
### Standard QueryParams Example
|
||||
|
||||
```python
|
||||
class StockEODQueryParams(QueryParams, BaseSymbol):
|
||||
"""Stock end of day Query."""
|
||||
|
||||
start_date: Optional[date] = Field(
|
||||
description=QUERY_DESCRIPTIONS.get("start_date", ""), default=None
|
||||
)
|
||||
end_date: Optional[date] = Field(
|
||||
description=QUERY_DESCRIPTIONS.get("end_date", ""), default=None
|
||||
)
|
||||
```
|
||||
|
||||
The `QueryParams` is an abstract class that just tells us that we are dealing with query parameters. The `BaseSymbol` is a helper class that contains the `symbol` field and an
|
||||
upper case validator.
|
||||
|
||||
The Platform dynamically knows where the standard models begin in the inheritance tree, so you don't need to worry about it.
|
||||
|
||||
### Standard Data Example
|
||||
|
||||
```python
|
||||
class StockEODData(Data):
|
||||
"""Stock end of day price Data."""
|
||||
|
||||
date: datetime = Field(description=DATA_DESCRIPTIONS.get("date", ""))
|
||||
open: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("open", ""))
|
||||
high: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("high", ""))
|
||||
low: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("low", ""))
|
||||
close: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("close", ""))
|
||||
volume: float = Field(description=DATA_DESCRIPTIONS.get("volume", ""))
|
||||
vwap: Optional[PositiveFloat] = Field(description=DATA_DESCRIPTIONS.get("vwap", ""))
|
||||
```
|
||||
|
||||
The `Data` class is an abstract class that tells us the expected output data. Here we can see a `vwap` field that is `Optional`. This is because not all providers share this field while it is shared between two or more providers.
|
||||
Each router is categorized under different extensions (stocks, forex, crypto, etc.).
|
||||
|
||||
#### Check if the standard model exists
|
||||
|
||||
Given the fact that there's already an endpoint for OHLCV stock data, we can check if the standard exists.
|
||||
|
||||
In this case, it's `StockEOD` which can be found inside the `./platform/core/provider/openbb_provider/standard_models/` directory.
|
||||
In this case, it's `StockHistorical` which can be found inside the `/OpenBBTerminal/openbb_platform/platform/core/provider/openbb_provider/standard_models/` directory.
|
||||
|
||||
If the standard model doesn't exist:
|
||||
|
||||
- you won't need to inherit from it in the next steps
|
||||
- all your provider-specific query parameters will be under the `**kwargs` in the python interface
|
||||
- you won't need to inherit from it in the next steps.
|
||||
- all your provider query parameters will be under the `**kwargs` in the python interface.
|
||||
- it might not work out-of-the box with other extensions that follow standardization e.g. the `charting` extension
|
||||
|
||||
## Refer to the API documentation and start developing
|
||||
|
||||
You can start developing your extension by referring to the API documentation of the provider you are interested to integrate.
|
||||
|
||||
### How to use the standardization framework?
|
||||
|
||||
#### Query Parameters
|
||||
#### Create Query Parameters model
|
||||
|
||||
Query Parameters are the parameters that are passed to the API endpoint in order to make the request.
|
||||
|
||||
For the `StockEOD` example, this would look like the following:
|
||||
For the `StockHistorical` example, this would look like the following:
|
||||
|
||||
```python
|
||||
|
||||
class <ProviderName>StockEODQueryParams(StockEODQueryParams):
|
||||
"""<ProviderName> Stock End of Day Query.
|
||||
class <ProviderName>StockHistoricalQueryParams(StockHistoricalQueryParams):
|
||||
"""<ProviderName> Stock Historical Query.
|
||||
|
||||
Source: https://www.<provider_name>.co/documentation/
|
||||
"""
|
||||
|
||||
# provider specific query parameters
|
||||
# provider specific query parameters if any
|
||||
|
||||
```
|
||||
|
||||
> Note that, since `StockEODQueryParams` inherits from pydantic's `BaseModel`, so we can leverage validators to perform additional checks on the query parameters.
|
||||
|
||||
#### Data Output
|
||||
#### Create Data Output model
|
||||
|
||||
The data output is the data that is returned by the API endpoint.
|
||||
For the `StockEOD` example, this would look like the following:
|
||||
For the `StockHistorical` example, this would look like the following:
|
||||
|
||||
```python
|
||||
|
||||
class <ProviderName>StockEODData(StockEODData):
|
||||
class <ProviderName>StockHistoricalData(StockHistoricalData):
|
||||
"""<ProviderName> Stock End of Day Data.
|
||||
|
||||
Source: https://www.<provider_name>.co/documentation/
|
||||
"""
|
||||
|
||||
# provider specific data output
|
||||
# provider specific data output fields if any
|
||||
|
||||
```
|
||||
|
||||
> Note that, since `StockEODData` inherits from pydantic's `BaseModel`, so we can leverage validators to perform additional checks on the output model. A very good example of this, would be to transform a string date into a datetime object.
|
||||
> Note that, since `StockHistoricalData` inherits from pydantic's `BaseModel`, we can leverage validators to perform additional checks on the output model. A very good example of this, would be to transform a string date into a datetime object.
|
||||
|
||||
#### Build the Fetcher
|
||||
|
||||
The `Fetcher` class is responsible for making the request to the API endpoint and providing the output.
|
||||
|
||||
It will receive the Query Parameters, and it will return the output while leveraging the Data model.
|
||||
It will receive the Query Parameters, and it will return the output while leveraging the pydantic model schemas.
|
||||
|
||||
For the `StockEOD` example, this would look like the following:
|
||||
For the `StockHistorical` example, this would look like the following:
|
||||
|
||||
```python
|
||||
|
||||
class <ProviderName>StockEODFetcher(
|
||||
class <ProviderName>StockHistoricalFetcher(
|
||||
Fetcher[
|
||||
<ProviderName>StockEODQueryParams,
|
||||
List[<ProviderName>StockEODData],
|
||||
<ProviderName>StockHistoricalQueryParams,
|
||||
List[<ProviderName>StockHistoricalData],
|
||||
]
|
||||
):
|
||||
"""Transform the query, extract and transform the data."""
|
||||
|
||||
@staticmethod
|
||||
def transform_query(params: Dict[str, Any]) -> <ProviderName>StockEODQueryParams:
|
||||
def transform_query(params: Dict[str, Any]) -> <ProviderName>StockHistoricalQueryParams:
|
||||
"""Transform the query parameters."""
|
||||
|
||||
return <ProviderName>StockEODQueryParams(**transformed_params)
|
||||
return <ProviderName>StockHistoricalQueryParams(**transformed_params)
|
||||
|
||||
@staticmethod
|
||||
def extract_data(
|
||||
query: <ProviderName>StockEODQueryParams,
|
||||
query: <ProviderName>StockHistoricalQueryParams,
|
||||
credentials: Optional[Dict[str, str]],
|
||||
**kwargs: Any,
|
||||
) -> dict:
|
||||
@@ -287,230 +529,91 @@ class <ProviderName>StockEODFetcher(
|
||||
@staticmethod
|
||||
def transform_data(
|
||||
data: dict,
|
||||
) -> List[<ProviderName>StockEODData]:
|
||||
) -> List[<ProviderName>StockHistoricalData]:
|
||||
"""Transform the data to the standard format."""
|
||||
|
||||
return [<ProviderName>StockEODData.model_validate(d) for d in data]
|
||||
|
||||
return [<ProviderName>StockHistoricalData.model_validate(d) for d in data]
|
||||
```
|
||||
|
||||
> Make sure that you're following the TET pattern when building a `Fetcher` - **Transform, Extract, Transform**.
|
||||
|
||||
### Make the new provider visible to the Platform
|
||||
### Make the provider visible
|
||||
|
||||
In order to make the new provider visible to the Platform, you'll need to add it to the `__init__.py` file of the `providers/<provider_name>/openbb_<provider_name>/` folder.
|
||||
In order to make the new provider visible to the OpenBB Platform, you'll need to add it to the `__init__.py` file of the `providers/<provider_name>/openbb_<provider_name>/` folder.
|
||||
|
||||
```python
|
||||
|
||||
"""<Provider Name> Provider module."""
|
||||
from openbb_provider.abstract.provider import Provider
|
||||
|
||||
from openbb_<provider_name>.models.stock_eod import <ProviderName>StockEODFetcher
|
||||
from openbb_<provider_name>.models.stock_eod import <ProviderName>StockHistoricalFetcher
|
||||
|
||||
<provider_name>_provider = Provider(
|
||||
name="<provider_name>",
|
||||
website="<URL to the provider website>",
|
||||
description="Provider description goes here",
|
||||
required_credentials=["api_key"],
|
||||
`Fetcher`_dict={
|
||||
"StockEOD": <ProviderName>StockEODFetcher,
|
||||
fetcher_dict={
|
||||
"StockHistorical": <ProviderName>StockHistoricalFetcher,
|
||||
},
|
||||
)
|
||||
|
||||
```
|
||||
|
||||
If the provider does not require any credentials, you can simply omit it. On the other hand if it requires more than 2 items to authenticate, you can simply add a list of all the required items to the `required_credentials` list.
|
||||
If the provider does not require any credentials, you can remove that parameter. On the other hand, if it requires more than 2 items to authenticate, you can add a list of all the required items to the `required_credentials` list.
|
||||
|
||||
After running `pip install .` on `openbb_platform/providers/<provider_name>` your provider should be ready for usage, both from the Python interface and the API.
|
||||
|
||||
## Using other extension as a dependency
|
||||
## Manage extensions
|
||||
|
||||
We can use internal and external extensions with the custom developed extension and bundle it as a dependency.
|
||||
To install an extension hosted on PyPI, use the `pip install <extension>` command.
|
||||
|
||||
### Using our internal extension
|
||||
To install an extension that is developed locally, ensure that it contains a `pyproject.toml` file and then use the `pip install <extension>` command.
|
||||
|
||||
We will use the `openbb-qa` extension by utilizing its `summary` endpoint.
|
||||
> To install the extension in editable mode using pip, add the `-e` argument.
|
||||
|
||||
To create a `period_summary_example` endpoint we need to add the following to the `router.py` file:
|
||||
Alternatively, for local extensions, you can add this line in the `LOCAL_DEPS` variable in `dev_install.py` file:
|
||||
|
||||
```python
|
||||
from typing import List
|
||||
from openbb_provider.abstract.data import Data
|
||||
from openbb_core.app.utils import basemodel_to_df, df_to_basemodel
|
||||
from openbb_qa.qa_router import summary
|
||||
|
||||
|
||||
@router.command(methods=["POST"])
|
||||
def period_summary_example(
|
||||
data: List[Data],
|
||||
target: str,
|
||||
start_date: str,
|
||||
end_date: str,
|
||||
) -> OBBject[dict]:
|
||||
"""Example Data."""
|
||||
|
||||
df = basemodel_to_df(data)
|
||||
df = df[(df["date"] >= start_date) & (df["date"] <= end_date)]
|
||||
df = df.reset_index(drop=True)
|
||||
target_data = df_to_basemodel(df)
|
||||
results = summary(target_data, target=target)
|
||||
|
||||
return OBBject(results=results.results)
|
||||
```toml
|
||||
# If this is a community dependency, add this under "Community dependencies",
|
||||
# with additional argument optional = true
|
||||
openbb-extension = { path = "<relative-path-to-the-extension>", develop = true }
|
||||
```
|
||||
|
||||
Here we are using two vital utility functions - `basemodel_to_df` and `df_to_basemodel`. The function `basemodel_to_df` converts the data to a pandas dataframe and `df_to_basemodel` converts the dataframe back to the `Data` model.
|
||||
Now you can use the `python dev_install.py [-e]` command to install the local extension.
|
||||
|
||||
### Adding an external extension
|
||||
### Add an extension as a dependency
|
||||
|
||||
To add the `openbb-charting` charting extension as a dependency, you'll need to add it to the `pyproject.toml` file:
|
||||
To add the `openbb-qa` extension as a dependency, you'll need to add it to the `pyproject.toml` file:
|
||||
|
||||
<!-- TODO: Change the version to match the stable release -->
|
||||
```toml
|
||||
[tool.poetry.dependencies]
|
||||
openbb-charting = "^0.0.0a1"
|
||||
openbb-qa = "^0.0.0a2"
|
||||
```
|
||||
|
||||
Then execute the command `poetry install` in the root of your extension to install the new dependency.
|
||||
Then you can follow the same process as above to install the extension.
|
||||
|
||||
### The charting extension
|
||||
## How to create a PR?
|
||||
|
||||
> In theory the same principles apply to any other extension.
|
||||
To create a PR to the OpenBB Platform, you'll need to fork the repository and create a new branch.
|
||||
|
||||
#### Add a visualization to an existing Platform command
|
||||
1. Create your Feature Branch, e.g. `git checkout -b feature/AmazingFeature`
|
||||
2. Check the files you have touched using `git status`
|
||||
3. Stage the files you want to commit, e.g.
|
||||
`git add openbb_terminal/stocks/stocks_controller.py openbb_terminal/stocks/stocks_helper.py`.
|
||||
Note: **DON'T** add any files with personal information.
|
||||
4. Write a concise commit message under 50 characters, e.g. `git commit -m "meaningful commit message"`. If your PR
|
||||
solves an issue raised by a user, you may specify such issue by adding #ISSUE_NUMBER to the commit message, so that
|
||||
these get linked. Note: If you installed pre-commit hooks and one of the formatters re-formats your code, you'll need
|
||||
to go back to step 3 to add these.
|
||||
|
||||
One should first ensure that the already implemented endpoint is available in the [charting router](openbb_platform/extensions/charting/openbb_charting/charting_router.py).
|
||||
### Install pre-commit hooks
|
||||
|
||||
To do so, you can run:
|
||||
`python openbb_platform/extensions/charting/openbb_charting/builder.py` - which will read all the available endpoints and add them to the charting router.
|
||||
To install pre-commit hooks, run `pre-commit install` in the root of the repository.
|
||||
|
||||
Afterwards, you'll need to add the visualization to the [charting router](openbb_platform/extensions/charting/openbb_charting/charting_router.py). The convention to match the endpoint with the respective charting function is the following:
|
||||
### Branch Naming Conventions
|
||||
|
||||
- `stocks/load` -> `stocks_load`
|
||||
- `ta/ema` -> `ta_ema`
|
||||
The accepted branch naming conventions are:
|
||||
|
||||
When you spot the charting function on the charting router file, you can add the visualization to it.
|
||||
- `feature/feature-name`
|
||||
- `hotfix/hotfix-name`
|
||||
|
||||
The implementation should leverage the already existing classes and methods to do so, namely:
|
||||
|
||||
- `OpenBBFigure`
|
||||
- `OpenBBFigureTable`
|
||||
- `PlotlyTA`
|
||||
|
||||
Note that the return of each charting function should respect the already defined return types: `Tuple[OpenBBFigure, Dict[str, Any]]`.
|
||||
|
||||
The returned tuple contains a `OpenBBFigure` that is an interactive plotly figure that can be used in a Python interpreter, and a `Dict[str, Any]` that contains the raw data leveraged by the API.
|
||||
|
||||
After you're done implementing the charting function, you can simply use either the Python interface or the API to get the chart. To do so, you'll only need to set the already available `chart` argument to `True`.
|
||||
|
||||
Refer to the charting extension [documentation](openbb_platform/extensions/charting/README.md) for more information on usage.
|
||||
|
||||
#### Using the `to_chart` OBBject method
|
||||
|
||||
The `OBBject` is the custom OpenBB object that is returned by the Platform commands.
|
||||
It implements a set of `to_<something>` functions that enable the user to easily transform the data into a different format.
|
||||
|
||||
The `to_chart` function should be taken as an advanced feature, as it requires the user to have a good understanding of the charting extension and the `OpenBBFigure` class.
|
||||
|
||||
The user can use any number of `**kwargs` that will be passed to the `PlotlyTA` class in order to build custom visualizations with custom indicators and similar.
|
||||
|
||||
Refer to the [`to_chart` implementation](openbb_platform/extensions/charting/openbb_charting/core/to_chart.py) for further details.
|
||||
|
||||
> Note that, this method will only work to some limited extent with data that is not standardized.
|
||||
> Also, it is designed only to handle time series data.
|
||||
|
||||
## Environment and dependencies
|
||||
|
||||
In order to contribute to the Platform you need to setup your environment in order to ensure a smooth development experience.
|
||||
|
||||
<details>
|
||||
<summary>Need help setting up Miniconda or Git?</summary>
|
||||
|
||||
Sometimes installing Miniconda or Git can be a bit tricky, so we've prepared a set of instructions to help you get started.
|
||||
|
||||
Please refer to [OpenBBTerminal docs](https://docs.openbb.co/terminal/installation/pypi) for more information.
|
||||
</details>
|
||||
|
||||
1. Clone the repository:
|
||||
|
||||
```bash
|
||||
git clone git@github.com:OpenBB-finance/OpenBBTerminal.git
|
||||
```
|
||||
|
||||
2. Create and activate a virtual environment:
|
||||
|
||||
> Supported python versions: python = ">=3.8,<3.12"
|
||||
|
||||
```bash
|
||||
conda create -n "obb-dev" python=3.9.13
|
||||
conda activate obb-dev
|
||||
```
|
||||
|
||||
3. Manage your environment with [Poetry](https://python-poetry.org/):
|
||||
|
||||
```bash
|
||||
pip install poetry
|
||||
```
|
||||
|
||||
4. Install the `openbb-core`:
|
||||
|
||||
```bash
|
||||
cd OpenBBTerminal/openbb_platform/platform/core/
|
||||
poetry install
|
||||
```
|
||||
|
||||
5. Install dependencies:
|
||||
|
||||
```bash
|
||||
cd OpenBBTerminal/openbb_platform/extensions/stocks/ # or any other extension
|
||||
poetry install
|
||||
```
|
||||
|
||||
> When installing the dependencies using poetry we ensure that dependencies are being installed in editable mode, which is the most straightforward way to develop on top of the Platform.
|
||||
|
||||
<details>
|
||||
<summary>Install all dependencies in editable mode at once</summary>
|
||||
|
||||
For development purposes, one can install every available extension by running a custom shell script:
|
||||
|
||||
Navigate to `/OpenBBTerminal/openbb_platform`
|
||||
|
||||
Run `python dev_install.py`.
|
||||
</details>
|
||||
|
||||
> In order to install any other custom extension or provider, you'd follow the exact same steps as above.
|
||||
|
||||
## Python package
|
||||
|
||||
### Overview
|
||||
|
||||
One of the interfaces we provide to users is the `openbb` python package.
|
||||
|
||||
The code you will find in this package is generated from a script and it is just a
|
||||
wrapper around the `openbb-core` and any installed extensions.
|
||||
|
||||
When the user runs `import openbb`, `from openbb import obb` or other variants, the
|
||||
script that generates the package code is triggered. It detects if there are new openbb
|
||||
extensions installed in the environment and rebuilds the package code accordingly. If
|
||||
new extensions are not found it just uses the current package version.
|
||||
|
||||
When you are developing chances are you want to manually trigger the package rebuild.
|
||||
You can do that with:
|
||||
|
||||
```python
|
||||
python -c "import openbb; openbb.build()"
|
||||
```
|
||||
|
||||
### Import time
|
||||
|
||||
We aim to have a short import time for the package. To measure that we use `tuna`.
|
||||
|
||||
- https://pypi.org/project/tuna/
|
||||
|
||||
To visualize the import time breakdown by module and find potential bottlenecks, run the
|
||||
following commands from `openbb_platform` directory:
|
||||
|
||||
```bash
|
||||
pip install tuna
|
||||
python -X importtime openbb/__init__.py 2> import.log
|
||||
tuna import.log
|
||||
```
|
||||
These branches can only have PRs pointing to the `develop` branch.
|
||||
|
||||
46
openbb_platform/extensions/charting/README.md
vendored
46
openbb_platform/extensions/charting/README.md
vendored
@@ -1,12 +1,12 @@
|
||||
# OpenBB Charting extension
|
||||
|
||||
This extension provides a charting library for OpenBB SDK.
|
||||
This extension provides a charting library for OpenBB Platform.
|
||||
|
||||
The library includes:
|
||||
|
||||
- a charting infrastructure based on Plotly
|
||||
- a set of charting components
|
||||
- prebuilt charts for a set of commands that are built-in OpenBB SDK extensions
|
||||
- prebuilt charts for a set of commands that are built-in OpenBB extensions
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -34,7 +34,7 @@ When using Linux distributions, the PyWry dependency requires certain dependenci
|
||||
|
||||
## Usage
|
||||
|
||||
To use the extension, run any of the OpenBB SDK endpoints with the `chart` argument set to `True`.
|
||||
To use the extension, run any of the OpenBB Platform endpoints with the `chart` argument set to `True`.
|
||||
|
||||
Here's an example how it would look like in a python interface:
|
||||
|
||||
@@ -52,3 +52,43 @@ stock_data.show()
|
||||
```
|
||||
|
||||
> Note: The `show()` method currently works either in a Jupyter Notebook or in a standalone python script with a PyWry based backend properly initialized.
|
||||
|
||||
## Add a visualization to an existing Platform command
|
||||
|
||||
One should first ensure that the already implemented endpoint is available in the [charting router](/openbb_platform/extensions/charting/openbb_charting/charting_router.py).
|
||||
|
||||
To do so, you can run:
|
||||
`python openbb_platform/extensions/charting/openbb_charting/builder.py` - which will read all the available endpoints and add them to the charting router.
|
||||
|
||||
Afterwards, you'll need to add the visualization to the [charting router](/openbb_platform/extensions/charting/openbb_charting/charting_router.py). The convention to match the endpoint with the respective charting function is the following:
|
||||
|
||||
- `/stocks/load` -> `stocks_load`
|
||||
- `/ta/ema` -> `ta_ema`
|
||||
|
||||
When you spot the charting function on the charting router file, you can add the visualization to it.
|
||||
|
||||
The implementation should leverage the already existing classes and methods to do so, namely:
|
||||
|
||||
- `OpenBBFigure`
|
||||
- `OpenBBFigureTable`
|
||||
- `PlotlyTA`
|
||||
|
||||
Note that the return of each charting function should respect the already defined return types: `Tuple[OpenBBFigure, Dict[str, Any]]`.
|
||||
|
||||
The returned tuple contains a `OpenBBFigure` that is an interactive plotly figure which can be used in a Python interpreter, and a `Dict[str, Any]` that contains the raw data leveraged by the API.
|
||||
|
||||
After you're done implementing the charting function, you can use either the Python interface or the API to get the chart. To do so, you'll only need to set the already available `chart` argument to `True`.
|
||||
|
||||
### Using the `to_chart` OBBject method
|
||||
|
||||
The `OBBject` is the custom OpenBB object that is returned by the Platform commands.
|
||||
It implements a set of `to_<something>` functions that enable the user to easily transform the data into a different format.
|
||||
|
||||
The `to_chart` function should be taken as an advanced feature, as it requires the user to have a good understanding of the charting extension and the `OpenBBFigure` class.
|
||||
|
||||
The user can use any number of `**kwargs` that will be passed to the `PlotlyTA` class in order to build custom visualizations with custom indicators and similar.
|
||||
|
||||
Refer to the [`to_chart` implementation](openbb_charting/core/to_chart.py) for further details.
|
||||
|
||||
> Note that, this method will only work to some limited extent with data that is not standardized.
|
||||
> Also, it is currently designed only to handle time series data.
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
import os
|
||||
from platform.core.openbb_core.app.provider_interface import ProviderInterface
|
||||
from platform.core.openbb_core.app.router import CommandMap
|
||||
from typing import Dict, List, Type, get_type_hints
|
||||
|
||||
import requests
|
||||
from extensions.tests.utils.integration_tests_generator import get_test_params
|
||||
from openbb_core.app.provider_interface import ProviderInterface
|
||||
from openbb_core.app.router import CommandMap
|
||||
|
||||
|
||||
def get_http_method(api_paths: Dict[str, dict], route: str):
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
"""Integration test generator."""
|
||||
from pathlib import Path, PosixPath
|
||||
from platform.core.openbb_core.app.provider_interface import ProviderInterface
|
||||
from platform.core.openbb_core.app.router import CommandMap
|
||||
from typing import Any, Dict, List, Literal, Tuple, Type, get_origin, get_type_hints
|
||||
|
||||
from openbb_core.app.provider_interface import ProviderInterface
|
||||
from openbb_core.app.router import CommandMap
|
||||
from pydantic.fields import FieldInfo
|
||||
from pydantic_core import PydanticUndefined
|
||||
|
||||
|
||||
@@ -81,7 +81,7 @@ def get_trans_data(
|
||||
activation: str
|
||||
The activation function of encoder/decoder intermediate layer, ‘relu’ or ‘gelu’. Defaults to 'relu'.
|
||||
dropout: float
|
||||
Fraction of neurons afected by Dropout. Defaults to 0.0.
|
||||
Fraction of neurons affected by Dropout. Defaults to 0.0.
|
||||
batch_size: int
|
||||
Number of time series (input and output sequences) used in each training pass. Defaults to 32.
|
||||
n_epochs: int
|
||||
|
||||
@@ -759,7 +759,7 @@ def calculate_strangle(
|
||||
|
||||
strangle: dict[str, Any] = {}
|
||||
|
||||
# Includees the as-of date if it is historical EOD data.
|
||||
# Includes the as-of date if it is historical EOD data.
|
||||
if (
|
||||
options.source == "Intrinio"
|
||||
and options.date != ""
|
||||
@@ -892,7 +892,7 @@ def calculate_vertical_call_spread(
|
||||
max_profit = sold - bought - spread_cost[0]
|
||||
call_spread_: dict[str, Any] = {}
|
||||
if sold != bought and spread_cost[0] != 0:
|
||||
# Includees the as-of date if it is historical EOD data.
|
||||
# Includes the as-of date if it is historical EOD data.
|
||||
if (
|
||||
options.source == "Intrinio"
|
||||
and options.date != ""
|
||||
@@ -1036,7 +1036,7 @@ def calculate_vertical_put_spread(
|
||||
max_loss = (sold - bought - max_profit) * -1
|
||||
put_spread_: dict[str, Any] = {}
|
||||
if sold != bought and max_loss != 0:
|
||||
# Includees the as-of date if it is historical EOD data.
|
||||
# Includes the as-of date if it is historical EOD data.
|
||||
if (
|
||||
options.source == "Intrinio"
|
||||
and options.date != ""
|
||||
|
||||
2
website/README.md
vendored
2
website/README.md
vendored
@@ -238,7 +238,7 @@ website/content/_index.md
|
||||
/...
|
||||
```
|
||||
|
||||
Note that the `common` folder holds features that are common across contexts, e.g. `technical analysis` can be performed on both `stocks` or `crytpo`.
|
||||
Note that the `common` folder holds features that are common across contexts, e.g. `technical analysis` can be performed on both `stocks` or `crypto`.
|
||||
|
||||
### New Feature
|
||||
|
||||
|
||||
4
website/content/platform/contributing/_category_.json
vendored
Normal file
4
website/content/platform/contributing/_category_.json
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Contributing",
|
||||
"position": 2
|
||||
}
|
||||
4
website/content/platform/contributing/extension-development/_category_.json
vendored
Normal file
4
website/content/platform/contributing/extension-development/_category_.json
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Extension Development",
|
||||
"position": 2
|
||||
}
|
||||
78
website/content/platform/contributing/extension-development/custom_data.md
vendored
Normal file
78
website/content/platform/contributing/extension-development/custom_data.md
vendored
Normal file
@@ -0,0 +1,78 @@
|
||||
---
|
||||
title: Add a custom data source
|
||||
sidebar_position: 2
|
||||
description: Add a custom data source to the OpenBB Platform.
|
||||
keywords: [openbb platform, extension, custom data source, contributing, documentation]
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Add a custom data source - Platform | OpenBB Docs" />
|
||||
|
||||
You will get your data either from a CSV file, local database or from an API endpoint.
|
||||
|
||||
If you don't want or don't need to partake in the data standardization framework, you have the option to add all the logic straight inside the router file. This is usually the case when you are returning custom data from your local CSV file, or similar. Keep in mind that we also serve the REST API and that you shouldn't send non-serializable objects as a response (e.g. a pandas dataframe).
|
||||
|
||||
Saying that, we highly recommend following the standardization framework, as it will make your life easier in the long run and unlock a set of features that are only available to standardized data.
|
||||
|
||||
When standardizing, all data is defined using two different pydantic models:
|
||||
|
||||
1. Define the [query parameters](https://github.com/OpenBB-finance/OpenBBTerminal/tree/feature/openbb-sdk-v4/openbb_platform/platform/provider/openbb_provider/abstract/query_params.py) model.
|
||||
2. Define the resulting [data schema](https://github.com/OpenBB-finance/OpenBBTerminal/tree/feature/openbb-sdk-v4/openbb_platform/platform/provider/openbb_provider/abstract/data.py) model.
|
||||
|
||||
> The models can be entirely custom, or inherit from the OpenBB standardized models.
|
||||
> They enforce a safe and consistent data structure, validation and type checking.
|
||||
|
||||
We call this the ***Know-Your-Data*** principle.
|
||||
|
||||
After you've defined both models, you'll need to define a `Fetcher` class which contains three methods:
|
||||
|
||||
1. `transform_query` - transforms the query parameters to the format of the API endpoint.
|
||||
2. `extract_data` - makes the request to the API endpoint and returns the raw data.
|
||||
3. `transform_data` - transforms the raw data into the defined data model.
|
||||
|
||||
> Note that the `Fetcher` should inherit from the [`Fetcher`](https://github.com/OpenBB-finance/OpenBBTerminal/tree/feature/openbb-sdk-v4/openbb_platform/platform/provider/openbb_provider/abstract/fetcher.py) class, which is a generic class that receives the query parameters and the data model as type parameters.
|
||||
|
||||
After finalizing your models, you need to make them visible to the Openbb Platform. This is done by adding the `Fetcher` to the `__init__.py` file of the `<your_package_name>/<your_module_name>` folder as part of the [`Provider`](https://github.com/OpenBB-finance/OpenBBTerminal/tree/feature/openbb-sdk-v4/openbb_platform/platform/provider/openbb_provider/abstract/provider.py).
|
||||
|
||||
Any command, that uses the `Fetcher` class you've just defined, will be calling the `transform_query`, `extract_data` and `transform_data` methods under the hood in order to get the data and output it do the end user.
|
||||
|
||||
If you're not sure what's a command and why is it even using the `Fetcher` class, follow along!
|
||||
|
||||
## OpenBB Platform commands
|
||||
|
||||
The OpenBB Platform will enable you to query and output your data in a very simple way.
|
||||
|
||||
> Any Platform endpoint will be available both from a Python interface and the API.
|
||||
|
||||
The command definition on the Platform follows [FastAPI](https://fastapi.tiangolo.com/) conventions, meaning that you'll be creating **endpoints**.
|
||||
|
||||
The Cookiecutter template generates for you a `router.py` file with a set of examples that you can follow, namely:
|
||||
|
||||
- Perform a simple `GET` and `POST` request - without worrying on any custom data definition.
|
||||
- Using a custom data definition so you get your data the exact way you want it.
|
||||
|
||||
You can expect the following endpoint structure when using a `Fetcher` to serve the data:
|
||||
|
||||
```python
|
||||
@router.command(model="Example")
|
||||
def model_example(
|
||||
cc: CommandContext,
|
||||
provider_choices: ProviderChoices,
|
||||
standard_params: StandardParams,
|
||||
extra_params: ExtraParams,
|
||||
) -> OBBject[BaseModel]:
|
||||
"""Example Data."""
|
||||
return OBBject(results=Query(**locals()).execute())
|
||||
```
|
||||
|
||||
Let's break it down:
|
||||
|
||||
- `@router.command(...)` - this tells the OpenBB Platform that this is a command.
|
||||
- `model="Example"` - this is the name of the `Fetcher` dictionary key that you've defined in the `__init__.py` file of the `<your_package_name>/<your_module_name>` folder.
|
||||
- `cc: CommandContext` - this contains a set of user and system settings that is useful during the execution of the command - eg. api keys.
|
||||
- `provider_choices: ProviderChoices` - all the providers that implement the `Example` `Fetcher`.
|
||||
- `standard_params: StandardParams` - standardized parameters that are common to all providers that implement the `Example` `Fetcher`.
|
||||
- `extra_params: ExtraParams` - it contains the provider specific arguments that are not standardized.
|
||||
|
||||
You only need to change the `model` parameter to the name of the `Fetcher` dictionary key and everything else will be handled by the OpenBB Platform.
|
||||
25
website/content/platform/contributing/extension-development/index.md
vendored
Normal file
25
website/content/platform/contributing/extension-development/index.md
vendored
Normal file
@@ -0,0 +1,25 @@
|
||||
---
|
||||
title: Extension Development
|
||||
sidebar_position: 1
|
||||
description: Learn how to develop Extensions inside the OpenBB Platform.
|
||||
keywords: [openbb platform, introduction, extensions, contributing, documentation]
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Extension Development - Platform | OpenBB Docs" />
|
||||
|
||||
We have a Cookiecutter template that will help you get started. It serves as a jumpstart for your extensions development, so you can focus on the data and not on the boilerplate.
|
||||
|
||||
Please refer to the [Cookiecutter template](https://github.com/OpenBB-finance/openbb-cookiecutter) and follow the instructions there.
|
||||
|
||||
This section will walk you through the steps of adding a new extension to the OpenBB Platform.
|
||||
|
||||
The high level steps are:
|
||||
|
||||
- Generate the extension structure
|
||||
- Install your dependencies
|
||||
- Install your new package
|
||||
- Use your extension (either from Python or the API interface)
|
||||
- QA your extension
|
||||
- Share your extension with the community
|
||||
91
website/content/platform/contributing/extension-development/qa.md
vendored
Normal file
91
website/content/platform/contributing/extension-development/qa.md
vendored
Normal file
@@ -0,0 +1,91 @@
|
||||
---
|
||||
title: Extension QA
|
||||
sidebar_position: 3
|
||||
description: Learn how to QA your extension.
|
||||
keywords: [openbb platform, introduction, qa, contributing, extension, documentation]
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="How to QA your extension - Platform | OpenBB Docs" />
|
||||
|
||||
We are strong believers in the QA process and we want to make sure that all the extensions that are added to the OpenBB Platform are of high quality. To ensure this, we have a set of QA tools that you can use to test your extension.
|
||||
|
||||
Primarily, we have tools that semi-automate the creation of unit and integration tests.
|
||||
|
||||
> The QA tools are still in development and we are constantly improving them.
|
||||
|
||||
## Unit tests
|
||||
|
||||
Each `Fetcher` comes equipped with a `test` method that will ensure that it is implemented correctly and that it is returning the expected data. It also ensures that all types are correct and that the data is valid.
|
||||
|
||||
To create unit tests for your Fetchers, you can run the following command:
|
||||
|
||||
```bash
|
||||
python openbb_platform/providers/tests/utils/unit_test_generator.py
|
||||
```
|
||||
|
||||
> Note that you should be running this file from the root of the repository.
|
||||
|
||||
The automatic unit test generation will add unit tests for all the fetchers available in a given provider.
|
||||
|
||||
> Note that sometimes manual intervention is needed. For example, adjusting out-of-top level imports or adding specific arguments for a given fetcher.
|
||||
|
||||
## Integration tests
|
||||
|
||||
The integration tests are a bit more complex than the unit tests, as we want to test both the Python interface and the API interface. For this, we have two scripts that will help you generate the integration tests.
|
||||
|
||||
To generate the integration tests for the Python interface, you can run the following command:
|
||||
|
||||
```bash
|
||||
python openbb_platform/extensions/tests/utils/integration_tests_generator.py
|
||||
```
|
||||
|
||||
To generate the integration tests for the API interface, you can run the following command:
|
||||
|
||||
```bash
|
||||
python openbb_platform/extensions/tests/utils/integration_tests_api_generator.py
|
||||
```
|
||||
|
||||
When testing the API interface, you'll need to run the OpenBB Platform locally before running the tests. To do so, you can run the following command:
|
||||
|
||||
```bash
|
||||
uvicorn openbb_platform.platform.core.openbb_core.api.rest_api:app --host 0.0.0.0 --port 8000 --reload
|
||||
```
|
||||
|
||||
These automated tests are a great way to reduce the amount of code you need to write, but they are not a replacement for manual testing and might require tweaking. That's why we have unit tests that test the generated integration tests to ensure they cover all providers and parameters.
|
||||
|
||||
To run the tests we can do:
|
||||
|
||||
- Unit tests only:
|
||||
|
||||
```bash
|
||||
pytest openbb_platform -m "not integration"
|
||||
```
|
||||
|
||||
- Integration tests only:
|
||||
|
||||
```bash
|
||||
pytest openbb_platform -m integration
|
||||
```
|
||||
|
||||
- Both integration and unit tests:
|
||||
|
||||
```bash
|
||||
pytest openbb_platform
|
||||
```
|
||||
|
||||
## Import time
|
||||
|
||||
We aim to have a short import time for the package. To measure that we use `tuna`.
|
||||
|
||||
- <https://pypi.org/project/tuna/>
|
||||
|
||||
To visualize the import time breakdown by module and find potential bottlenecks, run the
|
||||
following commands from `openbb_platform` directory:
|
||||
|
||||
```bash
|
||||
pip install tuna
|
||||
python -X importtime openbb/__init__.py 2> import.log
|
||||
tuna import.log
|
||||
```
|
||||
56
website/content/platform/contributing/extension-development/share_extension.md
vendored
Normal file
56
website/content/platform/contributing/extension-development/share_extension.md
vendored
Normal file
@@ -0,0 +1,56 @@
|
||||
---
|
||||
title: Share your extension
|
||||
sidebar_position: 4
|
||||
description: How to share your extension with the community.
|
||||
keywords: [openbb platform, introduction, share, extension, contributing,
|
||||
documentation, PyPI, community]
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Share your extension - Platform | OpenBB Docs" />
|
||||
|
||||
We encourage you to share your extension with the community. You can do that by publishing it to PyPI.
|
||||
|
||||
## Publish your extension to PyPI
|
||||
|
||||
To publish your extension to PyPI, you'll need to have a PyPI account and a PyPI API token.
|
||||
|
||||
### Setup
|
||||
|
||||
Create an account and get an API token from <https://pypi.org/manage/account/token/>
|
||||
Store the token with
|
||||
|
||||
```bash
|
||||
poetry config pypi-token.pypi pypi-YYYYYYYY
|
||||
```
|
||||
|
||||
### Release
|
||||
|
||||
`cd` into the directory where your extension `pyproject.toml` lives and make sure that the `pyproject.toml` specifies the version tag you want to release and run.
|
||||
|
||||
```bash
|
||||
poetry build
|
||||
```
|
||||
|
||||
This will create a `/dist` folder in the directory, which will contain the `.whl` and `tar.gz` files matching the version to release.
|
||||
|
||||
If you want to test your package locally you can do it with
|
||||
|
||||
```bash
|
||||
pip install dist/openbb_[FILE_NAME].whl
|
||||
```
|
||||
|
||||
### Publish
|
||||
|
||||
To publish your package to PyPI run:
|
||||
|
||||
```bash
|
||||
poetry publish
|
||||
```
|
||||
|
||||
Now, you can pip install your package from PyPI with:
|
||||
|
||||
```bash
|
||||
pip install openbb-some_ext
|
||||
```
|
||||
50
website/content/platform/contributing/index.md
vendored
Normal file
50
website/content/platform/contributing/index.md
vendored
Normal file
@@ -0,0 +1,50 @@
|
||||
---
|
||||
title: OpenBB Platform - An Introduction
|
||||
sidebar_position: 1
|
||||
description: Learn how to contribute to the OpenBB Platform.
|
||||
keywords: [openbb platform, introduction, contributing, documentation]
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Introduction - Platform | OpenBB Docs" />
|
||||
|
||||
The OpenBB Platform is built by the Open-Source community and is characterized by its core and extensions. The core handles data integration and standardization, while the extensions enable customization and advanced functionalities. The OpenBB Platform is designed to be used both from a Python interface and a REST API.
|
||||
|
||||
The REST API is built on top of FastAPI and can be started by running the following command from the root:
|
||||
|
||||
```bash
|
||||
uvicorn openbb_platform.platform.core.openbb_core.api.rest_api:app --host 0.0.0.0 --port 8000 --reload
|
||||
```
|
||||
|
||||
The Python interfaces we provide to users is the `openbb` python package.
|
||||
|
||||
The code you will find in this package is generated from a script and it is just a wrapper around the `openbb-core` and any installed extensions.
|
||||
|
||||
When the user runs `import openbb`, `from openbb import obb` or other variants, the script that generates the package code is triggered. It detects if there are new openbb extensions installed in the environment and rebuilds the package code accordingly. If new extensions are not found, it just uses the current package version.
|
||||
|
||||
When you are developing chances are you want to manually trigger the package rebuild.
|
||||
|
||||
You can do that with:
|
||||
|
||||
```python
|
||||
python -c "import openbb; openbb.build()"
|
||||
```
|
||||
|
||||
The Python interface can be imported with:
|
||||
|
||||
```python
|
||||
from openbb import obb
|
||||
```
|
||||
|
||||
This section will take you through two types of contributions:
|
||||
|
||||
1. Building a custom extension
|
||||
2. Contributing directly to the OpenBB Platform
|
||||
|
||||
Before moving forward, please take a look at the high-level view of the OpenBB Platform architecture. We will go over each bit in the following sections.
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/OpenBB-finance/OpenBBTerminal/assets/74266147/c9a5a92a-28b6-4257-aefc-deaebe635c6a"/>
|
||||
<img alt="OpenBB Platform High-Level Architecture" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/74266147/c9a5a92a-28b6-4257-aefc-deaebe635c6a"/>
|
||||
</picture>
|
||||
4
website/content/platform/contributing/introduction/_category_.json
vendored
Normal file
4
website/content/platform/contributing/introduction/_category_.json
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Introduction",
|
||||
"position": 1
|
||||
}
|
||||
69
website/content/platform/contributing/introduction/data_standardization.md
vendored
Normal file
69
website/content/platform/contributing/introduction/data_standardization.md
vendored
Normal file
@@ -0,0 +1,69 @@
|
||||
---
|
||||
title: Data Standardization
|
||||
sidebar_position: 1
|
||||
description: Learn what is data standardization and how does it work inside the OpenBB Platform.
|
||||
keywords: [openbb platform, introduction, data standardization, contributing, documentation]
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Data Standardization - Platform | OpenBB Docs" />
|
||||
|
||||
The Standardization Framework is a set of tools and guidelines that enable the user to query and obtain data in a consistent way across multiple providers.
|
||||
|
||||
Each data model should inherit from a [standard data](https://github.com/OpenBB-finance/OpenBBTerminal/tree/feature/openbb-sdk-v4/openbb_platform/platform/provider/openbb_provider/standard_models) model that is already defined inside the OpenBB Platform. All standard models are created and maintained by the OpenBB team.
|
||||
|
||||
Usage of these models will unlock a set of perks that are only available to standardized data, namely:
|
||||
|
||||
- Can query and output data in a standardized way.
|
||||
- Can expect extensions that follow standardization to work out-of-the-box.
|
||||
- Can expect transparently defined schemas for the data that is returned by the API.
|
||||
- Can expect consistent data types and validation.
|
||||
- Will work seamlessly with other providers that use the same standard model.
|
||||
|
||||
The standard models are defined under the `./platform/core/provider/openbb_provider/standard_models/` directory.
|
||||
|
||||
They define the [`QueryParams`](https://github.com/OpenBB-finance/OpenBBTerminal/tree/feature/openbb-sdk-v4/openbb_platform/platform/provider/openbb_provider/abstract/query_params.py) and [`Data`](https://github.com/OpenBB-finance/OpenBBTerminal/tree/feature/openbb-sdk-v4/openbb_platform/platform/provider/openbb_provider/abstract/data.py) models, which are used to query and output data. They are pydantic and you can leverage all the pydantic features such as validators.
|
||||
|
||||
## Standardization Caveats
|
||||
|
||||
The standardization framework is a very powerful tool, but it has some caveats that you should be aware of:
|
||||
|
||||
- We standardize fields that are shared between two or more providers. If there is a third provider that doesn't share the same fields, we will declare it as an `Optional` field.
|
||||
- When mapping the column names from a provider-specific model to the standard model, the CamelCase to snake_case conversion is done automatically. If the column names are not the same, you'll need to manually map them. (e.g. `o` -> `open`)
|
||||
- The standard models are created and maintained by the OpenBB team. If you want to add a new field to a standard model, you'll need to open a PR to the OpenBB Platform.
|
||||
|
||||
## Standard QueryParams Example
|
||||
|
||||
```python
|
||||
class StockHistoricalQueryParams(QueryParams):
|
||||
"""Stock end of day Query."""
|
||||
symbol: str = Field(description=QUERY_DESCRIPTIONS.get("symbol", ""))
|
||||
start_date: Optional[date] = Field(
|
||||
description=QUERY_DESCRIPTIONS.get("start_date", ""), default=None
|
||||
)
|
||||
end_date: Optional[date] = Field(
|
||||
description=QUERY_DESCRIPTIONS.get("end_date", ""), default=None
|
||||
)
|
||||
```
|
||||
|
||||
The `QueryParams` is an abstract class that just tells us that we are dealing with query parameters
|
||||
|
||||
The OpenBB Platform dynamically knows where the standard models begin in the inheritance tree, so you don't need to worry about it.
|
||||
|
||||
## Standard Data Example
|
||||
|
||||
```python
|
||||
class StockHistoricalData(Data):
|
||||
"""Stock end of day price Data."""
|
||||
|
||||
date: datetime = Field(description=DATA_DESCRIPTIONS.get("date", ""))
|
||||
open: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("open", ""))
|
||||
high: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("high", ""))
|
||||
low: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("low", ""))
|
||||
close: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("close", ""))
|
||||
volume: float = Field(description=DATA_DESCRIPTIONS.get("volume", ""))
|
||||
vwap: Optional[PositiveFloat] = Field(description=DATA_DESCRIPTIONS.get("vwap", ""), default=None)
|
||||
```
|
||||
|
||||
The `Data` class is an abstract class that tells us the expected output data. Here we can see a `vwap` field that is `Optional`. This is because not all providers share this field while it is shared between two or more providers.
|
||||
24
website/content/platform/contributing/introduction/extensions.md
vendored
Normal file
24
website/content/platform/contributing/introduction/extensions.md
vendored
Normal file
@@ -0,0 +1,24 @@
|
||||
---
|
||||
title: Extensions in the OpenBB Platform
|
||||
sidebar_position: 2
|
||||
description: Learn about the Extensions inside the OpenBB Platform.
|
||||
keywords: [openbb platform, introduction, extensions, contributing, documentation]
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Extensions - Platform | OpenBB Docs" />
|
||||
|
||||
Extensions add functionality to the OpenBB Platform. They can be a new data source, a new command, a new visualization, etc.
|
||||
|
||||
## Types of extensions
|
||||
|
||||
We primarily have 3 types of extensions:
|
||||
|
||||
1. OpenBB Extensions - built and maintained by the OpenBB team (e.g. `openbb-stocks`)
|
||||
2. Community Extensions - built by anyone and primarily maintained by OpenBB (e.g. `openbb-yfinance`)
|
||||
3. Independent Extensions - built and maintained independently by anyone
|
||||
|
||||
If your extension is of high quality and you think that it would be a good community extension, you can open a PR to the OpenBB Platform repository and we'll review it.
|
||||
|
||||
We encourage independent extensions to be shared with the community by publishing them to PyPI.
|
||||
4
website/content/platform/contributing/platform-development/_category_.json
vendored
Normal file
4
website/content/platform/contributing/platform-development/_category_.json
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Platform Development",
|
||||
"position": 3
|
||||
}
|
||||
140
website/content/platform/contributing/platform-development/add_data_point.md
vendored
Normal file
140
website/content/platform/contributing/platform-development/add_data_point.md
vendored
Normal file
@@ -0,0 +1,140 @@
|
||||
---
|
||||
title: Add a new data point
|
||||
sidebar_position: 3
|
||||
description: Learn how to add a new data point to the OpenBB Platform.
|
||||
keywords: [openbb platform, introduction, data point, contributing, documentation,
|
||||
provider, QueryParams, Data, Fetcher, transform, extract]
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Add a new data point - Platform | OpenBB Docs" />
|
||||
|
||||
In this section, we'll be adding a new data point to the OpenBB Platform. We will add a new provider with an existing [standard data](https://github.com/OpenBB-finance/OpenBBTerminal/tree/feature/openbb-sdk-v4/openbb_platform/platform/provider/openbb_provider/standard_models) model.
|
||||
|
||||
## Identify which type of data you want to add
|
||||
|
||||
In this example, we'll be adding OHLC stock data that is used by the `obb.stocks.load` command.
|
||||
|
||||
Note that, if no command exists for your data, we need to add one under the right router.
|
||||
Each router is categorized under different extensions (stocks, forex, crypto, etc.).
|
||||
|
||||
### Check if the standard model exists
|
||||
|
||||
Given the fact that there's already an endpoint for OHLCV stock data, we can check if the standard exists.
|
||||
|
||||
In this case, it's `StockHistorical` which can be found inside the `./platform/core/provider/openbb_provider/standard_models/` directory.
|
||||
|
||||
If the standard model doesn't exist:
|
||||
|
||||
- you won't need to inherit from it in the next steps.
|
||||
- all your provider query parameters will be under the `**kwargs` in the python interface.
|
||||
- it might not work out-of-the box with other extensions that follow standardization e.g. the `charting` extension
|
||||
|
||||
### Create Query Parameters model
|
||||
|
||||
Query Parameters are the parameters that are passed to the API endpoint in order to make the request.
|
||||
|
||||
For the `StockHistorical` example, this would look like the following:
|
||||
|
||||
```python
|
||||
|
||||
class <ProviderName>StockHistoricalQueryParams(StockHistoricalQueryParams):
|
||||
"""<ProviderName> Stock Historical Query.
|
||||
|
||||
Source: https://www.<provider_name>.co/documentation/
|
||||
"""
|
||||
|
||||
# provider specific query parameters if any
|
||||
|
||||
```
|
||||
|
||||
### Create Data Output model
|
||||
|
||||
The data output is the data that is returned by the API endpoint.
|
||||
For the `StockHistorical` example, this would look like the following:
|
||||
|
||||
```python
|
||||
|
||||
class <ProviderName>StockHistoricalData(StockHistoricalData):
|
||||
"""<ProviderName> Stock End of Day Data.
|
||||
|
||||
Source: https://www.<provider_name>.co/documentation/
|
||||
"""
|
||||
|
||||
# provider specific data output fields if any
|
||||
|
||||
```
|
||||
|
||||
> Note that, since `StockHistoricalData` inherits from pydantic's `BaseModel`, we can leverage validators to perform additional checks on the output model. A very good example of this, would be to transform a string date into a datetime object.
|
||||
|
||||
### Build the Fetcher
|
||||
|
||||
The `Fetcher` class is responsible for making the request to the API endpoint and providing the output.
|
||||
|
||||
It will receive the Query Parameters, and it will return the output while leveraging the pydantic model schemas.
|
||||
|
||||
For the `StockHistorical` example, this would look like the following:
|
||||
|
||||
```python
|
||||
class <ProviderName>StockHistoricalFetcher(
|
||||
Fetcher[
|
||||
<ProviderName>StockHistoricalQueryParams,
|
||||
List[<ProviderName>StockHistoricalData],
|
||||
]
|
||||
):
|
||||
"""Transform the query, extract and transform the data."""
|
||||
|
||||
@staticmethod
|
||||
def transform_query(params: Dict[str, Any]) -> <ProviderName>StockHistoricalQueryParams:
|
||||
"""Transform the query parameters."""
|
||||
|
||||
return <ProviderName>StockHistoricalQueryParams(**transformed_params)
|
||||
|
||||
@staticmethod
|
||||
def extract_data(
|
||||
query: <ProviderName>StockHistoricalQueryParams,
|
||||
credentials: Optional[Dict[str, str]],
|
||||
**kwargs: Any,
|
||||
) -> dict:
|
||||
"""Return the raw data from the endpoint."""
|
||||
|
||||
obtained_data = my_request(query, credentials, **kwargs)
|
||||
|
||||
return obtained_data
|
||||
|
||||
@staticmethod
|
||||
def transform_data(
|
||||
data: dict,
|
||||
) -> List[<ProviderName>StockHistoricalData]:
|
||||
"""Transform the data to the standard format."""
|
||||
|
||||
return [<ProviderName>StockHistoricalData.model_validate(d) for d in data]
|
||||
```
|
||||
|
||||
> Make sure that you're following the TET pattern when building a `Fetcher` - **Transform, Extract, Transform**.
|
||||
|
||||
## Make the provider visible
|
||||
|
||||
In order to make the new provider visible to the OpenBB Platform, you'll need to add it to the `__init__.py` file of the `providers/<provider_name>/openbb_<provider_name>/` folder.
|
||||
|
||||
```python
|
||||
"""<Provider Name> Provider module."""
|
||||
from openbb_provider.abstract.provider import Provider
|
||||
|
||||
from openbb_<provider_name>.models.stock_eod import <ProviderName>StockHistoricalFetcher
|
||||
|
||||
<provider_name>_provider = Provider(
|
||||
name="<provider_name>",
|
||||
website="<URL to the provider website>",
|
||||
description="Provider description goes here",
|
||||
required_credentials=["api_key"],
|
||||
fetcher_dict={
|
||||
"StockHistorical": <ProviderName>StockHistoricalFetcher,
|
||||
},
|
||||
)
|
||||
```
|
||||
|
||||
If the provider does not require any credentials, you can remove that parameter. On the other hand, if it requires more than 2 items to authenticate, you can add a list of all the required items to the `required_credentials` list.
|
||||
|
||||
After running `pip install .` on `openbb_platform/providers/<provider_name>` your provider should be ready for usage, both from the Python interface and the API.
|
||||
35
website/content/platform/contributing/platform-development/create_pr.md
vendored
Normal file
35
website/content/platform/contributing/platform-development/create_pr.md
vendored
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
title: Create a Pull Request
|
||||
sidebar_position: 5
|
||||
description: Learn how to create a Pull Request to the OpenBB Platform.
|
||||
keywords: [openbb platform, introduction, pull request, contributing, documentation, github]
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Create a Pull Request - Platform | OpenBB Docs" />
|
||||
|
||||
To create a Pull Request to the OpenBB Platform, you'll need to fork the repository and create a new branch.
|
||||
|
||||
1. Create your Feature Branch, e.g. `git checkout -b feature/AmazingFeature`
|
||||
2. Check the files you have touched using `git status`
|
||||
3. Stage the files you want to commit, e.g.
|
||||
`git add openbb_terminal/stocks/stocks_controller.py openbb_terminal/stocks/stocks_helper.py`.
|
||||
Note: **DON'T** add any files with personal information.
|
||||
4. Write a concise commit message under 50 characters, e.g. `git commit -m "meaningful commit message"`. If your PR
|
||||
solves an issue raised by a user, you may specify such issue by adding #ISSUE_NUMBER to the commit message, so that
|
||||
these get linked. Note: If you installed pre-commit hooks and one of the formatters re-formats your code, you'll need
|
||||
to go back to step 3 to add these.
|
||||
|
||||
## Install pre-commit hooks
|
||||
|
||||
To install pre-commit hooks, run `pre-commit install` in the root of the repository.
|
||||
|
||||
## Branch Naming Conventions
|
||||
|
||||
The accepted branch naming conventions are:
|
||||
|
||||
- `feature/feature-name`
|
||||
- `hotfix/hotfix-name`
|
||||
|
||||
These branches can only have PRs pointing to the `develop` branch.
|
||||
64
website/content/platform/contributing/platform-development/environments_dependencies.md
vendored
Normal file
64
website/content/platform/contributing/platform-development/environments_dependencies.md
vendored
Normal file
@@ -0,0 +1,64 @@
|
||||
---
|
||||
title: Setup your development environment
|
||||
sidebar_position: 2
|
||||
description: Learn how to setup your development environment for the OpenBB Platform.
|
||||
keywords: [openbb platform, introduction, environment, setup, contributing, documentation]
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Environment Setup - Platform | OpenBB Docs" />
|
||||
|
||||
In order to contribute to the OpenBB Platform, you need to setup your environment to ensure a smooth development experience.
|
||||
|
||||
<details>
|
||||
<summary>Need help setting up Miniconda or Git?</summary>
|
||||
|
||||
Sometimes, installing Miniconda or Git can be a bit tricky, so we've prepared a set of instructions to help you get started.
|
||||
|
||||
Please refer to [OpenBBTerminal docs](https://docs.openbb.co/terminal/installation/source) for more information.
|
||||
</details>
|
||||
|
||||
1. Clone the repository:
|
||||
|
||||
```bash
|
||||
git clone git@github.com:OpenBB-finance/OpenBBTerminal.git
|
||||
```
|
||||
|
||||
2. Create and activate a virtual environment:
|
||||
|
||||
> Supported python versions: python = ">=3.8,<3.12"
|
||||
|
||||
```bash
|
||||
conda create -n "obb-dev" python=3.9.13
|
||||
conda activate obb-dev
|
||||
```
|
||||
|
||||
3. Manage your environment with [Poetry](https://python-poetry.org/):
|
||||
|
||||
```bash
|
||||
pip install poetry
|
||||
```
|
||||
|
||||
4. Install the packages using the `dev_install.py` script located in the `openbb_platform` folder:
|
||||
|
||||
```bash
|
||||
python dev_install.py
|
||||
```
|
||||
|
||||
> To install all the packages, including extras, use the `-e` argument with the above script.
|
||||
|
||||
5. Setup your API keys locally by adding them to 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"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
> You can also setup and use your keys from the OpenBB Hub and the Python interface at runtime. Follow the steps in [API Keys](./README.md#api-keys) section to know more about it.
|
||||
16
website/content/platform/contributing/platform-development/index.md
vendored
Normal file
16
website/content/platform/contributing/platform-development/index.md
vendored
Normal file
@@ -0,0 +1,16 @@
|
||||
---
|
||||
title: OpenBB Platform Development
|
||||
sidebar_position: 1
|
||||
description: Introduction to the OpenBB Platform.
|
||||
keywords: [openbb platform, introduction, development, contributing, documentation]
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="OpenBB Platform Development - Platform | OpenBB Docs" />
|
||||
|
||||
There are many ways to contribute to the OpenBB Platform. You can add a new data point, add a new command, add a new visualization, add a new extension, fix a bug etc.
|
||||
|
||||
In this section, we'll be focusing on adding a new data point to the OpenBB Platform.
|
||||
|
||||
Before that, we will need to setup our development environment.
|
||||
38
website/content/platform/contributing/platform-development/manage_extensions.md
vendored
Normal file
38
website/content/platform/contributing/platform-development/manage_extensions.md
vendored
Normal file
@@ -0,0 +1,38 @@
|
||||
---
|
||||
title: Manage Extensions
|
||||
sidebar_position: 4
|
||||
description: Learn how to manage extensions in the OpenBB Platform.
|
||||
keywords: [openbb, platform, introduction, manage extensions, contributing,
|
||||
documentation, pypi]
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Manage Extensions - Platform | OpenBB Docs" />
|
||||
|
||||
To install extensions hosted on PyPI, use the `pip install <extension>` command.
|
||||
|
||||
To install an extension that is developed locally, ensure that it contains a `pyproject.toml` file and then use the `pip install <extension>` command.
|
||||
|
||||
> To install the extension in editable mode using pip, add the `-e` argument.
|
||||
|
||||
Alternatively, for local extensions, you can add this line in the `LOCAL_DEPS` variable in `dev_install.py` file:
|
||||
|
||||
```toml
|
||||
# If this is a community dependency, add this under "Community dependencies",
|
||||
# with additional argument optional = true
|
||||
openbb-extension = { path = "<relative-path-to-the-extension>", develop = true }
|
||||
```
|
||||
|
||||
Now you can use the `python dev_install.py [-e]` command to install the local extension.
|
||||
|
||||
## Add an extension as a dependency
|
||||
|
||||
To add the `openbb-qa` extension as a dependency, you'll need to add it to the `pyproject.toml` file:
|
||||
|
||||
```toml
|
||||
[tool.poetry.dependencies]
|
||||
openbb-qa = "^0.0.0a2"
|
||||
```
|
||||
|
||||
Then you can follow the same process as above to install the extension.
|
||||
@@ -377,7 +377,7 @@ openbb.keys.finnhub(key = 'REPLACE_WITH_KEY', persist = True)
|
||||
|
||||
### Financial Modeling Prep
|
||||
|
||||
> Enchance your application with our data that goes up to 30 years back in history. Earnings calendar, financial statements, multiple exchanges and more!
|
||||
> Enhance your application with our data that goes up to 30 years back in history. Earnings calendar, financial statements, multiple exchanges and more!
|
||||
|
||||
<details>
|
||||
<summary>Instructions</summary>
|
||||
|
||||
2
website/content/platform/usage/index.md
vendored
2
website/content/platform/usage/index.md
vendored
@@ -76,7 +76,7 @@ jupyter lab
|
||||
|
||||
Or
|
||||
|
||||
```cosole
|
||||
```console
|
||||
conda activate obb
|
||||
jupyter notebook
|
||||
```
|
||||
|
||||
@@ -75,7 +75,7 @@ These signals offer a good starting point, and results can be narrowed by creati
|
||||
|
||||
:::note
|
||||
|
||||
Refer to the template file [here](https://github.com/OpenBB-finance/OpenBBTerminal/files/11153280/all_parameters.txt) for all of the available parameters and accpeted values.
|
||||
Refer to the template file [here](https://github.com/OpenBB-finance/OpenBBTerminal/files/11153280/all_parameters.txt) for all of the available parameters and accepted values.
|
||||
|
||||
All of the included presets can be viewed online [here](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/miscellaneous/stocks/screener)
|
||||
:::
|
||||
|
||||
@@ -39,7 +39,7 @@ openbb.forecast.trans(data: Union[pd.Series, pd.DataFrame], target_column: str =
|
||||
| num_decoder_layers | int | The number of decoder layers in the encoder. Defaults to 3. | 3 | True |
|
||||
| dim_feedforward | int | The dimension of the feedforward network model. Defaults to 512. | 512 | True |
|
||||
| activation | str | The activation function of encoder/decoder intermediate layer, ‘relu’ or ‘gelu’. Defaults to 'relu'. | relu | True |
|
||||
| dropout | float | Fraction of neurons afected by Dropout. Defaults to 0.0. | 0.0 | True |
|
||||
| dropout | float | Fraction of neurons affected by Dropout. Defaults to 0.0. | 0.0 | True |
|
||||
| batch_size | int | Number of time series (input and output sequences) used in each training pass. Defaults to 32. | 32 | True |
|
||||
| n_epochs | int | Number of epochs over which to train the model. Defaults to 100. | 100 | True |
|
||||
| learning_rate | float | Defaults to 1e-3. | 0.001 | True |
|
||||
@@ -117,4 +117,4 @@ This function does not return anything
|
||||
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
</Tabs>
|
||||
|
||||
@@ -76,7 +76,7 @@ jupyter lab
|
||||
|
||||
Or
|
||||
|
||||
```cosole
|
||||
```console
|
||||
conda activate obb
|
||||
jupyter notebook
|
||||
```
|
||||
@@ -152,7 +152,7 @@ Call signature: openbb.stocks.gov.contracts(*args: Any, **kwargs: Any) -> Any
|
||||
Type: get_contracts
|
||||
String form: <openbb_terminal.stocks.government.quiverquant_model.Operation object at 0x2b57d0700>
|
||||
File: ~/GitHub/OpenBBTerminal/openbb_terminal/stocks/government/quiverquant_model.py
|
||||
Docstring:
|
||||
Docstring:
|
||||
Get government contracts for ticker [Source: quiverquant.com]
|
||||
|
||||
Parameters
|
||||
|
||||
@@ -397,7 +397,7 @@ openbb.keys.finnhub(key = 'REPLACE_WITH_KEY', persist = True)
|
||||
|
||||
### Financial Modeling Prep
|
||||
|
||||
> Enchance your application with our data that goes up to 30 years back in history. Earnings calendar, financial statements, multiple exchanges and more!
|
||||
> Enhance your application with our data that goes up to 30 years back in history. Earnings calendar, financial statements, multiple exchanges and more!
|
||||
|
||||
<details>
|
||||
<summary>Instructions</summary>
|
||||
|
||||
@@ -75,7 +75,7 @@ These signals offer a good starting point, and results can be narrowed by creati
|
||||
|
||||
:::note
|
||||
|
||||
Refer to the template file [here](https://github.com/OpenBB-finance/OpenBBTerminal/files/11153280/all_parameters.txt) for all of the available parameters and accpeted values.
|
||||
Refer to the template file [here](https://github.com/OpenBB-finance/OpenBBTerminal/files/11153280/all_parameters.txt) for all of the available parameters and accepted values.
|
||||
|
||||
All of the included presets can be viewed online [here](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/miscellaneous/stocks/screener)
|
||||
:::
|
||||
|
||||
@@ -346,7 +346,7 @@ Add this key to the OpenBB Terminal by entering:
|
||||
|
||||
### Financial Modeling Prep
|
||||
|
||||
> Enchance your application with our data that goes up to 30 years back in history. Earnings calendar, financial statements, multiple exchanges and more!
|
||||
> Enhance your application with our data that goes up to 30 years back in history. Earnings calendar, financial statements, multiple exchanges and more!
|
||||
|
||||
<details>
|
||||
<summary>Instructions</summary>
|
||||
|
||||
@@ -240,7 +240,7 @@ load qqq -i 1 -s 2023-04-21/macd
|
||||
|
||||
The Accumulation/Distribution Line at the same one-minute interval signals in advance of the upward drift reversal, beginning to sell into the Friday close just before 14:00.
|
||||
|
||||
|
||||
|
||||
|
||||
## Indicators Dashboard
|
||||
|
||||
|
||||
@@ -56,7 +56,7 @@ The default preset upon entering the sub-menu is, `top_gainers`. This preset, l
|
||||
|
||||
These signals offer a good starting point, and results can be narrowed by creating a custom preset with defined parameters. Place new presets (which are text files saved as an `.ini` type) in the OpenBBUserData folder: `~/OpenBBUserData/presets/stocks/screener`. Files saved here will populate as a choice the next time the Terminal is launched. The next section provides guidance for using and creating presets.
|
||||
|
||||
:::note Refer to the template file [here](https://github.com/OpenBB-finance/OpenBBTerminal/files/11153280/all_parameters.txt) for all of the available parameters and accpeted values.
|
||||
:::note Refer to the template file [here](https://github.com/OpenBB-finance/OpenBBTerminal/files/11153280/all_parameters.txt) for all of the available parameters and accepted values.
|
||||
|
||||
All of the included presets can be viewed online [here](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/miscellaneous/stocks/screener)
|
||||
:::
|
||||
|
||||
540
website/yarn.lock
vendored
540
website/yarn.lock
vendored
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user