diff --git a/cli/README.md b/cli/README.md index 2ab4656c0fa..8a83b426807 100644 --- a/cli/README.md +++ b/cli/README.md @@ -10,7 +10,7 @@ ## Overview -The OpenBB CLI is a command line interface that wraps [OpenBB Platform](https://docs.openbb.co/platform). +The OpenBB Platform CLI is a command line interface that wraps [OpenBB Platform](https://docs.openbb.co/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. @@ -26,7 +26,7 @@ pip install openbb-cli > Note: Find the most complete installation hints and tips [here](https://my.openbb.co/app/cli/installation). -After the installation is complete, you can deploy the OpenBB CLI by running the following command: +After the installation is complete, you can deploy the OpenBB Platform CLI by running the following command: ```bash openbb diff --git a/cli/openbb_cli/cli.py b/cli/openbb_cli/cli.py index 0d9e3e3d0fd..1937a05d37b 100644 --- a/cli/openbb_cli/cli.py +++ b/cli/openbb_cli/cli.py @@ -4,7 +4,7 @@ import sys def main(): - """Use the main entry point for the OpenBB CLI.""" + """Use the main entry point for the OpenBB Platform CLI.""" print("Loading...\n") # noqa: T201 # pylint: disable=import-outside-toplevel diff --git a/cli/tests/test_controllers_script_parser.py b/cli/tests/test_controllers_script_parser.py index 4363b0d79fe..488eab6b288 100644 --- a/cli/tests/test_controllers_script_parser.py +++ b/cli/tests/test_controllers_script_parser.py @@ -27,22 +27,18 @@ def test_is_reset(command, expected): assert is_reset(command) == expected -@pytest.mark.parametrize( - "keyword, expected_date", - [ - ( - "$LASTFRIDAY", - ( - datetime.now() - - timedelta(days=((datetime.now().weekday() - 4) % 7 + 7) % 7) - ).strftime("%Y-%m-%d"), - ), - ], -) -def test_match_and_return_openbb_keyword_date(keyword, expected_date): +def test_match_and_return_openbb_keyword_date(): """Test the match_and_return_openbb_keyword_date function.""" + keyword = "$LASTFRIDAY" result = match_and_return_openbb_keyword_date(keyword) - assert result == expected_date + expected = "" + if keyword == "$LASTFRIDAY": + today = datetime.now() + expected = today - timedelta(days=(today.weekday() + 3) % 7) + if expected >= today: + expected -= timedelta(days=7) + expected = expected.strftime("%Y-%m-%d") + assert result == expected def test_parse_openbb_script_basic(): @@ -100,7 +96,7 @@ def test_date_keyword_last_friday(): """Test the match_and_return_openbb_keyword_date function.""" today = datetime.now() last_friday = today - timedelta(days=(today.weekday() - 4 + 7) % 7) - if last_friday > today: + if last_friday >= today: last_friday -= timedelta(days=7) expected_date = last_friday.strftime("%Y-%m-%d") assert match_and_return_openbb_keyword_date("$LASTFRIDAY") == expected_date diff --git a/website/content/cli/_category_.json b/website/content/cli/_category_.json index a68e9f9ff3b..e5f25f078df 100644 --- a/website/content/cli/_category_.json +++ b/website/content/cli/_category_.json @@ -1,4 +1,4 @@ { - "label": "OpenBB CLI", + "label": "OpenBB Platform CLI", "position": 2 } diff --git a/website/content/cli/commands-and-arguments.md b/website/content/cli/commands-and-arguments.md index 709b73f3bc9..88248043c5b 100644 --- a/website/content/cli/commands-and-arguments.md +++ b/website/content/cli/commands-and-arguments.md @@ -1,7 +1,7 @@ --- title: Commands And Arguments sidebar_position: 4 -description: This page explains how to enter commands and arguments into the OpenBB CLI. +description: This page explains how to enter commands and arguments into the OpenBB Platform CLI. keywords: - help arguments - auto-complete @@ -19,7 +19,7 @@ keywords: import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + Commands are displayed on-screen in a lighter colour, compared with menu items, and they will not be prefaced with, `>`. @@ -43,7 +43,7 @@ Use the auto-complete to prompt choices and reduce the amount of keystrokes requ ## Auto-complete -The OpenBB CLI is equipped with an auto completion engine that presents choices based on the current menu and command. Whenever you start typing, suggestion prompts will appear for existing commands and menus. When the command contains arguments, pressing the `space bar` after typing the command will present the list of available arguments. +The OpenBB Platform CLI is equipped with an auto completion engine that presents choices based on the current menu and command. Whenever you start typing, suggestion prompts will appear for existing commands and menus. When the command contains arguments, pressing the `space bar` after typing the command will present the list of available arguments. This functionality dramatically reduces the number of key strokes required to perform tasks and, in many cases, eliminates the need to consult the help dialogue for reminders. Choices - where they are bound by a defined list - are scrollable with the up and down arrow keys. diff --git a/website/content/cli/configuration.md b/website/content/cli/configuration.md index 360aebae253..9ade9e69d4b 100644 --- a/website/content/cli/configuration.md +++ b/website/content/cli/configuration.md @@ -1,7 +1,7 @@ --- title: Configuration & Settings sidebar_position: 5 -description: This documentation page details the various settings and feature flags used to customize the OpenBB CLI. +description: This documentation page details the various settings and feature flags used to customize the OpenBB Platform CLI. keywords: - Settings Menu - Feature Flags Menu @@ -16,7 +16,7 @@ keywords: import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + In addition to the OpenBB Platform's `user_settings.json` file, described [here](/platform/usage/settings_and_environment_variables), there are settings and environment variables affecting the CLI only. diff --git a/website/content/cli/data-sources.md b/website/content/cli/data-sources.md index f6bd3a0d762..5c9c1a00788 100644 --- a/website/content/cli/data-sources.md +++ b/website/content/cli/data-sources.md @@ -19,7 +19,7 @@ keywords: import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + Many commands have multiple data sources associated with it. This page describes how to select from multiple providers. diff --git a/website/content/cli/hub.md b/website/content/cli/hub.md index d7e77fd9e63..1906b94415e 100644 --- a/website/content/cli/hub.md +++ b/website/content/cli/hub.md @@ -1,7 +1,7 @@ --- title: Hub Synchronization sidebar_position: 6 -description: This page outlines the `/account` menu within the OpenBB CLI, and integrations with the OpenBB Hub. +description: This page outlines the `/account` menu within the OpenBB Platform CLI, and integrations with the OpenBB Hub. keywords: - OpenBB Platform CLI - OpenBB Hub @@ -23,7 +23,7 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; -This page outlines the `/account` menu within the OpenBB CLI and integrations with the OpenBB Hub. +This page outlines the `/account` menu within the OpenBB Platform CLI and integrations with the OpenBB Hub. ## Registration diff --git a/website/content/cli/index.md b/website/content/cli/index.md index 8097697a088..524fcb97883 100644 --- a/website/content/cli/index.md +++ b/website/content/cli/index.md @@ -1,7 +1,7 @@ --- title: Introduction sidebar_position: 0 -description: The OpenBB CLI is a command line interface wrapping the OpenBB Platform. It offers a convenient way to interact with the Platform and its extensions, as well as automate data collection via OpenBB Routine Scripts. No experience with Python, or other programming languages, is required. +description: The OpenBB Platform CLI is a command line interface wrapping the OpenBB Platform. It offers a convenient way to interact with the Platform and its extensions, as well as automate data collection via OpenBB Routine Scripts. No experience with Python, or other programming languages, is required. keywords: - OpenBB - CLI @@ -18,11 +18,11 @@ keywords: import NewReferenceCard from "@site/src/components/General/NewReferenceCard"; import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + ## Overview -The OpenBB CLI is a command line interface wrapping the OpenBB Platform. It offers a convenient way to interact with the Platform and its extensions, as well as automate data collection via OpenBB Routine Scripts. +The OpenBB Platform CLI is a command line interface wrapping the OpenBB Platform. It offers a convenient way to interact with the Platform and its extensions, as well as automate data collection via OpenBB Routine Scripts. The CLI is the next iteration of the [OpenBB Terminal](/terminal), and leverages the extendability of the OpenBB Platform architecture in an easy-to-consume and script format. @@ -33,17 +33,17 @@ The CLI is the next iteration of the [OpenBB Terminal](/terminal), and leverages
    + ## Pre-Requisites -The OpenBB CLI is a wrapper around the [Platform](/platform), and should be installed along side an existing OpenBB installation. +The OpenBB Platform CLI is a wrapper around the [Platform](/platform), and should be installed along side an existing OpenBB installation. - A Python virtual environment with a version between 3.9 and 3.11, inclusive, is required. diff --git a/website/content/cli/interactive-charts.md b/website/content/cli/interactive-charts.md index efd7438808e..2188ae39ea5 100644 --- a/website/content/cli/interactive-charts.md +++ b/website/content/cli/interactive-charts.md @@ -21,7 +21,7 @@ keywords: import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + Interactive charts open in a separate window ([PyWry](https://github.com/OpenBB-finance/pywry)). The OpenBB charting library provides interactive and highly customizable charts. diff --git a/website/content/cli/interactive-tables.md b/website/content/cli/interactive-tables.md index 1399576b360..4eb7d2a7807 100644 --- a/website/content/cli/interactive-tables.md +++ b/website/content/cli/interactive-tables.md @@ -18,13 +18,13 @@ keywords: import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + Interactive tables open in a separate window ([PyWry](https://github.com/OpenBB-finance/pywry)). These provide methods for searching, sorting, filtering, exporting and even adapting settings directly on the table. :::tip -All OpenBB CLI results are displayed in interactive tables by default, unless the interactive model is disabled from the `/settings` menu. +All OpenBB Platform CLI results are displayed in interactive tables by default, unless the interactive model is disabled from the `/settings` menu. :::
    diff --git a/website/content/cli/openbbuserdata.md b/website/content/cli/openbbuserdata.md index 036731b1936..3ab4a2b02f2 100644 --- a/website/content/cli/openbbuserdata.md +++ b/website/content/cli/openbbuserdata.md @@ -18,7 +18,7 @@ keywords: import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + The OpenBBUserData folder is where exports, routines, and other user-related content is saved and stored. diff --git a/website/content/cli/quickstart.md b/website/content/cli/quickstart.md index ef984108731..ce641dc23a3 100644 --- a/website/content/cli/quickstart.md +++ b/website/content/cli/quickstart.md @@ -1,7 +1,7 @@ --- title: Quick Start sidebar_position: 2 -description: This page is a quick start guide for the OpenBB CLI. +description: This page is a quick start guide for the OpenBB Platform CLI. keywords: - quickstart - quick start @@ -12,7 +12,7 @@ keywords: import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + ## Launch diff --git a/website/content/cli/routines/advanced-routines.md b/website/content/cli/routines/advanced-routines.md index deb5988eb0e..0ada9ac543d 100644 --- a/website/content/cli/routines/advanced-routines.md +++ b/website/content/cli/routines/advanced-routines.md @@ -1,7 +1,7 @@ --- title: Advanced Routines sidebar_position: 5 -description: This page provides guidance on creating and running advanced workflows in the OpenBB CLI by +description: This page provides guidance on creating and running advanced workflows in the OpenBB Platform CLI by introducing variables and arguments for routines. It explains input variables, relative time keyword variables, internal script variables and creating loops for batch execution. @@ -21,7 +21,7 @@ keywords: import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + ## Input Variables diff --git a/website/content/cli/routines/community-routines.md b/website/content/cli/routines/community-routines.md index 1fa10fcdd04..c149ccbaff0 100644 --- a/website/content/cli/routines/community-routines.md +++ b/website/content/cli/routines/community-routines.md @@ -18,11 +18,11 @@ keywords: import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + ## Overview -Community Routines are a feature of the [OpenBB Hub](https://my.openbb.co) that provides methods for creating, editing and sharing OpenBB CLI scripts in the cloud. +Community Routines are a feature of the [OpenBB Hub](https://my.openbb.co) that provides methods for creating, editing and sharing OpenBB Platform CLI scripts in the cloud. Users can create routines that are private or public, with public routines able to run directly from a URL. diff --git a/website/content/cli/routines/index.mdx b/website/content/cli/routines/index.mdx index cf5947ef80a..9ed2703064c 100644 --- a/website/content/cli/routines/index.mdx +++ b/website/content/cli/routines/index.mdx @@ -5,7 +5,7 @@ title: Routines import NewReferenceCard from "@site/src/components/General/NewReferenceCard"; import HeadTitle from "@site/src/components/General/HeadTitle.tsx"; - +
      -
    \ No newline at end of file +
