From a9b00ba0c305a1238654f86c081eadf6d7b0967b Mon Sep 17 00:00:00 2001 From: Danglewood <85772166+deeleeramone@users.noreply.github.com> Date: Fri, 16 May 2025 19:02:57 -0700 Subject: [PATCH] Update Agents reference in README.md (#7120) * Update Agents reference in README.md Switch `openbb-agents` for `agents-for-openbb` * Linting * more linting --- README.md | 36 ++++++++++++++++++++++++++++++------ 1 file changed, 30 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1758bed3d06..0282a1d89d4 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,31 @@ If you are looking for our **FREE** AI-powered Research and Analytics Workspace, -We also have an open source AI financial analyst agent that can access all of the data within OpenBB, and that repo can be found [here](https://github.com/OpenBB-finance/openbb-agents). +Connect this library to the OpenBB Workspace with a few simple commands, in a Python (3.9.21 - 3.12) environment. + +- Install the packages. + +```sh +pip install "openbb[all]" +``` + +- Start the API server over localhost. + +```sh +openbb-api +``` + +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". + +![Screenshot 2025-05-16 at 6 00 31 PM](https://github.com/user-attachments/assets/3fde6454-bc0f-4f7e-ad20-edeaf3967dcb) + +- Click the "Add Data" button, enter the server into the form, click "Test", and then "Add". + +![Screenshot 2025-05-16 at 5 58 24 PM](https://github.com/user-attachments/assets/57edc2ee-6a96-4806-9cdc-529712820ddf) + +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). --- @@ -55,7 +79,7 @@ The OpenBB Platform can be installed as a [PyPI package](https://pypi.org/projec 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/platform/installation). ### OpenBB Platform CLI installation @@ -73,15 +97,15 @@ 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/contributing). +- More information on our [Contributing Documentation](https://docs.openbb.co/platform/developer_guide/contributing). ### 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) -* [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) -* [Request a feature](https://github.com/OpenBB-finance/OpenBB/issues/new?assignees=&labels=new+feature&template=feature_request.md&title=%5BFR%5D) +- [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) +- [Request a feature](https://github.com/OpenBB-finance/OpenBB/issues/new?assignees=&labels=new+feature&template=feature_request.md&title=%5BFR%5D) ### Provide feedback