Update readme

This commit is contained in:
Theodore Aptekarev
2023-07-13 12:49:56 +02:00
parent 1145f07852
commit 720ad7f35e

35
openbb_sdk/README.md vendored
View File

@@ -17,7 +17,13 @@ To develop you need:
## Installation
This will install the SDK in the virtual environment.
To install the SDK in the virtual environment from the repo root run:
```bash
pip install ./openbb-sdk
```
This will install the SDK and all the dependencies into the site-packages folder of the virtual environment.
When working with the source code of the SDK it is required to create the static python interface:
@@ -27,6 +33,27 @@ openbb._rebuild_python_interface()
exit()
```
## API keys
To connect to APIs you need to provide the API keys.
When developing locally you can specify your keys in the `~/.openbb_sdk/user_settings.json`.
Create this file with the following contents:
```json
{
"credentials": {
"fmp_api_key": "REPLACE_ME",
"polygon_api_key": "REPLACE_ME",
"benzinga_api_key": "REPLACE_ME",
"fred_api_key": "REPLACE_ME"
}
}
```
Then add your API keys there and it should work.
## Python Usage
Import and basic usage:
@@ -38,12 +65,6 @@ Import and basic usage:
df.head()
```
API keys:
To connect to APIs you need to provide the API keys.
## API Usage
Launch the API with: