c63b3c8bab
* Bump website deps to patched versions * Drop support for python 3.8 * Bump scikit-learn to a patched version * Run urllib3 update on lock files * Bump ipykernel that brings in tornado to devtools * Apply braces patch in frontend-components * Drop python 3.8 from devtools support * Bump dev environment to python >=3.10 to get rid of ullib3 v1 in lock files * Downgrade and pin numpy to 1.x until pandas-ta supports 2.x * Bump runners checkout and cache actions and python version * Fix platform hub integration test * Update dev install script to allow python 3.9 * Bump actions to versions that use node 20 vs node 16 * Bump exchange calendars package to resolve deprecation warnings * Resolve bugs highlighted by the tests (#6538) * Fix FMP currency snapshot model after a security update * fixes * add to the commit * lint --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * Bump finviz * Remove website folder that was added by merge conflict resolution * update test cassettes * biztoc test * fix most of test_charting * bump yfinance * reference.json * Fix some tests * Enable 3.12 support * Have 2 sets of cassettes for 2 versions of urlib3 * Allow 3.12 for sec provider * add json_schema_extra choices to compare groups * sorted choices * test fixing: cassetes * fix charting test * black * headers in sec download zip file * Delete yaml * lint * lint * Record https test_sec_compare_company_facts_fetcher * Record https test_sec_compare_company_facts_fetcher, new params * Record test in 3.9 and 3.10 * Record yfinance tests * Record 310 with us vpn * Record tests individually * record without cache * record without cache --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: hjoaquim <henriquecjoaquim@gmail.com> Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Diogo Sousa <montezdesousa@gmail.com>
OpenBB Platform CLI
| OpenBB is committed to build the future of investment research by focusing on an open source infrastructure accessible to everyone, everywhere. |
|---|
 |
| Check our website at openbb.co |
Overview
The OpenBB Platform CLI is a command line interface that wraps OpenBB Platform.
It offers a convenient way to interact with the OpenBB Platform and its extensions, as well as automate data collection via OpenBB Routine Scripts.
Find the most complete documentation, examples, and usage guides for the OpenBB Platform CLI here.
Installation
The command below provides access to the all the available OpenBB extensions behind the OpenBB Platform, find the complete list here.
pip install openbb-cli
Note: Find the most complete installation hints and tips here.
After the installation is complete, you can deploy the OpenBB Platform CLI by running the following command:
openbb
Which should result in the following output:
API keys
To fully leverage the OpenBB Platform you need to get some API keys to connect with data providers. Here are the 3 options on where to set them:
- OpenBB Hub
- Local file
1. OpenBB Hub
Set your keys at OpenBB Hub and get your personal access token from https://my.openbb.co/app/platform/pat to connect with your account.
Once you log in, on the Platform CLI (through the
/accountmenu, all your credentials will be in sync with the OpenBB Hub.)
2. Local file
You can specify the keys directly in the ~/.openbb_platform/user_settings.json file.
Populate this file with the following template and replace the values with your keys:
{
"credentials": {
"fmp_api_key": "REPLACE_ME",
"polygon_api_key": "REPLACE_ME",
"benzinga_api_key": "REPLACE_ME",
"fred_api_key": "REPLACE_ME"
}
}