mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-29 21:42:22 +00:00
68 lines
1.2 KiB
Markdown
Vendored
68 lines
1.2 KiB
Markdown
Vendored
# OpenBB SDK
|
|
|
|
## Pre-requisites
|
|
|
|
To install and use you need:
|
|
|
|
- A fresh virtual environment
|
|
- Python 3.8 or higher
|
|
- API keys for the APIs you want to use
|
|
|
|
To develop you need:
|
|
|
|
- Poetry 1.5.1 or higher
|
|
- ruff 0.0.256
|
|
- mypy 1.4.1
|
|
- black
|
|
|
|
## Installation
|
|
|
|
This will install the SDK in the virtual environment.
|
|
|
|
When working with the source code of the SDK it is required to create the static python interface:
|
|
|
|
```python
|
|
import openbb
|
|
openbb._rebuild_python_interface()
|
|
exit()
|
|
```
|
|
|
|
## Python Usage
|
|
|
|
Import and basic usage:
|
|
|
|
```python
|
|
from openbb import obb
|
|
aapl = obb.stocks.load(symbol="AAPL", start_date="2020-01-01", provider="fmp")
|
|
df = aapl.to_dataframe()
|
|
df.head()
|
|
```
|
|
|
|
API keys:
|
|
|
|
To connect to APIs you need to provide the API keys.
|
|
|
|
|
|
|
|
## API Usage
|
|
|
|
Launch the API with:
|
|
|
|
```bash
|
|
uvicorn openbb_core.api.rest_api:app --host 0.0.0.0 --port 8000 --reload
|
|
```
|
|
|
|
Navigate to http://0.0.0.0:8000/docs to see the swagger API documentation.
|
|
|
|
Authorize with the developer credentials: openbb/openbb
|
|
|
|
## Development
|
|
|
|
From the root of the OpenBB Terminal repo run:
|
|
|
|
`poetry install -C ./openbb_sdk`
|
|
|
|
When developing a specific extension cd into the extension folder and run:
|
|
|
|
`poetry install`
|