5.9 KiB
Vendored
title, sidebar_position, description, keywords
| title | sidebar_position | description | keywords | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Installation | 1 | 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. |
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
General System Requirements
Most systems capable of running Python 3.8-3.11 will be compatible with the OpenBB Platform. A modern processor (five years or less), running an up-to-date operating system, with at least 4GB of RAM, is recommended. Maintaining the system with current patches ensures maximum compatibility. At a minimum, Windows and macOS should be:
- Windows 10
- Mac OS Big Sur
Linux users should run the command line update for the package manager, prior to installation.
Supported Environments
The OpenBB Platform is installed within a Python virtual environment. It is compatible with versions of Python between 3.8 and 3.11, inclusively. The method for creating the environment will be a matter of user preference, from the command line - Conda, venv, Docker, etc. - or in a code editor and IDE - VS Code, PyCharm, Jupyter.
Docker builds the environment during the installation process, 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.
With the container created, and activated, begin the installation process.
Installation
Before installation, update the package manager so that pip is current, then create the environment with the desired version of Python and install the following packages:
:::note
Installing packages directly to the system Python or base environment is not recommended. Create a new environment.
:::
pip install poetry toml
PyPI
Install from PyPI with:
pip install openbb --pre
To install all of the extensions and providers:
pip install openbb[all] --pre
:::note
While still under active development, the pre flag is required to install the core OpenBB Platform latest version.
:::
To install a single extension:
pip install openbb[charting] --pre
pip install openbb[ta] --pre
Import the package with:
from openbb import obb
Docker
OpenBB supplies a .dockerfile on GitHub.
Run the following command from the repo root to build the image:
docker build -f build/docker/api.dockerfile -t openbb-platform:latest .
To run it:
docker run --rm -p 8000:8000 -v ~/.openbb_platform:/root/.openbb_platform openbb-platform:latest
This will mount the local ~/.openbb_platform directory into the Docker container to use with the API keys and preferences from there, and it will expose the API on port 8000.
Source
To build the OpenBB Platform from the source code, first install git:
pip install git
Next, clone the repository from GitHub:
git clone git@github.com:OpenBB-finance/OpenBBTerminal.git
When it is done, checkout the branch where the code is living:
git checkout feature/openbb-sdk-v4
Then, cd into the directory:
cd openbb_platform
Finally, run the developer installation script:
python dev_install.py
:::note
To install all extensions and providers, run: python dev_install.py -e
:::
With a fresh installation, or upon installing or uninstalling extensions, the Python interface needs to be built. This is done automatically, but can be manually triggered if required. Start a Python session and then import openbb:
python
import openbb
exit()
To manually trigger the build:
import openbb
openbb.build()
Restart the Python interpreter and then begin using the OpenBB Platform.
from openbb import obb
Start the REST API with:
uvicorn openbb_core.api.rest_api:app --host 0.0.0.0 --port 8000 --reload
Documentation
The documentation and packages are kept in the /website folder, at the base of the repository. Navigate there to install the dependencies and start the development server.
Node.js
- Node.js >= 16.13.0 To check if Node.js installed, run this command:
node --version # should be v16.13.0 or higher
Install Dependencies
npm install
Start Development Server
npm start
This starts a local development server at: http://localhost:3000
Most changes are reflected live without having to restart the server.
Build
npm run build
This command generates static content into the build directory and can be served using any static contents hosting service. OpenBB uses Github Pages to host our website, it's deployed in the gh-pages branch.