From cd19c59ead96c9c9d40c8080d439cc3f9a388dcb Mon Sep 17 00:00:00 2001 From: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Date: Mon, 24 Jul 2023 16:07:36 +0200 Subject: [PATCH] Edits --- openbb_sdk/README.md | 3 --- openbb_sdk/providers/README.md | 3 +-- openbb_sdk/sdk/provider/README.md | 12 ++++++------ 3 files changed, 7 insertions(+), 11 deletions(-) diff --git a/openbb_sdk/README.md b/openbb_sdk/README.md index e3b7fea0a53..862203e5bb6 100644 --- a/openbb_sdk/README.md +++ b/openbb_sdk/README.md @@ -1,7 +1,6 @@ # Table of contents - [Table of contents](#table-of-contents) -- [OpenBB SDK](#openbb-sdk) - [Pre-requisites](#pre-requisites) - [Installation](#installation) - [API keys](#api-keys) @@ -13,8 +12,6 @@ - [Docker](#docker) - [Development](#development) -# OpenBB SDK - ## Pre-requisites To install and use you need: diff --git a/openbb_sdk/providers/README.md b/openbb_sdk/providers/README.md index 017073af663..03a7665fe35 100644 --- a/openbb_sdk/providers/README.md +++ b/openbb_sdk/providers/README.md @@ -11,7 +11,6 @@ All currently supported providers are listed below. | [Benzinga](./benzinga/README.md) | | [FRED](./fred/README.md) | - ## Default Provider Configuration To configure the default providers for each route, edit the `.openbb_sdk/user_settings.json` file in your home directory by adding the `defaults` section, a `routes` subsection and for every route, the default provider desired. A sample is shown below. @@ -38,7 +37,7 @@ To configure the default providers for each route, edit the `.openbb_sdk/user_se Every provider is located within a folder, with the following structure: -``` +```{.bash} openbb_sdk └───providers └─── diff --git a/openbb_sdk/sdk/provider/README.md b/openbb_sdk/sdk/provider/README.md index d616b4a9b8b..729b4c6fb4e 100644 --- a/openbb_sdk/sdk/provider/README.md +++ b/openbb_sdk/sdk/provider/README.md @@ -1,12 +1,12 @@ # Table of contents - [Table of contents](#table-of-contents) -- [provider](#provider) + - [provider](#provider) - [What is Data Standardization?](#what-is-data-standardization) -- [Key Elements](#key-elements) -- [Installation](#installation) + - [Key Elements](#key-elements) + - [Installation](#installation) -# provider +## provider The OpenBB Provider aims to give a coherent access to financial data providers by introducing standardization procedures. @@ -26,7 +26,7 @@ Close for closing price column name in data from one provider might be coded as **Data Cleaning**: we don’t remove errors and inconsistencies from data provider outputs. **Data Transformation & Data Integration**: both transforming data by processing it and integrating data from multiple providers together to harmonize datasets are functions of the SDK and are not handled on a provider level. -# Key Elements +## Key Elements - **QueryParams** : Are input parameters that are used for obtaining data. To load stock market data, we would have StockQueryParams, which would have fields like symbol, start date, and end date. You can find the standard query params inside the `./models` folder. - **Data** : Are outputs. Stock market data would be StockPriceData and have fields such as Open, High, Low, Close, and Volume. You can find the standard data models inside the `./models` folder. @@ -34,7 +34,7 @@ Close for closing price column name in data from one provider might be coded as - **Provider** : An object that is specific to a data provider (i.e. PolygonProvider) which holds Provider attributes and unites all of the provider's fetchers into a list. - **Provider Registry** : An aggregation of all the Provider objects and their API keys. It is the main point of usage and is responsible for dynamically serving the data by finding the correct Provider and Fetcher based on the given QueryParams. -# Installation +## Installation To install the provider, run the following command in this folder: