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

[Feature] CLI docs #6362

Merged
merged 42 commits into from
May 14, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
a440064
cli docs website
hjoaquim May 2, 2024
1c366b1
Merge branch 'develop' into feature/docs-cli
hjoaquim May 2, 2024
f7e5ce0
changes
hjoaquim May 2, 2024
bb5977c
remove unused feat flags
hjoaquim May 2, 2024
768a24e
typo
hjoaquim May 2, 2024
47fb848
Merge branch 'develop' of https://github.com/OpenBB-finance/OpenBBTer…
deeleeramone May 7, 2024
5c298f1
yeet stuff that can't be used
deeleeramone May 8, 2024
b6365d2
Merge branch 'develop' into feature/docs-cli
deeleeramone May 8, 2024
6c95a2e
some progress
deeleeramone May 8, 2024
736a9db
Add home screenshot
deeleeramone May 8, 2024
2cfd659
screenshots.md
deeleeramone May 8, 2024
a8fe30b
Merge remote-tracking branch 'OpenBB-finance/develop' into feature/do…
hjoaquim May 9, 2024
35f4f17
Merge branch 'feature/docs-cli' of github.com:OpenBB-finance/OpenBBTe…
hjoaquim May 9, 2024
2a12031
fix links
hjoaquim May 9, 2024
9e0f81b
new cards for cli pages
hjoaquim May 9, 2024
30a0f5d
Merge branch 'develop' into feature/docs-cli
deeleeramone May 9, 2024
2fd3f28
Merge branch 'develop' into feature/docs-cli
deeleeramone May 9, 2024
fda14b8
start config page
deeleeramone May 9, 2024
6977058
more updates
deeleeramone May 10, 2024
b07f3eb
Add screenshots
deeleeramone May 10, 2024
98a8a4f
flatten some things.
deeleeramone May 10, 2024
859dec9
Merge branch 'feature/docs-cli' of https://github.com/OpenBB-finance/…
deeleeramone May 10, 2024
0f08f0d
fix link
deeleeramone May 10, 2024
a144a18
merge branch develop
deeleeramone May 10, 2024
daf959f
some more updates
deeleeramone May 11, 2024
c856cd9
merge branch develop
deeleeramone May 11, 2024
6197216
some routine stuff
deeleeramone May 12, 2024
eb6a71d
codespell
deeleeramone May 12, 2024
af2f6c2
Merge branch 'develop' into feature/docs-cli
hjoaquim May 13, 2024
ecc6b3b
Merge branch 'develop' into feature/docs-cli
deeleeramone May 13, 2024
a3d51a0
Merge branch 'develop' into feature/docs-cli
hjoaquim May 14, 2024
c03b2be
Merge branch 'develop' into feature/docs-cli
hjoaquim May 14, 2024
aeed807
Merge branch 'develop' into feature/docs-cli
hjoaquim May 14, 2024
6f0c522
cli color
hjoaquim May 14, 2024
ca7f878
results in the global commands
hjoaquim May 14, 2024
d00476d
increase codeBlock line-height
montezdesousa May 14, 2024
65b9e0c
remove platform warning, obb is a class
montezdesousa May 14, 2024
f54c850
minor change, danger warning
montezdesousa May 14, 2024
fb5151f
typo?
montezdesousa May 14, 2024
2d6c892
Data processing commands
montezdesousa May 14, 2024
0d4101a
Merge branch 'develop' into feature/docs-cli
hjoaquim May 14, 2024
09cbf81
Merge branch 'develop' into feature/docs-cli
deeleeramone May 14, 2024
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
4 changes: 0 additions & 4 deletions cli/openbb_cli/controllers/feature_flags_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,9 @@ class FeatureFlagsController(BaseController):

CHOICES_COMMANDS: List[str] = [
"retryload",
"tab",
"interactive",
"cls",
"watermark",
"promptkit",
"thoughts",
"reporthtml",
"exithelp",
"rcontext",
"richpanel",
Expand Down
4 changes: 4 additions & 0 deletions website/content/cli/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "OpenBB Platform CLI",
"position": 2
}
35 changes: 35 additions & 0 deletions website/content/cli/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: Introduction
sidebar_position: 0
deeleeramone marked this conversation as resolved.
Show resolved Hide resolved
description: Introduction to the OpenBB Platform CLI; a command line interface that wraps around the OpenBB Platform, offering convenient access to its pre-built data connectors and libraries for designing and building financial reports and applications. Discover how you can contribute to the platform.
keywords:
- OpenBB Platform CLI
- OpenBB Platform
- data connectors
- data access
- data processing
- third-party data providers
---

<!-- markdownlint-disable MD012 MD031 MD033 -->

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="OpenBB Platform CLI Docs" />

The OpenBB Platform CLI is a command line interface that enhances the OpenBB Platform by providing easy access to its comprehensive data connectors and libraries. These tools are essential for designing and constructing financial reports and applications. As a robust tool, the CLI facilitates interaction with the platform, enabling users to retrieve and process data from third-party providers and create customized financial reports and applications.

![Platform Docs pic](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/74520441-5e95-4ba6-9d16-6a2d5c966cf9)
deeleeramone marked this conversation as resolved.
Show resolved Hide resolved

## What is the OpenBB Platform CLI?

The OpenBB Platform CLI is a wrapper around the OpenBB Platform, this means that one can expect it to have the same functionalities that the OpenBB Platform offers with the enhancements and limitations that a command line interface brings. The CLI is designed to be user-friendly and intuitive, making it easy for users to interact with the platform and access its pre-built data connectors and libraries.
deeleeramone marked this conversation as resolved.
Show resolved Hide resolved

The OpenBB Platform CLI is the OpenBB's sub product that intends to offer a replacement for the former [OpenBB Terminal](/terminal). This means that the navigation and usage of the CLI are similar to the Terminal, but with the added benefit of being able to access the OpenBB Platform's data connectors and libraries, i.e., the OpenBB Core and OpenBB Extensions.

Starting with V4, we have completely restructured the previous version of the OpenBB SDK.
Instead of a single monolithic SDK, that comes with dependency nightmares and compatibility issues with things you may not need, we have morphed into the OpenBB Platform, which serves as a collection of building blocks to be used for your own need.

---

Want to contribute? Check out our [Development section](/platform/development).
137 changes: 137 additions & 0 deletions website/content/cli/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
---
title: Installation
sidebar_position: 1
description: This page presents the general system requirements, supported environments,
installation procedures, and setup for running the OpenBB Platform. It discusses
the prerequisites including Python version, operating system requirements, Docker
usage, and the process of building the platform from source.
keywords:
- OpenBB Platform
- Python
- System requirements
- Supported environments
- Installation
- Docker
- Python virtual environment
- Installation from source
- Windows 10
- Mac OS Big Sur
- Linux
- Package installation
- VS Code
- PyCharm
- Jupyter
- GitHub
- Conda
- venv
- API
- Repository
- pip
- Poetry
- Toml
- PyPI
- Node.js
- npm
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="Installation | OpenBB Platform Docs" />

## General Requirements and Environments

Since the OpenBB Platform CLI is a wrapper around the OpenBB Platform, its requirements are the same. Please refer to the [OpenBB Platform install documentation](/platform/installation) for more information.

## Installation

Before installation, update the package manager so that `pip` is current, then create the environment with the desired version of Python.

:::note
Installing packages directly to the system Python or `base` environment is not recommended. Create a new environment first (can be any name, using openbb here for example).

```bash
conda create -n openbb-cli python=3.11
conda activate openbb-cli
```

:::

### PyPI

Install from PyPI with:

```console
pip install openbb-cli
```

This will install the core OpenBB Platform CLI, along with officially supported Platform's extensions and providers.

#### Extensions
deeleeramone marked this conversation as resolved.
Show resolved Hide resolved

To install all extensions and providers (both officially supported and community maintained ones):

```console
pip install openbb[all]
```

To install a single extension:

```console
pip install openbb[charting]
```

```console
pip install openbb[ta]
```

Or install a single provider:

```console
pip install openbb[yfinance]
```

### Source

To build the OpenBB Platform from the source code, first install `git`:

```console
pip install git
```

Next, clone the repository from GitHub:

```console
git clone [email protected]:OpenBB-finance/OpenBBTerminal.git
```

When it is done, checkout the branch where the code is living:

```console
git checkout develop
```

Then, `cd` into the directory:

```console
cd cli
```

Install required packages

```console
pip install poetry
```

Finally, run `poetry` to install all dependencies:

```console
poetry install
```

## Post-Installation

You're ready to launch the OpenBB Platform CLI. To do so, run the following command:

```console
openbb
```
4 changes: 4 additions & 0 deletions website/content/cli/usage/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Usage",
"position": 2
}
4 changes: 4 additions & 0 deletions website/content/cli/usage/data/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Data",
"position": 2
}
23 changes: 23 additions & 0 deletions website/content/cli/usage/data/api-keys.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: API Keys
sidebar_position: 2
description: This documentation page describes how you can set your own API keys from each data vendor on OpenBB to leverage their datasets.
keywords:
- API keys
- datasets
- data vendors
- subscription
- CLI
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="API Keys - Data - Usage | OpenBB Platform CLI Docs" />

API (Application Programming Interface) keys are access credentials for obtaining data from a particular data vendor. They are a string of random characters assigned, by the data provider, to an individual account.

## Setting API keys

Most vendors offer a free tier requiring only a valid email address, some will require an account with proper KYC (Know Your Customer).

Find all data providers [here](https://my.openbb.co/app/platform/data-providers), and manage all you credentials directly on the [OpenBB Hub](https://my.openbb.co/app/platform/credentials).
53 changes: 53 additions & 0 deletions website/content/cli/usage/data/custom-data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: Custom Data
sidebar_position: 3
description: Documentation detailing usage of the OpenBB Platform CLI for financial data
aggregation, standardization, and user data import. It explains the OpenBBUserData
folder functions, how to modify settings, and how to import or export user data.
keywords:
- financial data
- data aggregation
- data standardization
- OpenBBUserData folder
- import data
- export data
- Econometrics
- Portfolio
- Portfolio Optimization
- settings menu
- export folder location
- userdata command
- user-created files
- CLI
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="Custom Data - Data - Usage | OpenBB Platform CLI Docs" />

The OpenBB Platform CLI not only allows access to a world of financial data through our data aggregation and standardization.

## The OpenBBUserData Folder

The `OpenBBUserData` folder's default location is the home of the system user account. By default this will be the following paths:
- macOS: `Macintosh HD/Users/<YOUR_USERNAME>/OpenBBUserData`
- Windows: `C:/Users/<YOUR_USERNAME>/OpenBBUserData`

Within the folder you can find files that you have exported.

![OpenBBUserData Folder](https://user-images.githubusercontent.com/85772166/195742985-19f0e420-d8f7-4fea-a145-a0243b8f2ddc.png)

This folder contains all things user-created. For example:

- Exported files
- Styles and themes
- Routines
- Logs

:::note
**Note:** With a WSL-enabled Windows installation, this folder will be under the Linux partition
:::

### Update export folder location

The location of this folder can be set by the user by changing the user configuration file: `/home/your-user/.openbb_platform/user_settings.json`.
Loading
Loading