Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Terminal to Workspace #54

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The final website can be found at [https://docs.openbb.co](https://docs.openbb.c
│ ├── platform
│ ├── pro
│ ├── sdk
│ └── terminal
│ └── workspace
...
├── scripts
│ ├── generate_excel_markdown.py
Expand Down
2 changes: 1 addition & 1 deletion content/cli/hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ The CLI will need to be restarted, or refreshed, when changes are made on the Hu

## Theme Styles

Theme styles correspond to the ability to change the terminal "skin" (i.e. coloring of the `menu`, `commands`, `data source`, `parameters`, `information` and `help`), as well as the chart and table styles.
Meg1211 marked this conversation as resolved.
Show resolved Hide resolved
Theme styles correspond to the ability to change the "CLI skin" (i.e. coloring of the `menu`, `commands`, `data source`, `parameters`, `information` and `help`), as well as the chart and table styles.

In the OpenBB Hub, you can select the text colours for the CLI. After customizing:
- Download the theme to your styles directory (`/home/your-user/OpenBBUserData/styles/user`).
Expand Down
2 changes: 1 addition & 1 deletion content/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

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](/platform), and leverages the extendability of the OpenBB Platform architecture in an easy-to-consume and script format.
The CLI leverages the extendability of the OpenBB Platform architecture in an easy-to-consume and script format.

![CLI Home](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/d1617c3b-c83d-4491-a7bc-986321fd7230)

Expand Down
2 changes: 1 addition & 1 deletion content/cli/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Welcome to OpenBB Platform CLI v1.0.0

Follow the instructions [here](/platform/installation#source) to clone the GitHub repo and install the OpenBB Platform from the source code.

Next, navigate into the folder: `~/OpenBBTerminal/openbb_platform`
Next, navigate into the folder: `~/OpenBB/openbb_platform`

:::tip
The Python environment should have `poetry` installed.
Expand Down
2 changes: 1 addition & 1 deletion content/cli/routines/routine-macro-recorder.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ keywords:
- global commands
- command recording
- routine script
- terminal main menu
- workspace main menu
- exe --file
- OpenBBUserData
- routines folder
Expand Down
2 changes: 1 addition & 1 deletion content/excel/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

## Requirements
- The OpenBB Add-in for Excel is available on the following platforms: Windows (Microsoft 365), Mac (Microsoft 365), Excel on the web.
- Access to the OpenBB Terminal Pro. If you don't have access you can sign up for the waitlist [here](https://my.openbb.co/app/pro).
- Access to OpenBB Workspace. If you don't have access you can sign up [here](https://my.openbb.co/app/pro).

## Installation

Expand Down
2 changes: 1 addition & 1 deletion content/excel/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ This is a known Excel issue. Currently, there is no definitive fix for the probl
</details>

<details>
<summary mdxType="summary">Cannot retrieve the data added to Terminal Pro through custom backend using OBB.BYOD</summary>
<summary mdxType="summary">Cannot retrieve the data added to OpenBB Workspace through custom backend using OBB.BYOD</summary>

- Make sure your backend is running and accessible
- If you are using Mac or Safari make sure your backend is using HTTPS and has a valid SSL certificate
Expand Down
4 changes: 2 additions & 2 deletions content/excel/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Data standardization is at the core of OpenBB Add-in for Excel, offering you a c
<button
className="bg-grey-200 hover:bg-grey-400 dark:bg-[#303038] dark:hover:bg-grey-600 text-grey-900 dark:text-grey-200 text-sm font-medium py-2 px-4 rounded"
>
Access OpenBB Terminal for free
Access OpenBB Workspace for free
</button>
</a>
</div>
Expand All @@ -40,7 +40,7 @@ If interested in the Excel Add-in, reach out for an enterprise license to [hello

- **Features**

- Access to the same datasets available in Terminal Pro
- Access to the same datasets available in OpenBB Workspace
- Standardization across financial data providers
- Auto-refresh data within your spreadsheets
- Ready-made Excel Templates
4 changes: 2 additions & 2 deletions content/excel/templates.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ OpenBB Add-In for Excel offered by OpenBB. These templates are designed to help

## Excel templates

You can find these templates available within the Terminal Pro on the "Templates" section on the sidebar.
You can find these templates available within the OpenBB Workspace on the "Templates" section on the sidebar.

<img className="pro-border-gradient" width="800" alt="charting" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/cd3cc552-8102-43d1-9af6-e9775b257c23" />

Expand All @@ -42,7 +42,7 @@ Below you can find what templates are available.

### Equity analysis

This workbook offers access to data from the Equity dashboard in OpenBB Terminal Pro, presenting key equity information across tabs, including company details, financial metrics, comparative analysis, ownership insights, event calendars, and analyst estimates.
This workbook offers access to data from the Equity dashboard in OpenBB Workspace, presenting key equity information across tabs, including company details, financial metrics, comparative analysis, ownership insights, event calendars, and analyst estimates.

![Equity analysis](https://openbb-assets.s3.amazonaws.com/docs/excel/EquityAnalysis.png)

Expand Down
4 changes: 2 additions & 2 deletions content/platform/developer_guide/dependency_management.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
Do not run these commands in an already-installed OpenBB Platform environment. Do not run both `pip` and `poetry`.
:::

- **pip**: `pip install -e OpenBBTerminal/openbb_platform/platform/core`
- **pip**: `pip install -e OpenBB/openbb_platform/platform/core`

or

- **poetry**: `poetry install OpenBBTerminal/openbb_platform/platform/core`
- **poetry**: `poetry install OpenBB/openbb_platform/platform/core`

### Using Poetry

Expand Down
2 changes: 1 addition & 1 deletion content/platform/developer_guide/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,6 @@ Optional extras are not included with the base installation, and these include:
- Technical/Quantitative Analysis
- Community data providers
- Toolkit extensions
- CLI Terminal
- CLI

Refer to [Extensions](/platform/user_guides/extensions) for the list of extensions hosted in the OpenBB GitHub repository that can be installed independently.
2 changes: 1 addition & 1 deletion content/platform/developer_guide/standardization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Standardizing provider query parameters and response data enhances the user expe
- Transparently defined schemas for the data and query parameters.
- Outputs from multiple sources are comparable with each other and easily interchanged.

The standard models are all defined in the `/OpenBBTerminal/openbb_platform/core/openbb_core/provider/standard_models/` [directory](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_platform/core/openbb_core/provider/standard_models).
The standard models are all defined in the `/OpenBB/openbb_platform/core/openbb_core/provider/standard_models/` [directory](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_platform/core/openbb_core/provider/standard_models).

### What Is A Standard Model?

Expand Down
8 changes: 4 additions & 4 deletions content/platform/faqs/platform_vs_sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ We needed to refresh the architecture to make it modular, resilient, and scalabl

The result is a much smoother installation procedure, with the tradeoff being some breaking changes for those transitioning from V3 SDK to the V4 Platform. The major differences are described below.

### Terminal Application
### Platform CLI

The OpenBB Terminal is not installed with the Platform. The Terminal will be reimagined with the new extension framework, it won't get left behind for long!
The Platform CLI is not installed with the Platform. The Platform CLI will be reimagined with the new extension framework, it won't get left behind for long!

### Extension Framework

Expand Down Expand Up @@ -78,7 +78,7 @@ Some asset classes have been renamed:
V3 SDK users should note that the `source` parameter is now, `provider`.

:::note
OpenBB Hub Preferences for default sources do not currently sync with V4 Platform, and some API keys not used in the Terminal application are not able to be saved to the Hub.
OpenBB Hub Preferences for default sources do not currently sync with V4 Platform, and some API keys not used in the Platform CLI are not able to be saved to the Hub.
:::

### API Key Management
Expand Down Expand Up @@ -137,7 +137,7 @@ pip install jupyter-lab

Most of the development has been on the core architecture and data providers.

Most views from the V3 SDK and Terminal have yet to be ported over to the V4 Platform, although some charts are already available with the `openbb-charting` toolkit extension - which includes PyWry for window creation.
Most views from the V3 SDK and Platform CLI have yet to be ported over to the V4 Platform, although some charts are already available with the `openbb-charting` toolkit extension - which includes PyWry for window creation.

Install the charting extension with:

Expand Down
6 changes: 3 additions & 3 deletions content/platform/user_guides/add_data_provider_extension.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,12 @@ The `__init__.py` file where models are mapped to the router is under, `/openbb_

To get started:

- Unpack the downloaded [zip](ttps://github.com/OpenBB-finance/OpenBBTerminal/files/14519701/provider_extension_template.zip) file.
- Unpack the downloaded [zip](ttps://github.com/OpenBB-finance/OpenBB/files/14519701/provider_extension_template.zip) file.

- If working with a cloned GitHub repo, the folder is:

```console
~/OpenBBTerminal/openbb_platform/providers
~/OpenBB/openbb_platform/providers
```

- Rename everything, "template", to suit. File names, models, import statements, docstrings.
Expand Down Expand Up @@ -137,7 +137,7 @@ template = "openbb_template:template_provider"

The last line (poetry.plugins) maps to the provider defined in the `__init__.py` file.

Additionally, for local extensions, you can add this line in the `LOCAL_DEPS` variable in the `dev_install.py` file, located in `~/OpenBBTerminal/openbb_platform/`:
Additionally, for local extensions, you can add this line in the `LOCAL_DEPS` variable in the `dev_install.py` file, located in `~/OpenBB/openbb_platform/`:

```toml
# If this is a community dependency, add this under "Community dependencies",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ Let's get on with the fun stuff and start building!
The first step is to create a new file in the provider extension folder:

```console
~/OpenBBTerminal/openbb_platform/providers/alpha_vantage/openbb_alpha_vantage/models
~/OpenBB/openbb_platform/providers/alpha_vantage/openbb_alpha_vantage/models
```

We will call this file: `historical_eps.py`
Expand Down Expand Up @@ -559,7 +559,7 @@ Adding tests doesn't take a lot of effort. In most cases, copying and pasting fr
Unit tests are located in the provider extension folder.

```console
~/OpenBBTerminal/openbb_platform/providers/alpha_vantage/tests
~/OpenBB/openbb_platform/providers/alpha_vantage/tests
```

There will be one test file dedicated to testing each fetcher in the provider extension. Our file is:
Expand Down Expand Up @@ -637,7 +637,7 @@ Step 7 is done.
Integration tests are even easier to add here, we just need to add a set of parameters for the new provider to the existing test. These tests are located in the `extensions` folder, where the routers are, under `integration`.

```console
~/OpenBBTerminal/openbb_platform/extensions/equity/integration
~/OpenBB/openbb_platform/extensions/equity/integration
```

There are two files here, one for the Python interface, and the other for the Fast API.
Expand Down Expand Up @@ -810,7 +810,7 @@ When preparing to commit changes to the local branch, only add the files directl

### Install Pre-Commit Hooks

The pre-commit hooks will run the testing suite locally before the commit is made. Install them from the root of the GitHub project folder, `OpenBBTerminal`.
The pre-commit hooks will run the testing suite locally before the commit is made. Install them from the root of the GitHub project folder, `OpenBB`.

```console
pre-commit install
Expand Down
36 changes: 18 additions & 18 deletions content/platform/user_guides/add_endpoint_to_existing_provider.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ The rule must be clearly communicated and each provider's output should be verif
We're going to map this new endpoint in the interface to, `obb.currency.snapshots()`. We'll name the model accordingly, `CurrencySnapshots`, and create a file, `currency_snapshots.py`. The file should be created here:

```console
~/OpenBBTerminal/openbb_platform/core/openbb_core/provider/standard_models/
~/OpenBB/openbb_platform/core/openbb_core/provider/standard_models/
```

The first line of the file should be a docstring, the second line should be empty, and the import statements follow.
Expand Down Expand Up @@ -312,7 +312,7 @@ Sample output data from the source is pasted below, and we can see that there ar
We need to create a new file in the FMP provider extension. This will have the same name as our standard model.

```console
~/OpenBBTerminal/openbb_platform/providers/fmp/openbb_fmp/models/currency_snapshots.py
~/OpenBB/openbb_platform/providers/fmp/openbb_fmp/models/currency_snapshots.py
```

The first line in the file will always be a docstring, with the import statements beginning below an empty line.
Expand Down Expand Up @@ -499,7 +499,7 @@ class FMPCurrencySnapshotsFetcher(

The last four code blocks combined are the entire contents of the new provider model file.

Next, open `~/OpenBBTerminal/openbb_platform/providers/fmp/openbb_fmp/__init__.py`, import the new model, and map it in the Provider class.
Next, open `~/OpenBB/openbb_platform/providers/fmp/openbb_fmp/__init__.py`, import the new model, and map it in the Provider class.

Step 3 is now done.

Expand All @@ -510,7 +510,7 @@ Step 3 is now done.
To use our new function, we need to create a router command. The currency router is located here:

```python
~/OpenBBTerminal/openbb_platform/extensions/currency/openbb_currency/currency_router.py
~/OpenBB/openbb_platform/extensions/currency/openbb_currency/currency_router.py
```

It's as simple as copying and pasting the function above and modifying details to suit.
Expand Down Expand Up @@ -583,7 +583,7 @@ We'll need to create a unit test for the FMP provider, and then integration test
This is located in the `openbb-fmp` extension:

```console
~/OpenBBTerminal/openbb_platform/providers/fmp/tests/test_fmp_fetchers.py
~/OpenBB/openbb_platform/providers/fmp/tests/test_fmp_fetchers.py
```

- Import the new fetcher with the rest of the imports (keep them alphabetically sorted).
Expand All @@ -608,7 +608,7 @@ def test_fmp_currency_snapshots_fetcher(credentials=test_credentials):
This will generate a new file:

```console
~/OpenBBTerminal/openbb_platform/providers/fmp/tests/record/test_fmp_currency_snapshots_fetcher.yaml
~/OpenBB/openbb_platform/providers/fmp/tests/record/test_fmp_currency_snapshots_fetcher.yaml
```

Check the file for any obvious errors, like a bad HTTP request status code.
Expand All @@ -622,7 +622,7 @@ The Python interface and Fast API each require a new integration test. Again, em
Open the file below, and go to the last test in the file.

```console
~/OpenBBTerminal/openbb_platform/extensions/currency/integration/test_currency_api.py
~/OpenBB/openbb_platform/extensions/currency/integration/test_currency_api.py
```

We can copy this one:
Expand Down Expand Up @@ -675,7 +675,7 @@ def test_currency_snapshots(params, headers):
The `@parameterize` section can be copied directly to the Python integration test.

```console
~/OpenBBTerminal/openbb_platform/extensions/currency/integration/test_currency_python.py
~/OpenBB/openbb_platform/extensions/currency/integration/test_currency_python.py
```

```python
Expand Down Expand Up @@ -729,19 +729,19 @@ Fix all items, and valid fixes for `pylint` can be disabling on that line. It wo

Here are all the files we touched in this process:

- `/OpenBBTerminal/openbb_platform/core/openbb_core/provider/standard_models/currency_snapshots.py`
- `/OpenBBTerminal/openbb_platform/providers/fmp/openbb_fmp/models/currency_snapshots.py`
- `/OpenBBTerminal/openbb_platform/providers/fmp/tests/test_fmp_fetchers.py`
- `/OpenBBTerminal/openbb_platform/providers/fmp/tests/record/test_fmp_currency_snapshots_fetcher.yaml`
- `/OpenBBTerminal/openbb_platform/extensions/currency/openbb_currency/currency_router.py`
- `/OpenBBTerminal/openbb_platform/extensions/currency/integration/test_currency_api.py`
- `/OpenBBTerminal/openbb_platform/extensions/currency/integration/test_currency_python.py`
- `/OpenBBTerminal/openbb_platform/openbb/assets/module_map.json`
- `/OpenBBTerminal/openbb_platform/openbb/package/currency.py`
- `/OpenBB/openbb_platform/core/openbb_core/provider/standard_models/currency_snapshots.py`
- `/OpenBB/openbb_platform/providers/fmp/openbb_fmp/models/currency_snapshots.py`
- `/OpenBB/openbb_platform/providers/fmp/tests/test_fmp_fetchers.py`
- `/OpenBB/openbb_platform/providers/fmp/tests/record/test_fmp_currency_snapshots_fetcher.yaml`
- `/OpenBB/openbb_platform/extensions/currency/openbb_currency/currency_router.py`
- `/OpenBB/openbb_platform/extensions/currency/integration/test_currency_api.py`
- `/OpenBB/openbb_platform/extensions/currency/integration/test_currency_python.py`
- `/OpenBB/openbb_platform/openbb/assets/module_map.json`
- `/OpenBB/openbb_platform/openbb/package/currency.py`

### Install Pre-Commit Hooks

The pre-commit hooks will run the testing suite locally before the commit is made. Install them from the root of the GitHub project folder, `OpenBBTerminal`.
The pre-commit hooks will run the testing suite locally before the commit is made. Install them from the root of the GitHub project folder, `OpenBB`.

```console
pre-commit install
Expand Down
2 changes: 1 addition & 1 deletion content/platform/user_guides/add_toolkit_extension.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The folder does not have to be kept with the OpenBB code, and could be its own G
For demonstration purposes, we'll unpack the ZIP file template with the rest of the OpenBB extensions:

```console
~/OpenBBTerminal/openbb_platform/extensions/dashboards
~/OpenBB/openbb_platform/extensions/dashboards
```

### Add Dependencies
Expand Down
2 changes: 1 addition & 1 deletion content/platform/user_guides/extensions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ A couple of notable differences between data and toolkit extension are:
- In the OpenBB GitHub repo, extensions are all located under:

```console
~/OpenBBTerminal/openbb_platform/extensions
~/OpenBB/openbb_platform/extensions
```

- An additional folder housing integration tests, with the `tests` folder staying empty.
Expand Down
4 changes: 0 additions & 4 deletions content/terminal/_category_.json

This file was deleted.

37 changes: 0 additions & 37 deletions content/terminal/data-connector.md

This file was deleted.

4 changes: 4 additions & 0 deletions content/workspace/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "OpenBB Pro",
"position": 0
}
Loading