mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-27 04:31:13 +00:00
Improve README with workspace integration (#7123)
* Improve README with workspace integration * Improve README with workspace integration (#7122) * update image
This commit is contained in:
52
README.md
vendored
52
README.md
vendored
@@ -15,24 +15,50 @@
|
|||||||
</a>
|
</a>
|
||||||
[](https://pypi.org/project/openbb/)
|
[](https://pypi.org/project/openbb/)
|
||||||
|
|
||||||
The first financial Platform that is free and fully open source.
|
The first financial Platform that is open source.
|
||||||
|
|
||||||
The OpenBB Platform offers access to equity, options, crypto, forex, macro economy, fixed income, and more while also offering a broad range of extensions to enhance the user experience according to their needs.
|
The OpenBB Platform offers access to equity, options, crypto, forex, macro economy, fixed income, and more while also offering a broad range of extensions to enhance the user experience according to their needs.
|
||||||
|
|
||||||
Sign up to the [OpenBB Hub](https://my.openbb.co/login) to get the most out of the OpenBB ecosystem.
|
Get started with: `pip install openbb`
|
||||||
|
|
||||||
|
```python
|
||||||
|
from openbb import obb
|
||||||
|
output = obb.equity.price.historical("AAPL")
|
||||||
|
df = output.to_dataframe()
|
||||||
|
```
|
||||||
|
|
||||||
|
You can sign up to the [OpenBB Hub](https://my.openbb.co/login) to get the most out of the OpenBB ecosystem.
|
||||||
|
|
||||||
|
Data integrations available can be found here: <https://docs.openbb.co/platform/reference>
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
If you are looking for our **FREE** AI-powered Research and Analytics Workspace, you can find it here: [pro.openbb.co](https://pro.openbb.co).
|
## OpenBB Workspace
|
||||||
|
|
||||||
|
While the OpenBB Platform is all about an integration to dozens of different data vendors, the interface is either Python or a CLI.
|
||||||
|
|
||||||
|
If you want an enterprise UI to visualize this datasets and use AI agents on top, you can find OpenBB Workspace at <https://pro.openbb.co>.
|
||||||
|
|
||||||
<a href="https://pro.openbb.co">
|
<a href="https://pro.openbb.co">
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<img src="https://openbb.co/api/image?src=https%3A%2F%2Fopenbb-cms.directus.app%2Fassets%2Ff431ed60-5e46-439a-a9f7-4b06e72d0720.png&width=2400&height=1552&fit=cover&position=center&background[]=0&background[]=0&background[]=0&background[]=0&quality=100&compressionLevel=9&loop=0&delay=100&crop=null" alt="Logo" width="600">
|
<img src="https://openbb-cms.directus.app/assets/f69b6aaf-0821-4bc8-a43c-715e03a924ef.png" alt="Logo" width="1000">
|
||||||
</div>
|
</div>
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
Data integration:
|
||||||
|
|
||||||
|
- You can learn more about adding data to the OpenBB workspace from the [docs](https://docs.openbb.co/workspace) or [this open source repository](https://github.com/OpenBB-finance/backends-for-openbb).
|
||||||
|
|
||||||
|
AI Agents integration:
|
||||||
|
|
||||||
|
- You can learn more about adding AI agents to the OpenBB workspace from [this open source repository](https://github.com/OpenBB-finance/agents-for-openbb).
|
||||||
|
|
||||||
|
### Integrating OpenBB Platform to the OpenBB Workspace
|
||||||
|
|
||||||
Connect this library to the OpenBB Workspace with a few simple commands, in a Python (3.9.21 - 3.12) environment.
|
Connect this library to the OpenBB Workspace with a few simple commands, in a Python (3.9.21 - 3.12) environment.
|
||||||
|
|
||||||
|
#### Run OpenBB Platform backend
|
||||||
|
|
||||||
- Install the packages.
|
- Install the packages.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
@@ -47,15 +73,23 @@ openbb-api
|
|||||||
|
|
||||||
This will launch a FastAPI server, via Uvicorn, at `127.0.0.1:6900`.
|
This will launch a FastAPI server, via Uvicorn, at `127.0.0.1:6900`.
|
||||||
|
|
||||||
- Sign-in to the [Workspace](https://pro.openbb.co/), and from the sidebar, click "Widgets".
|
You can check that it works by going to <http://127.0.0.1:6900>.
|
||||||
|
|
||||||

|
#### Integrate OpenBB Platform backend to OpenBB Workspace
|
||||||
|
|
||||||
- Click the "Add Data" button, enter the server into the form, click "Test", and then "Add".
|
Sign-in to the [OpenBB Workspace](https://pro.openbb.co/), and follow the following steps:
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
We also have examples of custom AI agents that integrate with the OpenBB Workspace, and that repo can be found [here](https://github.com/OpenBB-finance/agents-for-openbb).
|
1. Go to the "Apps" tab
|
||||||
|
2. Click on "Connect backend"
|
||||||
|
3. Fill in the form with:
|
||||||
|
Name: OpenBB Platform
|
||||||
|
URL: <http://127.0.0.1:6900>
|
||||||
|
4. Click on "Test". You should get a "Test successful" with the number of apps found.
|
||||||
|
5. Click on "Add".
|
||||||
|
|
||||||
|
That's it.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user