diff --git a/openbb_sdk/extensions/charting/README.md b/openbb_sdk/extensions/charting/README.md index e69de29bb2d..e4885115946 100644 --- a/openbb_sdk/extensions/charting/README.md +++ b/openbb_sdk/extensions/charting/README.md @@ -0,0 +1,32 @@ +# OpenBB Charting extension + +This extension provides a charting library for OpenBB SDK. + +The library includes: + +- charting infrastructure based on Plotly and +- a set of charting components +- prebuilt charts for a set of commands that are available in built-in OpenBB SDK extensions + +## Installation + +To install the extension, run the following command in this folder: + +```bash +pip install . +``` + +## PyWry dependency on Linux + +The PyWry dependency handles display of interactive charts and tables in a separate window. It is installed automatically with the OpenBB Charting extension. + +When using linux distributions, the PyWry dependency requires certain dependencies to be installed first. + +Debian-based / Ubuntu / Mint: +`sudo apt install libwebkit2gtk-4.0-dev` + +Arch Linux / Manjaro: +`sudo pacman -S webkit2gtk` + +Fedora: +`sudo dnf install gtk3-devel webkit2gtk3-devel` diff --git a/openbb_sdk/extensions/crypto/README.md b/openbb_sdk/extensions/crypto/README.md index e69de29bb2d..46dfa0e3360 100644 --- a/openbb_sdk/extensions/crypto/README.md +++ b/openbb_sdk/extensions/crypto/README.md @@ -0,0 +1,11 @@ +# Crypto data extension for OpenBB SDK + +This extension provides a set of commands for crypto data retrieval. + +## Installation + +To install the extension, run the following command in this folder: + +```bash +pip install . +``` diff --git a/openbb_sdk/extensions/economy/README.md b/openbb_sdk/extensions/economy/README.md index e69de29bb2d..1c201832058 100644 --- a/openbb_sdk/extensions/economy/README.md +++ b/openbb_sdk/extensions/economy/README.md @@ -0,0 +1,11 @@ +# OpenBB Economy Extension + +The Economy extension provides global macroeconomic data access for the OpenBB SDK. + +## Installation + +To install the extension, run the following command in this folder: + +```bash +pip install . +``` diff --git a/openbb_sdk/extensions/fixedincome/README.md b/openbb_sdk/extensions/fixedincome/README.md index e69de29bb2d..4cc870e1c07 100644 --- a/openbb_sdk/extensions/fixedincome/README.md +++ b/openbb_sdk/extensions/fixedincome/README.md @@ -0,0 +1,13 @@ +# OpenBB Fixed Income Extension + +This extension provides fixed income data for the OpenBB SDK. + +Features of the Fixed Income extension include information on government bonds and central bank rates. + +## Installation + +To install the extension, run the following command in this folder: + +```bash +pip install . +``` diff --git a/openbb_sdk/extensions/forex/README.md b/openbb_sdk/extensions/forex/README.md index e69de29bb2d..9618d2158d6 100644 --- a/openbb_sdk/extensions/forex/README.md +++ b/openbb_sdk/extensions/forex/README.md @@ -0,0 +1,11 @@ +# OpenBB Forex Extension + +This extension provides currency exchange related data for the OpenBB SDK. + +## Installation + +To install the extension, run the following command in this folder: + +```bash +pip install . +``` diff --git a/openbb_sdk/extensions/news/README.md b/openbb_sdk/extensions/news/README.md index e69de29bb2d..a3d86abd556 100644 --- a/openbb_sdk/extensions/news/README.md +++ b/openbb_sdk/extensions/news/README.md @@ -0,0 +1,11 @@ +# OpenBB News Extension + +This extension provides news for the OpenBB SDK. + +## Installation + +To install the extension, run the following command in this folder: + +```bash +pip install . +``` diff --git a/openbb_sdk/extensions/qa/README.md b/openbb_sdk/extensions/qa/README.md index e69de29bb2d..461fa143539 100644 --- a/openbb_sdk/extensions/qa/README.md +++ b/openbb_sdk/extensions/qa/README.md @@ -0,0 +1,15 @@ +# OpenBB QA Extension + +This extension provides Quantitative Analysis (QA) tools for the OpenBB SDK. + +Features of the QA extension include various statistical tools and models. + +This extension works nicely with a companion `openbb-charting` extension + +## Installation + +To install the extension, run the following command in this folder: + +```bash +pip install . +``` diff --git a/openbb_sdk/extensions/stocks/README.md b/openbb_sdk/extensions/stocks/README.md index e69de29bb2d..61c4e6be6ae 100644 --- a/openbb_sdk/extensions/stocks/README.md +++ b/openbb_sdk/extensions/stocks/README.md @@ -0,0 +1,24 @@ +# OpenBB Stocks Extension + +This extension provides stock market data tools for the OpenBB SDK. + +Features of the Stocks extension include: + +- Access to various stock market data sources +- Submenus such as + - `fa` for fundamental analysis + - `dd` for in-depth due diligence + - `disc` for stock discovery + - `dps` for Dark Pool Shorts data + - `ca` for comparison analysis + - `gov` for government contracts data + - `ins` for insiders trading data + - `options` for options + +## Installation + +To install the extension, run the following command in your OpenBB SDK environment: + +```bash +pip install . +``` diff --git a/openbb_sdk/extensions/ta/README.md b/openbb_sdk/extensions/ta/README.md index e69de29bb2d..91f0bb6554a 100644 --- a/openbb_sdk/extensions/ta/README.md +++ b/openbb_sdk/extensions/ta/README.md @@ -0,0 +1,15 @@ +# OpenBB TA Extension + +This extension provides Technical Analysis (TA) tools for the OpenBB SDK. + +Features of the TA extension include various TA indicators and oscillators. + +This extension works nicely with a companion `openbb-charting` extension + +## Installation + +To install the extension, run the following command in this folder: + +```bash +pip install . +```