diff --git a/website/content/cli/routines/introduction-to-routines.md b/website/content/cli/routines/introduction-to-routines.md index 7eaf8ecd973..d629ebe8cee 100644 --- a/website/content/cli/routines/introduction-to-routines.md +++ b/website/content/cli/routines/introduction-to-routines.md @@ -19,7 +19,7 @@ keywords: import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + ## Overview @@ -29,7 +29,7 @@ Other software like STATA, SPSS, and R-Studio share similar functionality in the Routines make it easy to automate a series of processes, and this includes mining and dumping large amounts of data to organized spreadsheets. Making use of `--export` and `--sheet-name`, data collection is more efficient and reliable, with results that are easily replicable. -A pipeline of commands is difficult to share, so to encourage users to share ideas and processes, we created [Community Routines](community-routines.md) for the [OpenBB Hub](https://my.openbb.co/). Routines can be created, stored, and shared - executable in any OpenBB CLI installation, by URL. +A pipeline of commands is difficult to share, so to encourage users to share ideas and processes, we created [Community Routines](community-routines.md) for the [OpenBB Hub](https://my.openbb.co/). Routines can be created, stored, and shared - executable in any OpenBB Platform CLI installation, by URL. ## Pipeline of Commands diff --git a/website/content/cli/routines/routine-macro-recorder.md b/website/content/cli/routines/routine-macro-recorder.md index 2221b7d8d34..38b25137882 100644 --- a/website/content/cli/routines/routine-macro-recorder.md +++ b/website/content/cli/routines/routine-macro-recorder.md @@ -21,7 +21,7 @@ keywords: import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + OpenBB script routines can be captured with the macro recorder, controlled with global commands. Enter, `record`, to start saving commands, and then, `stop`, terminates the recording. This means that any command you run will be captured in the script; and on `stop`, it will be saved to the `~/OpenBBUserData/routines/` folder. diff --git a/website/content/cli/structure-and-navigation.md b/website/content/cli/structure-and-navigation.md index bcb6f6d840e..089438bad2f 100644 --- a/website/content/cli/structure-and-navigation.md +++ b/website/content/cli/structure-and-navigation.md @@ -1,7 +1,7 @@ --- title: Structure and Navigation sidebar_position: 3 -description: This page describes the layout and structure of the OpenBB CLI, as well as how to navigate it. +description: This page describes the layout and structure of the OpenBB Platform CLI, as well as how to navigate it. keywords: - CLI application - OpenBB Platform CLI @@ -18,7 +18,7 @@ keywords: import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + ## Structure diff --git a/website/pypi.md b/website/pypi.md deleted file mode 100644 index e5600a1b8bf..00000000000 --- a/website/pypi.md +++ /dev/null @@ -1,50 +0,0 @@ -# OpenBB SDK v3 - -[![Downloads](https://static.pepy.tech/badge/openbb)](https://pepy.tech/project/openbb) -[![LatestRelease](https://badge.fury.io/py/openbb.svg)](https://github.com/OpenBB-finance/OpenBBTerminal) - -| OpenBB is committed to build the future of investment research by focusing on an open source infrastructure accessible to everyone, everywhere. | -|:--:| -| ![OpenBBLogo](https://user-images.githubusercontent.com/25267873/218899768-1f0964b8-326c-4f35-af6f-ea0946ac970b.png) | -| Check our website at [openbb.co](www.openbb.co) | - -## Overview - -OpenBB SDK provides a convenient way to access raw financial data from multiple data providers. This allows users to build custom financial dashboards and reports in minutes. - -More information on this product can be found [here](https://openbb.co/products/sdk) - -## Installation - -The command below provides access to the core functionalities behind the [OpenBB Terminal](https://openbb.co/products/terminal). - -```python -pip install openbb==3.2.5 -``` - -If you wish to utilize our **Portfolio Optimization** or **Machine Learning / Artificial Intelligence** toolkits, please see instructions [here](https://docs.openbb.co/terminal/installation). - -## Usage - -Access our fully fledged financial SDK with a single line of python code. - -```python -from openbb_terminal.sdk import openbb -``` - -Everything you need to use the OpenBB SDK can be found on our [Official Documentation](https://docs.openbb.co/sdk). - -Main uses cases can be seen below. -___ - -### RAW FINANCIAL DATA AT YOUR FINGERTIPS - -Access raw financial data from any data source that you are interested. The open source nature of this SDK makes it so that this is an ever-growing project and that everyone can contribute to. - -![Stocks Load](https://user-images.githubusercontent.com/25267873/218906336-cebd1fc8-7e7a-45bc-a5fc-641eb19c3e8c.png) - -### GENERATE INSIGHTS 10X FASTER - -For most of the functionalities, adding `_chart` to the function will allow you to visualize the output directly from a Jupyter Notebook. Not only speeding up the time it takes to create a plot for the data you are interested in, but making building custom reports much faster. - -![Economy Treasury Chart](https://user-images.githubusercontent.com/25267873/218906112-b2272d43-11fc-4ec1-9a8f-b2d8e2ed7dc1.png) diff --git a/website/sidebars.js b/website/sidebars.js index f2ebf8ea6ea..a9acc0e6923 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -38,7 +38,7 @@ export default { }, { type: "category", - label: "OpenBB CLI", + label: "OpenBB Platform CLI", items: [{ type: "autogenerated", dirName: "cli" }], }, { diff --git a/website/src/components/General/NewReferenceCard.tsx b/website/src/components/General/NewReferenceCard.tsx index d75bb780f19..cf3875f2c6d 100644 --- a/website/src/components/General/NewReferenceCard.tsx +++ b/website/src/components/General/NewReferenceCard.tsx @@ -36,12 +36,10 @@ export default function NewReferenceCard({ "hover:bg-[#b186bb] border-[#b186bb] dark:hover:bg-[#3a204f] dark:border-[#3a204f]": cleanedPath.startsWith("/bot"), "hover:bg-[#F5B166] border-[#F5B166] dark:hover:bg-[#511d11] dark:border-[#511d11]": - cleanedPath.startsWith("/sdk") || + cleanedPath.startsWith("/sdk") || cleanedPath.startsWith("/cli") || cleanedPath.startsWith("/platform"), "hover:bg-[#16A34A] border-[#16A34A] dark:hover:bg-[#14532D] dark:border-[#14532D]": cleanedPath.startsWith("/excel"), - "hover:bg-[#D3D3D3] border-[#D3D3D3] dark:hover:bg-[#5c5c5c] dark:border-[#5c5c5c]": - cleanedPath.startsWith("/cli"), header_docs: !cleanedPath.startsWith("/terminal") && !cleanedPath.startsWith("/pro") && diff --git a/website/src/components/General/ReferenceCard.tsx b/website/src/components/General/ReferenceCard.tsx index 36cfe8b3eee..afb44400340 100644 --- a/website/src/components/General/ReferenceCard.tsx +++ b/website/src/components/General/ReferenceCard.tsx @@ -26,7 +26,7 @@ export default function ReferenceCard({ { header_docs_terminal: cleanedPath.startsWith("/terminal"), "bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]": - cleanedPath.startsWith("/sdk") || + cleanedPath.startsWith("/sdk") || cleanedPath.startsWith("/cli") || cleanedPath.startsWith("/platform"), "bg-gradient-to-r from-grey-800 to-purple-800": cleanedPath.startsWith("/bot"), @@ -34,7 +34,8 @@ export default function ReferenceCard({ !cleanedPath.startsWith("/terminal") && !cleanedPath.startsWith("/sdk") && !cleanedPath.startsWith("/platform") && - !cleanedPath.startsWith("/bot"), + !cleanedPath.startsWith("/bot") && + !cleanedPath.startsWith("/cli"), }, )} to={url} diff --git a/website/src/theme/DocSidebarItem/Category/index.js b/website/src/theme/DocSidebarItem/Category/index.js index a374570c15c..545b3e5cd1c 100644 --- a/website/src/theme/DocSidebarItem/Category/index.js +++ b/website/src/theme/DocSidebarItem/Category/index.js @@ -85,7 +85,7 @@ export default function DocSidebarItemCategory({ "OpenBB Bot": "/bot", "OpenBB Terminal Pro": "/pro", "OpenBB Add-in for Excel": "/excel", - "OpenBB CLI": "/cli", + "OpenBB Platform CLI": "/cli", }; const newHref = labelToHrefMap[label] || href; const { diff --git a/website/src/theme/Navbar/Layout/index.js b/website/src/theme/Navbar/Layout/index.js index 65e2a425e6e..f869b5a7db3 100644 --- a/website/src/theme/Navbar/Layout/index.js +++ b/website/src/theme/Navbar/Layout/index.js @@ -42,7 +42,7 @@ export default function NavbarLayout({ children }) { ); } } else if ( - cleanedPath.startsWith("/sdk") || + cleanedPath.startsWith("/sdk") || cleanedPath.startsWith("/cli") || cleanedPath.startsWith("/platform") ) { if (document.documentElement.getAttribute("data-theme") === "dark") { @@ -80,18 +80,6 @@ export default function NavbarLayout({ children }) { "#3a204f" ); } - } else if (cleanedPath.startsWith("/cli")) { - if (document.documentElement.getAttribute("data-theme") === "dark") { - document.documentElement.style.setProperty( - "--ifm-color-primary", - "#d3d3d3" - ); - } else { - document.documentElement.style.setProperty( - "--ifm-color-primary", - "#d3d3d3" - ); - } } else { } }, [pathname]); @@ -105,7 +93,7 @@ export default function NavbarLayout({ children }) { header_docs_pro: cleanedPath.startsWith("/pro"), header_docs_excel: cleanedPath.startsWith("/excel"), header_docs_sdk: - cleanedPath.startsWith("/sdk") || + cleanedPath.startsWith("/sdk") || cleanedPath.startsWith("/cli") || cleanedPath.startsWith("/platform"), header_docs_bot: cleanedPath.startsWith("/bot"), header_docs: @@ -114,7 +102,8 @@ export default function NavbarLayout({ children }) { !cleanedPath.startsWith("/platform") && !cleanedPath.startsWith("/bot") && !cleanedPath.startsWith("/pro") && - !cleanedPath.startsWith("/excel"), + !cleanedPath.startsWith("/excel") && + !cleanedPath.startsWith("/cli"), }, "navbar", "navbar--fixed-top",