jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-27 04:31:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update readme (#7248)

Browse Source 
* Update readme images links and wording

* Add odp logos
This commit is contained in:
Theodore Aptekarev
2025-10-22 16:37:38 +03:00
committed by GitHub
parent 82c117fdad
commit 65d174ed43
3 changed files with 56 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.md vendored
View File

@@ -1,6 +1,6 @@
<br />
<img src="https://github.com/OpenBB-finance/OpenBB/blob/develop/images/platform-light.svg?raw=true#gh-light-mode-only" alt="OpenBB Platform logo" width="600">
<img src="https://github.com/OpenBB-finance/OpenBB/blob/develop/images/platform-dark.svg?raw=true#gh-dark-mode-only" alt="OpenBB Platform logo" width="600">
<img src="https://github.com/OpenBB-finance/OpenBB/blob/develop/images/odp-light.svg?raw=true#gh-light-mode-only" alt="Open Data Platform by OpenBB logo" width="600">
<img src="https://github.com/OpenBB-finance/OpenBB/blob/develop/images/odp-dark.svg?raw=true#gh-dark-mode-only" alt="Open Data Platform by OpenBB logo" width="600">
<br />
<br />
@@ -15,9 +15,9 @@
</a>
[![PyPI](https://img.shields.io/pypi/v/openbb?color=blue&label=PyPI%20Package)](https://pypi.org/project/openbb/)
The first financial Platform that is open source.
Open Data Platform by OpenBB (ODP) is the open-source toolset that helps data engineers integrate proprietary, licensed, and public data sources into downstream applications like AI copilots and research dashboards.
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.
ODP operates as the "connect once, consume everywhere" infrastructure layer that consolidates and exposes data to multiple surfaces at once: Python environments for quants, OpenBB Workspace and Excel for analysts, MCP servers for AI agents, and REST APIs for other applications.
Get started with: `pip install openbb`
@@ -27,15 +27,15 @@ output = obb.equity.price.historical("AAPL")
df = output.to_dataframe()
```
Data integrations available can be found here: <https://docs.openbb.co/platform/reference>
Data integrations available can be found here: <https://docs.openbb.co/python/reference>
---
## 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.
While the Open Data Platform provides the open-source data integration foundation, **OpenBB Workspace** offers the enterprise UI for analysts to visualize datasets and leverage AI agents. The platform's "connect once, consume everywhere" architecture enables seamless integration between the two.
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>.
You can find OpenBB Workspace at <https://pro.openbb.co>.
<a href="https://pro.openbb.co">
<div align="center">
@@ -51,11 +51,11 @@ 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
### Integrating Open Data 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.
#### Run OpenBB Platform backend
#### Run an ODP backend
- Install the packages.
@@ -73,7 +73,7 @@ This will launch a FastAPI server, via Uvicorn, at `127.0.0.1:6900`.
You can check that it works by going to <http://127.0.0.1:6900>.
#### Integrate OpenBB Platform Backend to OpenBB Workspace
#### Integrate the ODP Backend to OpenBB Workspace
Sign-in to the [OpenBB Workspace](https://pro.openbb.co/), and follow the following steps:
@@ -82,7 +82,7 @@ Sign-in to the [OpenBB Workspace](https://pro.openbb.co/), and follow the follow
1. Go to the "Apps" tab
2. Click on "Connect backend"
3. Fill in the form with:
Name: OpenBB Platform
Name: Open Data 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".
@@ -107,15 +107,15 @@ That's it.
## 1. Installation
The OpenBB Platform can be installed as a [PyPI package](https://pypi.org/project/openbb/) by running `pip install openbb`
The ODP Python Package can be installed from [PyPI package](https://pypi.org/project/openbb/) by running `pip install openbb`
or by cloning the repository directly with `git clone https://github.com/OpenBB-finance/OpenBB.git`.
Please find more about the installation process, in the [OpenBB Documentation](https://docs.openbb.co/platform/installation).
Please find more about the installation process, in the [OpenBB Documentation](https://docs.openbb.co/python/installation).
### OpenBB Platform CLI installation
### ODP CLI installation
The OpenBB Platform CLI is a command-line interface that allows you to access the OpenBB Platform directly from your command line.
The ODP CLI is a command-line interface that allows you to access the ODP directly from your command line.
It can be installed by running `pip install openbb-cli`
@@ -129,11 +129,11 @@ There are three main ways of contributing to this project. (Hopefully you have s
### Become a Contributor
- More information on our [Contributing Documentation](https://docs.openbb.co/platform/developer_guide/misc/contributing).
- More information on our [Developer Documentation](https://docs.openbb.co/python/developer).
### Create a GitHub ticket
Before creating a ticket make sure the one you are creating doesn't exist already [here](https://github.com/OpenBB-finance/OpenBB/issues)
Before creating a ticket make sure the one you are creating doesn't exist already [among the existing issues](https://github.com/OpenBB-finance/OpenBB/issues)
- [Report bug](https://github.com/OpenBB-finance/OpenBB/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5BBug%5D)
- [Suggest improvement](https://github.com/OpenBB-finance/OpenBB/issues/new?assignees=&labels=enhancement&template=enhancement.md&title=%5BIMPROVE%5D)
@@ -155,7 +155,7 @@ amount, and may not be suitable for all investors.
Before deciding to trade in a financial instrument you should be fully informed of the risks and costs associated with trading the financial markets, carefully consider your investment objectives, level of experience, and risk appetite, and seek professional advice where needed.
The data contained in the OpenBB Platform is not necessarily accurate.
The data contained in the Open Data Platform is not necessarily accurate.
OpenBB and any provider of the data contained in this website will not accept liability for any loss or damage as a result of your trading, or your reliance on the information displayed.

19
images/odp-dark.svg vendored Normal file
View File

@@ -0,0 +1,19 @@
<svg width="249" height="9" viewBox="0 0 249 9" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M6.58831 0.0126953H0V8.0127H7.53062V0.0126953H6.58943H6.58831ZM6.58831 1.51307V7.01284H0.940066V1.01255H6.58831V1.51307Z" fill="#0C0C0E"/>
<path d="M20.5332 0.018648H13.5306V8.0127H14.531V5.01418H21.5335V0.0126953H20.5332V0.018648ZM20.5332 1.51791V4.01865H14.531V1.01776H20.5332V1.51791Z" fill="#0C0C0E"/>
<path d="M34.4889 0.0438232H34.4865H33.9915H33.4954H32.9981H32.502H32.0046H31.5085H31.0112H30.5151H30.0177H29.5216H29.0243H28.5281H28.0308H27.5335V0.540518V1.03603V1.53154V2.02824V2.52493V3.02044V3.51714V4.01265V4.50935V5.00486V5.50155V5.99707V6.49376V6.99045V7.48597V7.98148H28.0308H28.5281H29.0243H29.5216H30.0177H30.5151H31.0112H31.5085H32.0046H32.502H32.9981H33.4954H33.9915H34.4865H34.4889H34.9838H35.4799V7.48597V6.99045H34.9838H34.4889H34.4865H33.9915H33.4954H32.9981H32.502H32.0046H31.5085H31.0112H30.5151H30.0177H29.5216H29.0243H28.5281V6.49376V5.99707V5.50155V5.00486H29.0243H29.5216H30.0177H30.5151H31.0112H31.5085H32.0046H32.502H32.9957H32.9981H33.493H33.9892H34.4865V4.50935V4.01265H33.9892H33.493H32.9981H32.9957H32.502H32.0046H31.5085H31.0112H30.5151H30.0177H29.5216H29.0243H28.5281V3.51714V3.02044V2.52493V2.02824V1.53154V1.03603H29.0243H29.5216H30.0177H30.5151H31.0112H31.5085H32.0046H32.502H32.9981H33.4954H33.9915H34.4865H34.4889H34.9838H35.4799V0.540518V0.0438232H34.9838H34.4889Z" fill="#0C0C0E"/>
<path d="M48.4691 0.0246582V0.52376V1.02167V1.51959V2.01869V2.51779V3.01571V3.51481V4.01272V4.51183V5.00974V5.50884V6.00676L47.9693 5.50884L47.4708 5.00974L46.9711 4.51183L46.4725 4.01272L45.9728 3.51481L45.4731 3.01571L44.9745 2.51779L44.4748 2.01869L43.9762 1.51959L43.4765 1.02167L42.978 0.52376L42.4783 0.0246582H41.9797H41.48V0.52376V1.02167V1.51959V2.01869V2.51779V3.01571V3.51481V4.01272V4.51183V5.00974V5.50884V6.00676V6.50586V7.00496V7.50288V8.00079H41.9797H42.4783V7.50288V7.00496V6.50586V6.00676V5.50884V5.00974V4.51183V4.01272V3.51481V3.01571V2.51779V2.01869V1.51959L42.978 2.01869L43.4765 2.51779L43.9762 3.01571L44.4748 3.51481L44.9745 4.01272L45.4731 4.51183L45.9728 5.00974L46.4725 5.50884L46.9711 6.00676L47.4708 6.50586L47.9693 7.00496L48.4691 7.50288L48.9676 8.00079H49.4673V7.50288V7.00496V6.50586V6.00676V5.50884V5.00974V4.51183V4.01272V3.51481V3.01571V2.51779V2.01869V1.51959V1.02167V0.52376V0.0246582H48.9676H48.4691Z" fill="#0C0C0E"/>
<path d="M76.2938 0.0126953H70.1772V8.01268H76.2926L76.3184 8.0127L77.3103 7.08677V0.6053L76.2938 0.0126953ZM76.2926 1.51307V7.01283H71.1925V1.01255H76.2926V1.51307Z" fill="#0C0C0E"/>
<path d="M90.3128 0.018648H83.3103V8.0127H84.3107V5.01418H90.3128V8.0127H91.3132V0.0126953H90.3128V0.018648ZM90.3128 4.01865H84.3107V1.01776H90.3128V4.01865Z" fill="#0C0C0E"/>
<path d="M105.313 1.0293H101.822V8.0127H100.804V1.0293H97.3132V0.0126953H105.313V1.0293Z" fill="#0C0C0E"/>
<path d="M118.316 0.018648H111.313V8.0127H112.314V5.01418H118.316V8.0127H119.316V0.0126953H118.316V0.018648ZM118.316 4.01865H112.314V1.01776H118.316V4.01865Z" fill="#0C0C0E"/>
<path d="M147.029 0.0069903H140.026V8.00104H141.026V5.00253H148.029V0.0010376H147.029V0.0069903ZM147.029 1.50625V4.00699H141.026V1.0061H147.029V1.50625Z" fill="#0C0C0E"/>
<path d="M154.538 0.0253906H155.555V7.14403H161.657V8.02539H154.538V0.0253906Z" fill="#0C0C0E"/>
<path d="M175.091 0.0069903H168.089V8.00104H169.089V5.00253H175.091V8.00104H176.091V0.0010376H175.091V0.0069903ZM175.091 4.00699H169.089V1.0061H175.091V4.00699Z" fill="#0C0C0E"/>
<path d="M190.601 1.04199H187.109V8.02539H186.092V1.04199H182.601V0.0253906H190.601V1.04199Z" fill="#0C0C0E"/>
<path d="M204.093 0.0253906H204.096H204.594H205.094V0.525986V1.02539H204.594H204.096H204.093H203.594H203.094H202.593H202.093H201.592H201.092H200.591H200.091H199.589H199.089H198.588H198.088V1.52479V2.02539V2.52599V3.02539V3.52599V4.02539H198.588H199.089H199.589H200.091H200.591H201.092H201.592H202.093H202.591H202.593H203.092H203.592H204.594V5.02539H203.592H203.092H202.593H202.591H202.093H201.592H201.092H200.591H200.091H199.589H199.089H198.588H198.088V5.52599V6.02539V6.52599V7.02658V7.64606V8.02539H197.587H197.086V7.52599V7.02658V6.52599V6.02539V5.52599V5.02539V4.52599V4.02539V3.52599V3.02539V2.52599V2.02539V1.52479V1.02539V0.525986V0.0253906H197.587H198.088H198.588H199.089H199.589H200.091H200.591H201.092H201.592H202.093H202.593H203.094H203.594H204.093Z" fill="#0C0C0E"/>
<path d="M218.587 0.00738525H211.58V4.00739V8.00739H219.59V0.00738525H218.589H218.587ZM218.587 1.50776V7.00753H212.58V1.00724H218.587V1.50776Z" fill="#0C0C0E"/>
<path d="M233.097 8L231.269 4.85241H232.269L234.097 8H233.097Z" fill="#0C0C0E"/>
<path d="M233.095 0.00595197H226.093V7.99902H227.094V5.00087H234.095V0H233.095V0.00595197ZM233.095 4.00546H227.094V1.00494H233.095V4.00546Z" fill="#0C0C0E"/>
<path d="M240.607 8.02258V0.022583H241.624L244.843 3.27575L247.588 0.022583H248.604V8.02258H247.588V1.58139L245.351 4.29236H244.335L241.624 1.58139V8.02258H240.607Z" fill="#0C0C0E"/>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 4.8 KiB

19
images/odp-light.svg vendored Normal file
View File

@@ -0,0 +1,19 @@
<svg width="249" height="9" viewBox="0 0 249 9" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M6.58831 0.0126953H0V8.0127H7.53062V0.0126953H6.58943H6.58831ZM6.58831 1.51307V7.01284H0.940066V1.01255H6.58831V1.51307Z" fill="white"/>
<path d="M20.5331 0.018648H13.5306V8.0127H14.531V5.01418H21.5335V0.0126953H20.5331V0.018648ZM20.5331 1.51791V4.01865H14.531V1.01776H20.5331V1.51791Z" fill="white"/>
<path d="M34.4889 0.0438232H34.4865H33.9915H33.4954H32.9981H32.502H32.0046H31.5085H31.0112H30.5151H30.0177H29.5216H29.0243H28.5281H28.0308H27.5335V0.540518V1.03603V1.53154V2.02824V2.52493V3.02044V3.51714V4.01265V4.50935V5.00486V5.50155V5.99707V6.49376V6.99045V7.48597V7.98148H28.0308H28.5281H29.0243H29.5216H30.0177H30.5151H31.0112H31.5085H32.0046H32.502H32.9981H33.4954H33.9915H34.4865H34.4889H34.9838H35.4799V7.48597V6.99045H34.9838H34.4889H34.4865H33.9915H33.4954H32.9981H32.502H32.0046H31.5085H31.0112H30.5151H30.0177H29.5216H29.0243H28.5281V6.49376V5.99707V5.50155V5.00486H29.0243H29.5216H30.0177H30.5151H31.0112H31.5085H32.0046H32.502H32.9957H32.9981H33.493H33.9892H34.4865V4.50935V4.01265H33.9892H33.493H32.9981H32.9957H32.502H32.0046H31.5085H31.0112H30.5151H30.0177H29.5216H29.0243H28.5281V3.51714V3.02044V2.52493V2.02824V1.53154V1.03603H29.0243H29.5216H30.0177H30.5151H31.0112H31.5085H32.0046H32.502H32.9981H33.4954H33.9915H34.4865H34.4889H34.9838H35.4799V0.540518V0.0438232H34.9838H34.4889Z" fill="white"/>
<path d="M48.469 0.0246582V0.52376V1.02167V1.51959V2.01869V2.51779V3.01571V3.51481V4.01272V4.51183V5.00974V5.50884V6.00676L47.9693 5.50884L47.4708 5.00974L46.971 4.51183L46.4725 4.01272L45.9728 3.51481L45.473 3.01571L44.9745 2.51779L44.4748 2.01869L43.9762 1.51959L43.4765 1.02167L42.9779 0.52376L42.4782 0.0246582H41.9797H41.4799V0.52376V1.02167V1.51959V2.01869V2.51779V3.01571V3.51481V4.01272V4.51183V5.00974V5.50884V6.00676V6.50586V7.00496V7.50288V8.00079H41.9797H42.4782V7.50288V7.00496V6.50586V6.00676V5.50884V5.00974V4.51183V4.01272V3.51481V3.01571V2.51779V2.01869V1.51959L42.9779 2.01869L43.4765 2.51779L43.9762 3.01571L44.4748 3.51481L44.9745 4.01272L45.473 4.51183L45.9728 5.00974L46.4725 5.50884L46.971 6.00676L47.4708 6.50586L47.9693 7.00496L48.469 7.50288L48.9676 8.00079H49.4673V7.50288V7.00496V6.50586V6.00676V5.50884V5.00974V4.51183V4.01272V3.51481V3.01571V2.51779V2.01869V1.51959V1.02167V0.52376V0.0246582H48.9676H48.469Z" fill="white"/>
<path d="M76.2938 0.0126953H70.1772V8.01268H76.2926L76.3183 8.0127L77.3103 7.08677V0.6053L76.2938 0.0126953ZM76.2926 1.51307V7.01283H71.1925V1.01255H76.2926V1.51307Z" fill="white"/>
<path d="M90.3128 0.018648H83.3103V8.0127H84.3107V5.01418H90.3128V8.0127H91.3132V0.0126953H90.3128V0.018648ZM90.3128 4.01865H84.3107V1.01776H90.3128V4.01865Z" fill="white"/>
<path d="M105.313 1.0293H101.822V8.0127H100.804V1.0293H97.3132V0.0126953H105.313V1.0293Z" fill="white"/>
<path d="M118.316 0.018648H111.313V8.0127H112.314V5.01418H118.316V8.0127H119.316V0.0126953H118.316V0.018648ZM118.316 4.01865H112.314V1.01776H118.316V4.01865Z" fill="white"/>
<path d="M147.029 0.0069903H140.026V8.00104H141.026V5.00253H148.029V0.0010376H147.029V0.0069903ZM147.029 1.50625V4.00699H141.026V1.0061H147.029V1.50625Z" fill="white"/>
<path d="M154.538 0.0253906H155.555V7.14403H161.657V8.02539H154.538V0.0253906Z" fill="white"/>
<path d="M175.091 0.0069903H168.089V8.00104H169.089V5.00253H175.091V8.00104H176.091V0.0010376H175.091V0.0069903ZM175.091 4.00699H169.089V1.0061H175.091V4.00699Z" fill="white"/>
<path d="M190.601 1.04199H187.109V8.02539H186.092V1.04199H182.601V0.0253906H190.601V1.04199Z" fill="white"/>
<path d="M204.093 0.0253906H204.096H204.594H205.094V0.525986V1.02539H204.594H204.096H204.093H203.594H203.094H202.593H202.093H201.592H201.092H200.591H200.091H199.589H199.089H198.588H198.088V1.52479V2.02539V2.52599V3.02539V3.52599V4.02539H198.588H199.089H199.589H200.091H200.591H201.092H201.592H202.093H202.591H202.593H203.092H203.592H204.594V5.02539H203.592H203.092H202.593H202.591H202.093H201.592H201.092H200.591H200.091H199.589H199.089H198.588H198.088V5.52599V6.02539V6.52599V7.02658V7.64606V8.02539H197.587H197.086V7.52599V7.02658V6.52599V6.02539V5.52599V5.02539V4.52599V4.02539V3.52599V3.02539V2.52599V2.02539V1.52479V1.02539V0.525986V0.0253906H197.587H198.088H198.588H199.089H199.589H200.091H200.591H201.092H201.592H202.093H202.593H203.094H203.594H204.093Z" fill="white"/>
<path d="M218.587 0.00738525H211.58V4.00739V8.00739H219.59V0.00738525H218.589H218.587ZM218.587 1.50776V7.00753H212.58V1.00724H218.587V1.50776Z" fill="white"/>
<path d="M233.097 8L231.269 4.85241H232.269L234.097 8H233.097Z" fill="white"/>
<path d="M233.095 0.00595197H226.093V7.99902H227.094V5.00087H234.095V0H233.095V0.00595197ZM233.095 4.00546H227.094V1.00494H233.095V4.00546Z" fill="white"/>
<path d="M240.607 8.02258V0.022583H241.624L244.843 3.27575L247.588 0.022583H248.604V8.02258H247.588V1.58139L245.351 4.29236H244.335L241.624 1.58139V8.02258H240.607Z" fill="white"/>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 4.8 KiB