Installation

Most systems capable of running Python 3.10-3.13 will be compatible.

System Requirements

A modern processor (five years or less), running an up-to-date operating system, with at least 8GB of RAM, is recommended. Maintaining the system with current patches ensures maximum compatibility. At a minimum, Windows and macOS should be:

• Windows 11
• Mac OS Big Sur

Linux users should run the command line update for the package manager, prior to installation.

Install via ODP Desktop

For a graphical installer, see the ODP desktop application.

Setup Environment

tip

If you are having trouble with virtual environments or package installation, use the ODP Desktop Application instead.

The method for creating the environment will be a matter of user preference, from the command line - Conda, venv, etc. - or in a code editor and IDE - VS Code, PyCharm, Jupyter.

If you're interested in building a Docker container, skip ahead to the specific section below.

For those new to Python, this article shares some tips on getting started and why environments are important.

See this guide for creating a Python environment in VS Code.

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

warning

Installing packages directly to the system Python or base environment is not recommended. Create a new environment first.

Install

With the environment created, and activated, begin the installation process.

PyPI

pip install openbb

Docker

We provide a platformAPI.Dockerfile on GitHub

Run the following command from the repo root to build the image:

docker build -f build/docker/platformAPI.Dockerfile -t openbb-platform:latest .

To run it:

docker run -it --rm -p 6900:6900 -v ~/.openbb_platform:/root/.openbb_platform openbb-platform:latest

This will mount the local ~/.openbb_platform directory into the Docker container to use and exposes the API on port 6900.

Source

To install from source, create a Python virtual environment and update pip and setuptools, within the newly created environment, before installing any packages.

Details

To build the ODP Python packages from the source code, first install git:

pip install git

Next, clone the repository from GitHub:

git clone git@github.com:OpenBB-finance/OpenBB.git

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

git checkout develop

Then, cd into the directory:

cd openbb_platform

Install required packages

pip install poetry

Finally, run the developer installation script:

python dev_install.py

note

To install all extensions and providers, run: python dev_install.py -e

Post-Installation

When using the Python Interface, the static assets will need to be generated. This happens on first import but, when installing inside a container or CI, invoke the build command immediately after installation.

openbb-build

Getting Started

See the quickstart guide for getting started with the ODP Python Package.