Skip to content

installation.md

Latest commit

 

History

History
109 lines (68 loc) · 2.82 KB

installation.md

File metadata and controls

109 lines (68 loc) · 2.82 KB
Raw
title Installation
sidebar_position 2
description This page provides installation instructions for the ODP CLI.
keywords
Open Data Platform by OpenBB
ODP
OpenBB Platform
Python
CLI
installation
pip
pypi

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

Pre-Requisites

ODP CLI is a wrapper around the OpenBB Python Package, and should be installed along side an existing OpenBB installation.

  • A Python virtual environment with a version between 3.10 and 3.14, inclusive, is required.

Please refer to the Python install documentation for instructions and more information.

:::info If the ODP python package is not already installed, the openbb-cli package will install all available components. :::

Windows

The machine may need to have an installation of Visual C++ Build Tools available. Download the elements highlighted in the images below.

"Microsoft Visual C++ 14.0 or greater is required"

Download and install C++ Build Tools, restart the machine, then continue.

image

image

Linux Requirements

Linux users will need to take additional steps prior to installation.

Rust

Rust and Cargo must be installed, system-level, and in the PATH. Follow the instructions on-screen to install and add to PATH in the shell profile.

curl --proto '=https' --tlsv1.3 https://sh.rustup.rs -sSf | sh

Webkit

Next, install webkit.

  • Debian-based / Ubuntu / Mint: sudo apt install libwebkit2gtk-4.0-dev

  • Arch Linux / Manjaro: sudo pacman -S webkit2gtk

  • Fedora: sudo dnf install gtk3-devel webkit2gtk3-devel

PyPI

Within your existing OpenBB environment, install openbb-cli with:

pip install openbb-cli

The installation script adds openbb to the PATH within your Python environment. The application can be launched from any path, as long as the environment is active.

openbb

Welcome to Open Data Platform CLI v1.0.0

Source

Follow the instructions here to clone the GitHub repo and install the Open Data Platform from the source code.

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

:::tip The Python environment should have poetry installed.

pip install poetry

:::

Finally, enter:

python dev_install.py -e --cli

Installing New Modules

New extensions, or removals, are automatically added (removed) to the CLI on the next launch.