From 240b106f2d6ab0dd6b979ac5b680f0b1e63a64f5 Mon Sep 17 00:00:00 2001 From: jose-donato Date: Thu, 2 Mar 2023 17:03:18 +0000 Subject: [PATCH 01/21] fix: changed button styles --- website/src/components/General/InstallerButton.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/src/components/General/InstallerButton.tsx b/website/src/components/General/InstallerButton.tsx index f26760d40a05..77f50c633ae3 100644 --- a/website/src/components/General/InstallerButton.tsx +++ b/website/src/components/General/InstallerButton.tsx @@ -3,7 +3,7 @@ export default function InstallerButton({ href, label, type }) { return ( From 461c4dfa0fdd405bb85602941801192cdf778d67 Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Fri, 3 Mar 2023 10:55:29 +0100 Subject: [PATCH 02/21] Make Rosetta requirements more clear --- .../content/terminal/quickstart/installation.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/website/content/terminal/quickstart/installation.md b/website/content/terminal/quickstart/installation.md index d25e1ed1c83d..733a446055ad 100644 --- a/website/content/terminal/quickstart/installation.md +++ b/website/content/terminal/quickstart/installation.md @@ -53,11 +53,19 @@ Install the OpenBB Terminal on Windows (10 or greater): ### B. MacOS Installer -Install the OpenBB Terminal on MacOS (Big Sur or later). There are two versions of the installers available for MacOS, Apple Silicon (M1) and Intel-based. Apple Silicon users will need to install Rosetta prior to installation. Install Rosetta from the command line: +Install the OpenBB Terminal on MacOS (Big Sur or later). There are two versions of the installers available for MacOS, Intel-based and Apple Silicon (M1) . **Apple Silicon users will need to install Rosetta prior to installation**. -```console -softwareupdate --install-rosetta -``` +Installing Rosetta can be done with the following steps: + +1. Press ⌘ (Command) + SPACE to open spotlight search, and type `Terminal` and hit Return (⏎). +2. Copy and paste the following code in the Terminal and hit ENTER (⏎): + ```console + softwareupdate --install-rosetta + ``` +3. This will start up the Rosetta installation process and you will receive a message regarding the Licence Agreement. Type `A` and hit Return (⏎). +4. After the installation process has finished, you can proceed t the "Mac M1 Installer" button. + +To understand whether you are using an Apple Sillicon (M1) device or an Intel-based device click on the Apple Icon at the top left of your MacBook and select "About This Mac". Then under "Chip" if it says something like "Apple M1 Pro" or "Apple M1 Max", you know you have an Apple Silicon MacBook. If it says for example "2,3 GHz Quad-Core Intel Core i7" you know that you have an Intel-based MacBook and you can continue by clicking on the "Mac Intel Installer" button.

From 769b6f60a60eb3fcede697cc605fec5e1eb01291 Mon Sep 17 00:00:00 2001 From: jeroen Date: Mon, 6 Mar 2023 15:22:09 +0100 Subject: [PATCH 03/21] Update installation instructions --- .../terminal/quickstart/installation.md | 538 +++++++++--------- 1 file changed, 284 insertions(+), 254 deletions(-) diff --git a/website/content/terminal/quickstart/installation.md b/website/content/terminal/quickstart/installation.md index c5ae3ae6d16b..db0566ed3f5b 100644 --- a/website/content/terminal/quickstart/installation.md +++ b/website/content/terminal/quickstart/installation.md @@ -19,419 +19,449 @@ keywords: openbb terminal, ] --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; import InstallerButton from "@site/src/components/General/InstallerButton"; The OpenBB Terminal can be directly installed on a Mac or Windows machine via the installer packages below. While not available for Linux is currently available, it can be installed from the command line in a virtual Python environment. Having trouble? Reach us on [Discord](https://openbb.co/discord) or visit our [contact page](https://openbb.co/contact). Follow along with the instructions for the preferred installation method: -## Installer Packages +:::info Installation Instructions -### A. Windows Installer + + + This section provides you with the installation file as well as the guide to install the OpenBB Terminal via Windows (10 or greater). -Install the OpenBB Terminal on Windows (10 or greater): + **Step 1:** Download the file by clicking on the button. -#### 1. Download + -**Step 1:** Download the file by clicking on the button. + **Step 2:** Open the downloaded file by double-clicking on it - + **Step 3:** Follow the prompts to complete the installation process -#### 2. Run Installer -**Step 2:** Open the downloaded file by double-clicking on it + **Step 4:** Launch the Terminal by double-clicking on the application shortcut added to the desktop. -#### 3. Follow Prompts + **Note:** The first launch may take up to a few minutes, subsequent launches will be quicker. + + -**Step 3:** Follow the prompts to complete the installation process + Install the OpenBB Terminal on MacOS (Big Sur or later). There are two versions of the installers available for MacOS, Intel-based and Apple Silicon (M1) . Apple Silicon users will need to install Rosetta prior to installation. -#### 4. Launch + To understand whether you are using an Apple Sillicon (M1) device or an Intel-based device click on the Apple Icon at the top left of your MacBook and select "About This Mac". Then under "Chip" if it says something like "Apple M1 Pro" or "Apple M1 Max", you know you have an Apple Silicon MacBook. If it says for example "2,3 GHz Quad-Core Intel Core i7" you know that you have an Intel-based MacBook and you can continue by clicking on the "Mac Intel Installer" button. -**Step 4:** Launch the Terminal by double-clicking on the application shortcut added to the desktop. +

Rosetta Installation Instructions (Apple Sillicon users only) -**Note:** The first launch may take up to a few minutes, subsequent launches will be quicker. + 1. Press ⌘ (Command) + SPACE to open spotlight search, and type `Terminal` and hit Return (⏎). + 2. Copy and paste the following code in the Terminal and hit ENTER (⏎): + ```console + softwareupdate --install-rosetta + ``` + 3. This will start up the Rosetta installation process and you will receive a message regarding the Licence Agreement. Type `A` and hit Return (⏎). + 4. After the installation process has finished, you can proceed t the "Mac M1 Installer" button. -### B. MacOS Installer -Install the OpenBB Terminal on MacOS (Big Sur or later). There are two versions of the installers available for MacOS, Intel-based and Apple Silicon (M1) . **Apple Silicon users will need to install Rosetta prior to installation**. +
-Installing Rosetta can be done with the following steps: + Once all of this is confirmed, you can use the following installation buttons. -1. Press ⌘ (Command) + SPACE to open spotlight search, and type `Terminal` and hit Return (⏎). -2. Copy and paste the following code in the Terminal and hit ENTER (⏎): - ```console - softwareupdate --install-rosetta - ``` -3. This will start up the Rosetta installation process and you will receive a message regarding the Licence Agreement. Type `A` and hit Return (⏎). -4. After the installation process has finished, you can proceed t the "Mac M1 Installer" button. +

+ +

+ + Step by step instructions: -To understand whether you are using an Apple Sillicon (M1) device or an Intel-based device click on the Apple Icon at the top left of your MacBook and select "About This Mac". Then under "Chip" if it says something like "Apple M1 Pro" or "Apple M1 Max", you know you have an Apple Silicon MacBook. If it says for example "2,3 GHz Quad-Core Intel Core i7" you know that you have an Intel-based MacBook and you can continue by clicking on the "Mac Intel Installer" button. + **Step 1:** Download the DMG file from the links above. -

- -

+ **Step 2:** Mount the downloaded DMG file by double-clicking on it. -#### 1. Download + **Step 3:** Click and drag the OpenBB Terminal folder and hold it over the Applications shortcut. This opens a new Finder window, then drag the OpenBB Terminal folder into the Applications folder. -**Step 1:** Download the DMG file from the links above. + ![MacOS Installation](https://user-images.githubusercontent.com/11668535/173027899-9b25ae4f-1eef-462c-9dc9-86086e9cf197.png) -#### 2. Mount DMG + **Step 4:** Unmount the installer, by "Ejecting OpenBB Terminal" from, locations, in Finder. -**Step 2:** Mount the downloaded DMG file by double-clicking on it. + **Step 5:** Launch the application by double-clicking on the `OpenBB Terminal` application. -#### 3. Drag Folder + **Note:** During the first launch, a warning message may appear. Click, "Open". -**Step 3:** Click and drag the OpenBB Terminal folder and hold it over the Applications shortcut. This opens a new Finder window, then drag the OpenBB Terminal folder into the Applications folder. + ![MacOS Installation](https://user-images.githubusercontent.com/85772166/220201620-1c42bbd4-7509-41fc-8df8-389f34fde58a.png) + + + + + Installing the OpenBB Terminal via Docker supports both Windows and Unix systems (Linux + MacOS). Installation differs a bit between operating system (Windows, macOS and Linux). Please select the section matching to your OS.

-![MacOS Installation](https://user-images.githubusercontent.com/11668535/173027899-9b25ae4f-1eef-462c-9dc9-86086e9cf197.png) + +
Windows -#### 4. Unmount DMG + **Install Docker Desktop** -**Step 4:** Unmount the installer, by "Ejecting OpenBB Terminal" from, locations, in Finder. + You can find `Docker Desktop` for MacOS here: [Download Docker Desktop](https://www.docker.com/products/docker-desktop) -#### 5. Launch + **Start Docker** -**Step 5:** Launch the application by double-clicking on the `OpenBB Terminal` application. + Execute the following command: -**Note:** During the first launch, a warning message may appear. Click, "Open". + ```console + docker info + ``` -![MacOS Installation](https://user-images.githubusercontent.com/85772166/220201620-1c42bbd4-7509-41fc-8df8-389f34fde58a.png) + If you have something like this, it means you haven't started Docker: ---- - -## Source Code - -The following instructions are for installing the OpenBB Terminal source code. - -### 1. System Preparation - -Prepare the system by installing the following items: + ```console + docker info + Server: + ERROR: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. + Is the docker daemon running? + ``` -#### 1.1 Install Miniconda + Start Docker, this is how the right output looks like: -[Install Miniconda](https://docs.conda.io/en/latest/miniconda.html) + ```console + docker info + Client: + Context: default + Debug Mode: false -Miniconda is a Python environment and package manager. It is required for installing certain dependencies. + Server: + Containers: 14 + Running: 2 + Paused: 1 + Stopped: 10 + ``` -- Go [here](https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links) to find the download for your operating system or use the links below: - - - Apple-Silicon Systems: [Miniconda for MacOS](https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.pkg) - - Intel-based Mac Systems: [Miniconda for MacOS](https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh) - - Linux and WSL Systems: [Miniconda for Linux](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh) - - Raspberry PI Systems: [Miniconda for Raspberry PI](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-aarch64.sh) - - Windows Systems: [Miniconda for Windows](https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe) + **Install VcXsrv** - **NOTE for Apple Silicon Users:** Install Rosetta from the command line: `softwareupdate --install-rosetta` + To display charts with your container, you need: VcXsrv. - **NOTE for Windows users:** Install/update Microsoft C++ Build Tools from [here](https://visualstudio.microsoft.com/visual-cpp-build-tools/). + You can download VcXsrv here: [Download VcXsrv](https://sourceforge.net/projects/vcxsrv) -#### 1.2 Install CMake + When running VcXsrv program check the option: `Disable access control` -**CMake is required by several Python modules.** + **Pull and run the container** -**For Windows:** + Execute this commands: -CMake is installed as a part of Microsoft C++ Build Tools. Skip ahead to the next step. + ```console + curl -o docker-compose.yaml https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/build/docker/docker-compose.yaml -**For MacOS:** + docker compose run openbb + ``` -Check if homebrew is installed by running `brew --version` + This will download and run the file: `docker-compose.yaml` -If Homebrew is not installed, run: + This file contents the settings to pull and run OpenBB Terminal Docker image. +
-```bash -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -brew install cmake -brew install gcc -``` +
MacOS -If Homebrew is already installed: + **Install Docker Desktop** -```bash -brew install cmake -brew install gcc -``` + You can find `Docker Desktop` for Linux here: [Download Docker Desktop](https://www.docker.com/products/docker-desktop) -**For Linux:** + **Start Docker** -```bash -sudo apt update && sudo apt upgrade -sudo apt install -y gcc cmake -``` + Execute the following command: -#### 1.3 Linux and WSL Only + ```console + docker info + ``` -Since a WSL installation is headless by default (i.e., there is only access to a terminal running a Linux distribution) there are additional steps required to display visualizations. A more detailed tutorial is found, [here](https://medium.com/@shaoyenyu/make-matplotlib-works-correctly-with-x-server-in-wsl2-9d9928b4e36a). + If you have something like this, it means you haven't started Docker: -- Dynamically export the DISPLAY environment variable in WSL2: + ```console + docker info + Server: + ERROR: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. + Is the docker daemon running? + ``` -```console -# add to the end of ~/.bashrc file -export DISPLAY=$(cat /etc/resolv.conf | grep nameserver | awk '{print $2}'):0 -# source the file -source ~/.bashrc -``` + Start Docker, this is how the right output looks like: -- Download and install [VcXsrv](https://sourceforge.net/projects/vcxsrv/) -- When running the program is important to check "Disable access control" + ```console + docker info + Client: + Context: default + Debug Mode: false -After this, `VcXsrv` should be running successfully, and the machine is ready to proceed with the terminal installation. + Server: + Containers: 14 + Running: 2 + Paused: 1 + Stopped: 10 + ``` -Alternatives to `VcXsrv` include: + **Install XQuartz** -- [GWSL](https://opticos.github.io/gwsl/) -- [Xming](https://xming.en.softonic.com/) -- [Wayland](https://wayland.freedesktop.org/docs/html/) + You can download XQuartz here: [Download XQuartz](https://www.xquartz.org) -### 2. Create Environment + Open X Quartz. -The first step is to create the virtual Python environment. + Then on `Preferences > Security`. -#### 2.1 Confirm Conda Base + Make sure both of these options are enabled: -When a terminal window is opened, if the base Conda environment - look for `(base)` to the left of the cursor on the command line - is not activated automatically, find the path for it by entering: + - `Authenticate connections` + - `Allow connections from network clients` -```console -conda env list -``` + It should look like this: + ![Screen Shot 2021-09-08 at 12 21 48 PM](https://user-images.githubusercontent.com/18151143/132548605-235d774b-9aa6-4a45-afcf-58fb775d376a.png) -Copy the path which corresponds with `base`, and activate it with: + **Get Docker IP** -```console -conda activate REPLACE_WITH_PATH -``` + To get Docker IP you can use this command: -Check which `conda` version is installed by entering: + ```bash + IP=$(ifconfig | grep inet | grep -v "127.0.0.1" | awk '$1=="inet" {print $2}') + ``` -```console -conda -V -``` + **Pull and run the container** -As of writing, the most recent version of `Conda` is, `23.1.0`. If required, update from a lower version with: + Execute this commands: -```console -conda install -c conda-forge -n base conda=23.1.0 -``` + ```console + curl -o docker-compose.yaml https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/build/docker/docker-compose.yaml -#### 2.2 Create the Environment + xhost +$IP + docker compose run -e DISPLAY=$IP:0 openbb + ``` -Create the environment by copying the code below into the command line: + This will download and run the file: `docker-compose.yaml` -```console -conda create -n obb -c conda-forge python=3.10.9 pip pybind11 cmake git cvxpy lightgbm poetry -``` + This file contents the settings to pull and run OpenBB Terminal Docker image. -### 3. Activate Environment + The `xhost +$IP` and `DISPLAY=$IP:0` parts are there to allow charts display. -After the packages from Step 2 install, activate the newly created environment by entering: -```console -conda activate obb -``` +
-### 4. Install OpenBB Terminal +
Linux -From the command line, navigate into a folder where the installation should live. Do not continue without completing steps 1-3. + **Install Docker Desktop** -#### 4.1 Clone the Project + You can find `Docker Desktop` for Windows here: [Download Docker Desktop](https://www.docker.com/products/docker-desktop) -Cloning the GitHub repo will download the source code to the current working directory. + **Start Docker** -```console -git clone https://github.com/OpenBB-finance/OpenBBTerminal.git -``` + Execute the following command: -#### 4.2 Navigate to OpenBBTerminal + ```console + docker info + ``` -```console -cd OpenBBTerminal -``` + If you have something like this, it means you haven't started Docker: -#### 4.3 Install Remaining Packages + ```console + docker info + Server: + ERROR: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. + Is the docker daemon running? + ``` -```bash -pip install qdldl==0.1.5.post3 -poetry install -E all -``` + Start Docker, this is how the right output looks like: -#### 4.4 Launch OpenBB Terminal + ```console + docker info + Client: + Context: default + Debug Mode: false -Start the terminal by running: + Server: + Containers: 14 + Running: 2 + Paused: 1 + Stopped: 10 + ``` -```bash -python terminal.py -``` + **Pull and run the container** -**NOTE:** When a terminal is re-opened, the Python environment will need to be activated again - `conda activate obb` - and the current working directory should be the `OpenBBTerminal` folder where the source code was cloned. + Execute this commands: -**TROUBLESHOOTING:** Having difficulty getting through the installation, or encountering errors? Check out the [troubleshooting page](/terminal/quickstart/troubleshooting), or reach out to our [Discord](https://discord.gg/Up2QGbMKHY) community for help. + ```console + curl -o docker-compose.yaml https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/build/docker/docker-compose.yaml ---- + xhost +local: + docker compose run openbb + ``` -## Docker + Note: if you're using remote docker host, you can connect with `ssh -X `. -Installing the OpenBB Terminal via Docker supports both Windows and Unix systems (Linux + MacOS). Installation differs a bit between operating system (Windows, macOS and Linux). Please select the section matching to your OS. +
-### 1. Windows + --- -#### 1.1. Install Docker Desktop + + -You can find `Docker Desktop` for Windows here: [Download Docker Desktop](https://www.docker.com/products/docker-desktop) + This section guides you a long to install the OpenBB Terminal via Python. This installation type supports both Windows and Unix systems (Linux + MacOS). -#### 1.2. Start Docker + Before starting the installation process, make sure you the following pieces of software are installed. -Execute the following command: +
Miniconda + Miniconda is a Python environment and package manager. It is required for installing certain dependencies. -```console -docker info -``` + Go [here](https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links) to find the download for your operating system or use the links below: -If you have something like this, it means you haven't started Docker: + - Apple-Silicon Systems: [Miniconda for MacOS](https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.pkg) + - Intel-based Mac Systems: [Miniconda for MacOS](https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh) + - Linux and WSL Systems: [Miniconda for Linux](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh) + - Raspberry PI Systems: [Miniconda for Raspberry PI](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-aarch64.sh) + - Windows Systems: [Miniconda for Windows](https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe) -```console -docker info -Server: -ERROR: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. -Is the docker daemon running? -``` -Start Docker, this is how the right output looks like: + **NOTE for Apple Silicon Users:** Install Rosetta from the command line: `softwareupdate --install-rosetta` -```console -docker info -Client: - Context: default - Debug Mode: false + **NOTE for Windows users:** Install/update Microsoft C++ Build Tools from [here](https://visualstudio.microsoft.com/visual-cpp-build-tools/). +
-Server: - Containers: 14 - Running: 2 - Paused: 1 - Stopped: 10 -``` +
CMake (Mac and Linux only) + If you have a **MacBook**, check if homebrew is installed by running `brew --version` -#### 1.3. Install VcXsrv + If Homebrew is not installed, run: -To display charts with your container, you need : VcXsrv. + ```bash + /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" + brew install cmake + brew install gcc + ``` -You can download VcXsrv here : [Download VcXsrv](https://sourceforge.net/projects/vcxsrv) + If Homebrew is already installed: -When running VcXsrv program check the option: `Disable access control` + ```bash + brew install cmake + brew install gcc + ``` -#### 1.4. Pull and run the container + If you have a **Linux** computer, use the following script: -Execute this commands: + ```bash + sudo apt update && sudo apt upgrade + sudo apt install -y gcc cmake + ``` +
-```console -curl -o docker-compose.yaml https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/build/docker/docker-compose.yaml +
VcXsrv (Windows and Linux only) + Since a WSL installation is headless by default (i.e., there is only access to a terminal running a Linux distribution) there are additional steps required to display visualizations. A more detailed tutorial is found, [here](https://medium.com/@shaoyenyu/make-matplotlib-works-correctly-with-x-server-in-wsl2-9d9928b4e36a). -docker compose run openbb -``` + - Dynamically export the DISPLAY environment variable in WSL2: -This will download and run the file: `docker-compose.yaml` + ```console + # add to the end of ~/.bashrc file + export DISPLAY=$(cat /etc/resolv.conf | grep nameserver | awk '{print $2}'):0 + # source the file + source ~/.bashrc + ``` -This file contents the settings to pull and run OpenBB Terminal Docker image. + - Download and install [VcXsrv](https://sourceforge.net/projects/vcxsrv/) + - When running the program is important to check "Disable access control" -### 2. MacOS + After this, `VcXsrv` should be running successfully, and the machine is ready to proceed with the terminal installation. -#### 2.1. Install and run Docker Desktop + Alternatives to `VcXsrv` include: -Install and run Docker Desktop as describe above in this document. + - [GWSL](https://opticos.github.io/gwsl/) + - [Xming](https://xming.en.softonic.com/) + - [Wayland](https://wayland.freedesktop.org/docs/html/) -#### 2.2. Install XQuartz -You can download XQuartz here: [Download XQuartz](https://www.xquartz.org) +
-Open X Quartz. + Once you have met all of these requirements, you are ready to install the OpenBB Terminal. -Then on `Preferences > Security`. -Make sure both of these options are enabled: + **Creating a virtual environment** -- `Authenticate connections` -- `Allow connections from network clients` + When a terminal window is opened, if the base Conda environment - look for `(base)` to the left of the cursor on the command line - is not activated automatically, find the path for it by entering: -It should look like this: -![Screen Shot 2021-09-08 at 12 21 48 PM](https://user-images.githubusercontent.com/18151143/132548605-235d774b-9aa6-4a45-afcf-58fb775d376a.png) + ```console + conda env list + ``` -#### 2.3. Get Docker IP + Copy the path which corresponds with `base`, and activate it with: -To get Docker IP you can use this command: + ```console + conda activate REPLACE_WITH_PATH + ``` -```bash -IP=$(ifconfig | grep inet | grep -v "127.0.0.1" | awk '$1=="inet" {print $2}') -``` + Check which `conda` version is installed by entering: -#### 2.4. Pull and run the container + ```console + conda -V + ``` -Execute this commands: + Create the environment by copying the code below into the command line: -```console -curl -o docker-compose.yaml https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/build/docker/docker-compose.yaml + ```console + conda create -n obb -c conda-forge python=3.10.9 pip pybind11 cmake git cvxpy lightgbm poetry + ``` -xhost +$IP -docker compose run -e DISPLAY=$IP:0 openbb -``` + **Activate the obb environment** -This will download and run the file: `docker-compose.yaml` + After the packages from the previous step are installled, activate the newly created environment by entering: -This file contents the settings to pull and run OpenBB Terminal Docker image. + ```console + conda activate obb + ``` -The `xhost +$IP` and `DISPLAY=$IP:0` parts are there to allow charts display. + **Install OpenBB Terminal** -### 3. Linux + From your code editor or command line, browse to the location the OpenBB Terminal source code should live. Make sure you have completed the previous steps. -#### 3.1. Install and run Docker Desktop + This starts by cloning the GitHub repository. This will download the source code to the current working directory. -Install and run Docker Desktop as describe above in this document. + ```console + git clone https://github.com/OpenBB-finance/OpenBBTerminal.git + ``` -#### 3.2. Pull and run the container + Then, navigate to this folder. This can be done in command line or through the code editor by opening the folder. -Execute this commands: + ```console + cd OpenBBTerminal + ``` -```console -curl -o docker-compose.yaml https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/build/docker/docker-compose.yaml + There are a few packages that required to be installed. This is done through Poetry, a package manager. -xhost +local: -docker compose run openbb -``` + ```bash + pip install qdldl==0.1.5.post3 + poetry install -E all + ``` -Note: if you're using remote docker host, you can connect with `ssh -X `. + Once this installation process is completed, you can start the terminal by running: -### 4. Advanced + ```bash + python terminal.py + ``` -#### Without Docker Compose + **NOTE:** When you are opening the OpenBB Terminal from a Terminal application, the Python environment will need to be activated again - `conda activate obb` - and the current working directory should be the `OpenBBTerminal` folder where the source code was cloned. When using a code editor, make sure that you have the correct environment selected. This should be easy to figure out if you get an error that you are missing packages. -To run directly the docker image you can use the following command: + **TROUBLESHOOTING:** Having difficulty getting through the installation, or encountering errors? Check out the [troubleshooting page](/terminal/quickstart/troubleshooting), or reach out to our [Discord](https://discord.gg/Up2QGbMKHY) community for help. -```console -docker run --rm -it \ - -v ~/.openbb_terminal/:/home/python/.openbb_terminal \ - -v ~/OpenBBUserData:/home/python/OpenBBUserData \ - ghcr.io/openbb-finance/openbbterminal/openbb:latest -``` + **Advanced: About Poetry** ---- + By default we advise using `conda` and `poetry` for environment setup and dependency management. Conda ships binaries for packages like `numpy` so these dependencies are not built from source locally by `pip`. Poetry solves the dependency tree in a way that the dependencies of dependencies of dependencies use versions that are compatible with each other. -## Advanced Installation + For `Conda` environments, the `build/conda` folder contains multiple `.yaml` configuration files to choose from. -By default we advise using `conda` and `poetry` for environment setup and dependency management. Conda ships binaries for packages like `numpy` so these dependencies are not built from source locally by `pip`. Poetry solves the dependency tree in a way that the dependencies of dependencies of dependencies use versions that are compatible with each other. + When using other python distributions we highly recommend a virtual environment like `virtualenv` or `pyenv` for installing the terminal dependency libraries. -For `Conda` environments, the `build/conda` folder contains multiple `.yaml` configuration files to choose from. + Requirements files that are found in the project root: -When using other python distributions we highly recommend a virtual environment like `virtualenv` or `pyenv` for installing the terminal dependency libraries. + - `requirements.txt` list all the dependencies without Machine Learning libraries + - `requirements-full.txt` list all the dependencies with Machine Learning libraries -Requirements files that are found in the project root: + They can be installed with `pip`: -- `requirements.txt` list all the dependencies without Machine Learning libraries -- `requirements-full.txt` list all the dependencies with Machine Learning libraries + ```bash + pip install -r requirements.txt + ``` -They can be installed with `pip`: + The dependency tree is solved by poetry. -```bash -pip install -r requirements.txt -``` + Note: The libraries specified in the requirements files have been tested and work for the purpose of this project, however, these may be older versions. Hence, it is recommended for the user to set up a virtual python environment prior to installing these. This allows to keep dependencies required by different projects in separate places. -The dependency tree is solved by poetry. + -Note: The libraries specified in the requirements files have been tested and work for the purpose of this project, however, these may be older versions. Hence, it is recommended for the user to set up a virtual python environment prior to installing these. This allows to keep dependencies required by different projects in separate places. + \ No newline at end of file From 2b80f55ee8396b61bdb70ac0043b5d7635aae157 Mon Sep 17 00:00:00 2001 From: jeroen Date: Mon, 6 Mar 2023 15:48:55 +0100 Subject: [PATCH 04/21] Add seperation --- .../terminal/quickstart/installation.md | 467 ------------------ .../quickstart/installation/_index.md | 28 ++ .../quickstart/installation/docker.md | 219 ++++++++ .../terminal/quickstart/installation/macos.md | 62 +++ .../quickstart/installation/source.md | 185 +++++++ .../quickstart/installation/windows.md | 40 ++ 6 files changed, 534 insertions(+), 467 deletions(-) delete mode 100644 website/content/terminal/quickstart/installation.md create mode 100644 website/content/terminal/quickstart/installation/_index.md create mode 100644 website/content/terminal/quickstart/installation/docker.md create mode 100644 website/content/terminal/quickstart/installation/macos.md create mode 100644 website/content/terminal/quickstart/installation/source.md create mode 100644 website/content/terminal/quickstart/installation/windows.md diff --git a/website/content/terminal/quickstart/installation.md b/website/content/terminal/quickstart/installation.md deleted file mode 100644 index db0566ed3f5b..000000000000 --- a/website/content/terminal/quickstart/installation.md +++ /dev/null @@ -1,467 +0,0 @@ ---- -title: Installation -sidebar_position: 2 -description: The OpenBB Terminal can be directly installed on a Mac or Windows machine via the installer packages below. While not available for Linux is currently available, it can be installed from the command line in a virtual Python environment. -keywords: - [ - installation, - installer, - install, - guide, - mac, - windows, - linux, - python, - github, - macos, - how to, - explanation, - openbb terminal, - ] ---- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import InstallerButton from "@site/src/components/General/InstallerButton"; - -The OpenBB Terminal can be directly installed on a Mac or Windows machine via the installer packages below. While not available for Linux is currently available, it can be installed from the command line in a virtual Python environment. Having trouble? Reach us on [Discord](https://openbb.co/discord) or visit our [contact page](https://openbb.co/contact). - -Follow along with the instructions for the preferred installation method: - -:::info Installation Instructions - - - - This section provides you with the installation file as well as the guide to install the OpenBB Terminal via Windows (10 or greater). - - **Step 1:** Download the file by clicking on the button. - - - - **Step 2:** Open the downloaded file by double-clicking on it - - **Step 3:** Follow the prompts to complete the installation process - - - **Step 4:** Launch the Terminal by double-clicking on the application shortcut added to the desktop. - - **Note:** The first launch may take up to a few minutes, subsequent launches will be quicker. - - - - Install the OpenBB Terminal on MacOS (Big Sur or later). There are two versions of the installers available for MacOS, Intel-based and Apple Silicon (M1) . Apple Silicon users will need to install Rosetta prior to installation. - - To understand whether you are using an Apple Sillicon (M1) device or an Intel-based device click on the Apple Icon at the top left of your MacBook and select "About This Mac". Then under "Chip" if it says something like "Apple M1 Pro" or "Apple M1 Max", you know you have an Apple Silicon MacBook. If it says for example "2,3 GHz Quad-Core Intel Core i7" you know that you have an Intel-based MacBook and you can continue by clicking on the "Mac Intel Installer" button. - -
Rosetta Installation Instructions (Apple Sillicon users only) - - 1. Press ⌘ (Command) + SPACE to open spotlight search, and type `Terminal` and hit Return (⏎). - 2. Copy and paste the following code in the Terminal and hit ENTER (⏎): - ```console - softwareupdate --install-rosetta - ``` - 3. This will start up the Rosetta installation process and you will receive a message regarding the Licence Agreement. Type `A` and hit Return (⏎). - 4. After the installation process has finished, you can proceed t the "Mac M1 Installer" button. - - -
- - Once all of this is confirmed, you can use the following installation buttons. - -

- -

- - Step by step instructions: - - **Step 1:** Download the DMG file from the links above. - - **Step 2:** Mount the downloaded DMG file by double-clicking on it. - - **Step 3:** Click and drag the OpenBB Terminal folder and hold it over the Applications shortcut. This opens a new Finder window, then drag the OpenBB Terminal folder into the Applications folder. - - ![MacOS Installation](https://user-images.githubusercontent.com/11668535/173027899-9b25ae4f-1eef-462c-9dc9-86086e9cf197.png) - - **Step 4:** Unmount the installer, by "Ejecting OpenBB Terminal" from, locations, in Finder. - - **Step 5:** Launch the application by double-clicking on the `OpenBB Terminal` application. - - **Note:** During the first launch, a warning message may appear. Click, "Open". - - ![MacOS Installation](https://user-images.githubusercontent.com/85772166/220201620-1c42bbd4-7509-41fc-8df8-389f34fde58a.png) - - - - - Installing the OpenBB Terminal via Docker supports both Windows and Unix systems (Linux + MacOS). Installation differs a bit between operating system (Windows, macOS and Linux). Please select the section matching to your OS.

- - -
Windows - - **Install Docker Desktop** - - You can find `Docker Desktop` for MacOS here: [Download Docker Desktop](https://www.docker.com/products/docker-desktop) - - **Start Docker** - - Execute the following command: - - ```console - docker info - ``` - - If you have something like this, it means you haven't started Docker: - - ```console - docker info - Server: - ERROR: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. - Is the docker daemon running? - ``` - - Start Docker, this is how the right output looks like: - - ```console - docker info - Client: - Context: default - Debug Mode: false - - Server: - Containers: 14 - Running: 2 - Paused: 1 - Stopped: 10 - ``` - - **Install VcXsrv** - - To display charts with your container, you need: VcXsrv. - - You can download VcXsrv here: [Download VcXsrv](https://sourceforge.net/projects/vcxsrv) - - When running VcXsrv program check the option: `Disable access control` - - **Pull and run the container** - - Execute this commands: - - ```console - curl -o docker-compose.yaml https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/build/docker/docker-compose.yaml - - docker compose run openbb - ``` - - This will download and run the file: `docker-compose.yaml` - - This file contents the settings to pull and run OpenBB Terminal Docker image. -
- -
MacOS - - **Install Docker Desktop** - - You can find `Docker Desktop` for Linux here: [Download Docker Desktop](https://www.docker.com/products/docker-desktop) - - **Start Docker** - - Execute the following command: - - ```console - docker info - ``` - - If you have something like this, it means you haven't started Docker: - - ```console - docker info - Server: - ERROR: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. - Is the docker daemon running? - ``` - - Start Docker, this is how the right output looks like: - - ```console - docker info - Client: - Context: default - Debug Mode: false - - Server: - Containers: 14 - Running: 2 - Paused: 1 - Stopped: 10 - ``` - - **Install XQuartz** - - You can download XQuartz here: [Download XQuartz](https://www.xquartz.org) - - Open X Quartz. - - Then on `Preferences > Security`. - - Make sure both of these options are enabled: - - - `Authenticate connections` - - `Allow connections from network clients` - - It should look like this: - ![Screen Shot 2021-09-08 at 12 21 48 PM](https://user-images.githubusercontent.com/18151143/132548605-235d774b-9aa6-4a45-afcf-58fb775d376a.png) - - **Get Docker IP** - - To get Docker IP you can use this command: - - ```bash - IP=$(ifconfig | grep inet | grep -v "127.0.0.1" | awk '$1=="inet" {print $2}') - ``` - - **Pull and run the container** - - Execute this commands: - - ```console - curl -o docker-compose.yaml https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/build/docker/docker-compose.yaml - - xhost +$IP - docker compose run -e DISPLAY=$IP:0 openbb - ``` - - This will download and run the file: `docker-compose.yaml` - - This file contents the settings to pull and run OpenBB Terminal Docker image. - - The `xhost +$IP` and `DISPLAY=$IP:0` parts are there to allow charts display. - - -
- -
Linux - - **Install Docker Desktop** - - You can find `Docker Desktop` for Windows here: [Download Docker Desktop](https://www.docker.com/products/docker-desktop) - - **Start Docker** - - Execute the following command: - - ```console - docker info - ``` - - If you have something like this, it means you haven't started Docker: - - ```console - docker info - Server: - ERROR: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. - Is the docker daemon running? - ``` - - Start Docker, this is how the right output looks like: - - ```console - docker info - Client: - Context: default - Debug Mode: false - - Server: - Containers: 14 - Running: 2 - Paused: 1 - Stopped: 10 - ``` - - **Pull and run the container** - - Execute this commands: - - ```console - curl -o docker-compose.yaml https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/build/docker/docker-compose.yaml - - xhost +local: - docker compose run openbb - ``` - - Note: if you're using remote docker host, you can connect with `ssh -X `. - -
- - --- - - - - - This section guides you a long to install the OpenBB Terminal via Python. This installation type supports both Windows and Unix systems (Linux + MacOS). - - Before starting the installation process, make sure you the following pieces of software are installed. - -
Miniconda - Miniconda is a Python environment and package manager. It is required for installing certain dependencies. - - Go [here](https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links) to find the download for your operating system or use the links below: - - - Apple-Silicon Systems: [Miniconda for MacOS](https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.pkg) - - Intel-based Mac Systems: [Miniconda for MacOS](https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh) - - Linux and WSL Systems: [Miniconda for Linux](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh) - - Raspberry PI Systems: [Miniconda for Raspberry PI](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-aarch64.sh) - - Windows Systems: [Miniconda for Windows](https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe) - - - **NOTE for Apple Silicon Users:** Install Rosetta from the command line: `softwareupdate --install-rosetta` - - **NOTE for Windows users:** Install/update Microsoft C++ Build Tools from [here](https://visualstudio.microsoft.com/visual-cpp-build-tools/). -
- -
CMake (Mac and Linux only) - If you have a **MacBook**, check if homebrew is installed by running `brew --version` - - If Homebrew is not installed, run: - - ```bash - /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" - brew install cmake - brew install gcc - ``` - - If Homebrew is already installed: - - ```bash - brew install cmake - brew install gcc - ``` - - If you have a **Linux** computer, use the following script: - - ```bash - sudo apt update && sudo apt upgrade - sudo apt install -y gcc cmake - ``` -
- -
VcXsrv (Windows and Linux only) - Since a WSL installation is headless by default (i.e., there is only access to a terminal running a Linux distribution) there are additional steps required to display visualizations. A more detailed tutorial is found, [here](https://medium.com/@shaoyenyu/make-matplotlib-works-correctly-with-x-server-in-wsl2-9d9928b4e36a). - - - Dynamically export the DISPLAY environment variable in WSL2: - - ```console - # add to the end of ~/.bashrc file - export DISPLAY=$(cat /etc/resolv.conf | grep nameserver | awk '{print $2}'):0 - # source the file - source ~/.bashrc - ``` - - - Download and install [VcXsrv](https://sourceforge.net/projects/vcxsrv/) - - When running the program is important to check "Disable access control" - - After this, `VcXsrv` should be running successfully, and the machine is ready to proceed with the terminal installation. - - Alternatives to `VcXsrv` include: - - - [GWSL](https://opticos.github.io/gwsl/) - - [Xming](https://xming.en.softonic.com/) - - [Wayland](https://wayland.freedesktop.org/docs/html/) - - -
- - Once you have met all of these requirements, you are ready to install the OpenBB Terminal. - - - **Creating a virtual environment** - - When a terminal window is opened, if the base Conda environment - look for `(base)` to the left of the cursor on the command line - is not activated automatically, find the path for it by entering: - - ```console - conda env list - ``` - - Copy the path which corresponds with `base`, and activate it with: - - ```console - conda activate REPLACE_WITH_PATH - ``` - - Check which `conda` version is installed by entering: - - ```console - conda -V - ``` - - Create the environment by copying the code below into the command line: - - ```console - conda create -n obb -c conda-forge python=3.10.9 pip pybind11 cmake git cvxpy lightgbm poetry - ``` - - **Activate the obb environment** - - After the packages from the previous step are installled, activate the newly created environment by entering: - - ```console - conda activate obb - ``` - - **Install OpenBB Terminal** - - From your code editor or command line, browse to the location the OpenBB Terminal source code should live. Make sure you have completed the previous steps. - - This starts by cloning the GitHub repository. This will download the source code to the current working directory. - - ```console - git clone https://github.com/OpenBB-finance/OpenBBTerminal.git - ``` - - Then, navigate to this folder. This can be done in command line or through the code editor by opening the folder. - - ```console - cd OpenBBTerminal - ``` - - There are a few packages that required to be installed. This is done through Poetry, a package manager. - - ```bash - pip install qdldl==0.1.5.post3 - poetry install -E all - ``` - - Once this installation process is completed, you can start the terminal by running: - - ```bash - python terminal.py - ``` - - **NOTE:** When you are opening the OpenBB Terminal from a Terminal application, the Python environment will need to be activated again - `conda activate obb` - and the current working directory should be the `OpenBBTerminal` folder where the source code was cloned. When using a code editor, make sure that you have the correct environment selected. This should be easy to figure out if you get an error that you are missing packages. - - **TROUBLESHOOTING:** Having difficulty getting through the installation, or encountering errors? Check out the [troubleshooting page](/terminal/quickstart/troubleshooting), or reach out to our [Discord](https://discord.gg/Up2QGbMKHY) community for help. - - **Advanced: About Poetry** - - By default we advise using `conda` and `poetry` for environment setup and dependency management. Conda ships binaries for packages like `numpy` so these dependencies are not built from source locally by `pip`. Poetry solves the dependency tree in a way that the dependencies of dependencies of dependencies use versions that are compatible with each other. - - For `Conda` environments, the `build/conda` folder contains multiple `.yaml` configuration files to choose from. - - When using other python distributions we highly recommend a virtual environment like `virtualenv` or `pyenv` for installing the terminal dependency libraries. - - Requirements files that are found in the project root: - - - `requirements.txt` list all the dependencies without Machine Learning libraries - - `requirements-full.txt` list all the dependencies with Machine Learning libraries - - They can be installed with `pip`: - - ```bash - pip install -r requirements.txt - ``` - - The dependency tree is solved by poetry. - - Note: The libraries specified in the requirements files have been tested and work for the purpose of this project, however, these may be older versions. Hence, it is recommended for the user to set up a virtual python environment prior to installing these. This allows to keep dependencies required by different projects in separate places. - - - - \ No newline at end of file diff --git a/website/content/terminal/quickstart/installation/_index.md b/website/content/terminal/quickstart/installation/_index.md new file mode 100644 index 000000000000..20de799e574c --- /dev/null +++ b/website/content/terminal/quickstart/installation/_index.md @@ -0,0 +1,28 @@ +--- +title: Installation +sidebar_position: 2 +description: The OpenBB Terminal can be directly installed on a Mac or Windows machine via the installer packages below. While not available for Linux is currently available, it can be installed from the command line in a virtual Python environment. +keywords: + [ + installation, + installer, + install, + guide, + mac, + windows, + linux, + python, + github, + macos, + how to, + explanation, + openbb terminal, + ] +--- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import InstallerButton from "@site/src/components/General/InstallerButton"; + +The OpenBB Terminal can be directly installed on a Mac or Windows machine via the installer packages below. While not available for Linux is currently available, it can be installed from the command line in a virtual Python environment. Having trouble? Reach us on [Discord](https://openbb.co/discord) or visit our [contact page](https://openbb.co/contact). + +Follow along with the instructions for the preferred installation method: diff --git a/website/content/terminal/quickstart/installation/docker.md b/website/content/terminal/quickstart/installation/docker.md new file mode 100644 index 000000000000..58e668e5e0f4 --- /dev/null +++ b/website/content/terminal/quickstart/installation/docker.md @@ -0,0 +1,219 @@ +--- +title: Docker +sidebar_position: 3 +description: Installing the OpenBB Terminal via Docker supports both Windows and Unix systems (Linux + MacOS). Installation differs a bit between operating system (Windows, macOS and Linux). Please select the section matching to your OS. +keywords: + [ + installation, + installer, + install, + guide, + mac, + windows, + linux, + python, + github, + macos, + how to, + explanation, + openbb terminal, + ] +--- + +Installing the OpenBB Terminal via Docker supports both Windows and Unix systems (Linux + MacOS). Installation differs a bit between operating system (Windows, macOS and Linux). Please select the section matching to your OS.

+ +
Windows + +**Install Docker Desktop** + +You can find `Docker Desktop` for MacOS here: [Download Docker Desktop](https://www.docker.com/products/docker-desktop) + +**Start Docker** + +Execute the following command: + +```console +docker info +``` + +If you have something like this, it means you haven't started Docker: + +```console +docker info +Server: +ERROR: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. +Is the docker daemon running? +``` + +Start Docker, this is how the right output looks like: + +```console +docker info +Client: +Context: default +Debug Mode: false + +Server: +Containers: 14 +Running: 2 +Paused: 1 +Stopped: 10 +``` + +**Install VcXsrv** + +To display charts with your container, you need: VcXsrv. + +You can download VcXsrv here: [Download VcXsrv](https://sourceforge.net/projects/vcxsrv) + +When running VcXsrv program check the option: `Disable access control` + +**Pull and run the container** + +Execute this commands: + +```console +curl -o docker-compose.yaml https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/build/docker/docker-compose.yaml + +docker compose run openbb +``` + +This will download and run the file: `docker-compose.yaml` + +This file contents the settings to pull and run OpenBB Terminal Docker image. +
+ +
MacOS + +**Install Docker Desktop** + +You can find `Docker Desktop` for Linux here: [Download Docker Desktop](https://www.docker.com/products/docker-desktop) + +**Start Docker** + +Execute the following command: + +```console +docker info +``` + +If you have something like this, it means you haven't started Docker: + +```console +docker info +Server: +ERROR: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. +Is the docker daemon running? +``` + +Start Docker, this is how the right output looks like: + +```console +docker info +Client: +Context: default +Debug Mode: false + +Server: +Containers: 14 +Running: 2 +Paused: 1 +Stopped: 10 +``` + +**Install XQuartz** + +You can download XQuartz here: [Download XQuartz](https://www.xquartz.org) + +Open X Quartz. + +Then on `Preferences > Security`. + +Make sure both of these options are enabled: + +- `Authenticate connections` +- `Allow connections from network clients` + +It should look like this: +![Screen Shot 2021-09-08 at 12 21 48 PM](https://user-images.githubusercontent.com/18151143/132548605-235d774b-9aa6-4a45-afcf-58fb775d376a.png) + +**Get Docker IP** + +To get Docker IP you can use this command: + +```bash +IP=$(ifconfig | grep inet | grep -v "127.0.0.1" | awk '$1=="inet" {print $2}') +``` + +**Pull and run the container** + +Execute this commands: + +```console +curl -o docker-compose.yaml https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/build/docker/docker-compose.yaml + +xhost +$IP +docker compose run -e DISPLAY=$IP:0 openbb +``` + +This will download and run the file: `docker-compose.yaml` + +This file contents the settings to pull and run OpenBB Terminal Docker image. + +The `xhost +$IP` and `DISPLAY=$IP:0` parts are there to allow charts display. + + +
+ +
Linux + +**Install Docker Desktop** + +You can find `Docker Desktop` for Windows here: [Download Docker Desktop](https://www.docker.com/products/docker-desktop) + +**Start Docker** + +Execute the following command: + +```console +docker info +``` + +If you have something like this, it means you haven't started Docker: + +```console +docker info +Server: +ERROR: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. +Is the docker daemon running? +``` + +Start Docker, this is how the right output looks like: + +```console +docker info +Client: +Context: default +Debug Mode: false + +Server: +Containers: 14 +Running: 2 +Paused: 1 +Stopped: 10 +``` + +**Pull and run the container** + +Execute this commands: + +```console +curl -o docker-compose.yaml https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/build/docker/docker-compose.yaml + +xhost +local: +docker compose run openbb +``` + +Note: if you're using remote docker host, you can connect with `ssh -X `. + +
diff --git a/website/content/terminal/quickstart/installation/macos.md b/website/content/terminal/quickstart/installation/macos.md new file mode 100644 index 000000000000..51c79f37d5d3 --- /dev/null +++ b/website/content/terminal/quickstart/installation/macos.md @@ -0,0 +1,62 @@ +--- +title: MacOS +sidebar_position: 2 +description: Install the OpenBB Terminal on MacOS (Big Sur or later). There are two versions of the installers available for MacOS, Intel-based and Apple Silicon (M1). +keywords: + [ + installation, + installer, + install, + guide, + mac, + windows, + linux, + python, + github, + macos, + how to, + explanation, + openbb terminal, + ] +--- +import InstallerButton from "@site/src/components/General/InstallerButton"; + +Install the OpenBB Terminal on MacOS (Big Sur or later). There are two versions of the installers available for MacOS, Intel-based and Apple Silicon (M1). Apple Silicon users will need to install Rosetta prior to installation. + +To understand whether you are using an Apple Sillicon (M1) device or an Intel-based device click on the Apple Icon at the top left of your MacBook and select "About This Mac". Then under "Chip" if it says something like "Apple M1 Pro" or "Apple M1 Max", you know you have an Apple Silicon MacBook. If it says for example "2,3 GHz Quad-Core Intel Core i7" you know that you have an Intel-based MacBook and you can continue by clicking on the "Mac Intel Installer" button. + +
Rosetta Installation Instructions (Apple Sillicon users only) + +1. Press ⌘ (Command) + SPACE to open spotlight search, and type `Terminal` and hit Return (⏎). +2. Copy and paste the following code in the Terminal and hit ENTER (⏎): +```console +softwareupdate --install-rosetta +``` +3. This will start up the Rosetta installation process and you will receive a message regarding the Licence Agreement. Type `A` and hit Return (⏎). +4. After the installation process has finished, you can proceed to the "Mac M1 Installer" button. + +
+ +Once all of this is confirmed, you can use the following installation buttons. + +

+ +

+ +Step by step instructions: + +**Step 1:** Download the DMG file from the links above. + +**Step 2:** Mount the downloaded DMG file by double-clicking on it. + +**Step 3:** Click and drag the OpenBB Terminal folder and hold it over the Applications shortcut. This opens a new Finder window, then drag the OpenBB Terminal folder into the Applications folder. + +![MacOS Installation](https://user-images.githubusercontent.com/11668535/173027899-9b25ae4f-1eef-462c-9dc9-86086e9cf197.png) + +**Step 4:** Unmount the installer, by "Ejecting OpenBB Terminal" from, locations, in Finder. + +**Step 5:** Launch the application by double-clicking on the `OpenBB Terminal` application. + +**Note:** During the first launch, a warning message may appear. Click, "Open". + +

run_the_terminal

\ No newline at end of file diff --git a/website/content/terminal/quickstart/installation/source.md b/website/content/terminal/quickstart/installation/source.md new file mode 100644 index 000000000000..14b7f1466074 --- /dev/null +++ b/website/content/terminal/quickstart/installation/source.md @@ -0,0 +1,185 @@ +--- +title: Source +sidebar_position: 4 +description: This section guides you a long to install the OpenBB Terminal via Python. This installation type supports both Windows and Unix systems (Linux + MacOS). +keywords: + [ + installation, + installer, + install, + guide, + mac, + windows, + linux, + python, + github, + macos, + how to, + explanation, + openbb terminal, + ] +--- + +This section guides you a long to install the OpenBB Terminal via Python. This installation type supports both Windows and Unix systems (Linux + MacOS). Before starting the installation process, make sure you the following pieces of software are installed. + +
Miniconda +Miniconda is a Python environment and package manager. It is required for installing certain dependencies. + +Go [here](https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links) to find the download for your operating system or use the links below: + +- Apple-Silicon Systems: [Miniconda for MacOS](https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.pkg) +- Intel-based Mac Systems: [Miniconda for MacOS](https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh) +- Linux and WSL Systems: [Miniconda for Linux](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh) +- Raspberry PI Systems: [Miniconda for Raspberry PI](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-aarch64.sh) +- Windows Systems: [Miniconda for Windows](https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe) + + +**NOTE for Apple Silicon Users:** Install Rosetta from the command line: `softwareupdate --install-rosetta` + +**NOTE for Windows users:** Install/update Microsoft C++ Build Tools from [here](https://visualstudio.microsoft.com/visual-cpp-build-tools/). +
+ +
CMake (Mac and Linux only) +If you have a **MacBook**, check if homebrew is installed by running `brew --version` + +If Homebrew is not installed, run: + +```bash +/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" +brew install cmake +brew install gcc +``` + +If Homebrew is already installed: + +```bash +brew install cmake +brew install gcc +``` + +If you have a **Linux** computer, use the following script: + +```bash +sudo apt update && sudo apt upgrade +sudo apt install -y gcc cmake +``` +
+ +
VcXsrv (Windows and Linux only) +Since a WSL installation is headless by default (i.e., there is only access to a terminal running a Linux distribution) there are additional steps required to display visualizations. A more detailed tutorial is found, [here](https://medium.com/@shaoyenyu/make-matplotlib-works-correctly-with-x-server-in-wsl2-9d9928b4e36a). + +- Dynamically export the DISPLAY environment variable in WSL2: + +```console +# add to the end of ~/.bashrc file +export DISPLAY=$(cat /etc/resolv.conf | grep nameserver | awk '{print $2}'):0 +# source the file +source ~/.bashrc +``` + +- Download and install [VcXsrv](https://sourceforge.net/projects/vcxsrv/) +- When running the program is important to check "Disable access control" + +After this, `VcXsrv` should be running successfully, and the machine is ready to proceed with the terminal installation. + +Alternatives to `VcXsrv` include: + +- [GWSL](https://opticos.github.io/gwsl/) +- [Xming](https://xming.en.softonic.com/) +- [Wayland](https://wayland.freedesktop.org/docs/html/) + + +
+ +Once you have met all of these requirements, you are ready to install the OpenBB Terminal. + + +**Creating a virtual environment** + +When a terminal window is opened, if the base Conda environment - look for `(base)` to the left of the cursor on the command line - is not activated automatically, find the path for it by entering: + +```console +conda env list +``` + +Copy the path which corresponds with `base`, and activate it with: + +```console +conda activate REPLACE_WITH_PATH +``` + +Check which `conda` version is installed by entering: + +```console +conda -V +``` + +Create the environment by copying the code below into the command line: + +```console +conda create -n obb -c conda-forge python=3.10.9 pip pybind11 cmake git cvxpy lightgbm poetry +``` + +**Activate the obb environment** + +After the packages from the previous step are installled, activate the newly created environment by entering: + +```console +conda activate obb +``` + +**Install OpenBB Terminal** + +From your code editor or command line, browse to the location the OpenBB Terminal source code should live. Make sure you have completed the previous steps. + +This starts by cloning the GitHub repository. This will download the source code to the current working directory. + +```console +git clone https://github.com/OpenBB-finance/OpenBBTerminal.git +``` + +Then, navigate to this folder. This can be done in command line or through the code editor by opening the folder. + +```console +cd OpenBBTerminal +``` + +There are a few packages that required to be installed. This is done through Poetry, a package manager. + +```bash +pip install qdldl==0.1.5.post3 +poetry install -E all +``` + +Once this installation process is completed, you can start the terminal by running: + +```bash +python terminal.py +``` + +**NOTE:** When you are opening the OpenBB Terminal from a Terminal application, the Python environment will need to be activated again - `conda activate obb` - and the current working directory should be the `OpenBBTerminal` folder where the source code was cloned. When using a code editor, make sure that you have the correct environment selected. This should be easy to figure out if you get an error that you are missing packages. + +**TROUBLESHOOTING:** Having difficulty getting through the installation, or encountering errors? Check out the [troubleshooting page](/terminal/quickstart/troubleshooting), or reach out to our [Discord](https://discord.gg/Up2QGbMKHY) community for help. + +**Advanced: About Poetry** + +By default we advise using `conda` and `poetry` for environment setup and dependency management. Conda ships binaries for packages like `numpy` so these dependencies are not built from source locally by `pip`. Poetry solves the dependency tree in a way that the dependencies of dependencies of dependencies use versions that are compatible with each other. + +For `Conda` environments, the `build/conda` folder contains multiple `.yaml` configuration files to choose from. + +When using other python distributions we highly recommend a virtual environment like `virtualenv` or `pyenv` for installing the terminal dependency libraries. + +Requirements files that are found in the project root: + +- `requirements.txt` list all the dependencies without Machine Learning libraries +- `requirements-full.txt` list all the dependencies with Machine Learning libraries + +They can be installed with `pip`: + +```bash +pip install -r requirements.txt +``` + +The dependency tree is solved by poetry. + +Note: The libraries specified in the requirements files have been tested and work for the purpose of this project, however, these may be older versions. Hence, it is recommended for the user to set up a virtual python environment prior to installing these. This allows to keep dependencies required by different projects in separate places. \ No newline at end of file diff --git a/website/content/terminal/quickstart/installation/windows.md b/website/content/terminal/quickstart/installation/windows.md new file mode 100644 index 000000000000..b88d171bb65e --- /dev/null +++ b/website/content/terminal/quickstart/installation/windows.md @@ -0,0 +1,40 @@ +--- +title: Windows +sidebar_position: 1 +description: This section provides you with the installation file as well as the guide to install the OpenBB Terminal via Windows (10 or greater). +keywords: + [ + installation, + installer, + install, + guide, + mac, + windows, + linux, + python, + github, + macos, + how to, + explanation, + openbb terminal, + ] +--- +import InstallerButton from "@site/src/components/General/InstallerButton"; + +This section provides you with the installation file as well as the guide to install the OpenBB Terminal via Windows (10 or greater). + +**Step 1:** Download the file by clicking on the button. + +

+ +

+ +**Step 2:** Open the downloaded `exe` file by double-clicking on it. + +**Step 3:** Follow the prompts to complete the installation process + +**Step 4:** Double-click on the application that appeared on your Desktop, you are now able to run the OpenBB Terminal + +

run_the_terminal

+ +The first time this takes a bit longer to load, this can take up to a few minutes. \ No newline at end of file From 2f7f4c347c247f5f52929e61add096bd88bed5fb Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Mon, 6 Mar 2023 15:49:56 +0100 Subject: [PATCH 05/21] Update windows.md --- website/content/terminal/quickstart/installation/windows.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/content/terminal/quickstart/installation/windows.md b/website/content/terminal/quickstart/installation/windows.md index b88d171bb65e..927bf077c980 100644 --- a/website/content/terminal/quickstart/installation/windows.md +++ b/website/content/terminal/quickstart/installation/windows.md @@ -37,4 +37,6 @@ This section provides you with the installation file as well as the guide to ins

run_the_terminal

-The first time this takes a bit longer to load, this can take up to a few minutes. \ No newline at end of file +The first time this takes a bit longer to load, this can take up to a few minutes. If everything was successful you should see a screen like the one below: + +image From c8a9408a20de3c0c57287337a104957ece36d4b0 Mon Sep 17 00:00:00 2001 From: jeroen Date: Mon, 6 Mar 2023 15:59:09 +0100 Subject: [PATCH 06/21] Update installation docs --- website/content/terminal/quickstart/installation/docker.md | 6 +++--- .../quickstart/installation/{_index.md => installation.md} | 0 website/content/terminal/quickstart/installation/macos.md | 4 +++- website/content/terminal/quickstart/installation/source.md | 2 +- website/content/terminal/quickstart/installation/windows.md | 2 +- 5 files changed, 8 insertions(+), 6 deletions(-) rename website/content/terminal/quickstart/installation/{_index.md => installation.md} (100%) diff --git a/website/content/terminal/quickstart/installation/docker.md b/website/content/terminal/quickstart/installation/docker.md index 58e668e5e0f4..e766e325f685 100644 --- a/website/content/terminal/quickstart/installation/docker.md +++ b/website/content/terminal/quickstart/installation/docker.md @@ -26,7 +26,7 @@ Installing the OpenBB Terminal via Docker supports both Windows and Unix systems **Install Docker Desktop** -You can find `Docker Desktop` for MacOS here: [Download Docker Desktop](https://www.docker.com/products/docker-desktop) +You can find `Docker Desktop` for Windows here: [Download Docker Desktop](https://www.docker.com/products/docker-desktop) **Start Docker** @@ -87,7 +87,7 @@ This file contents the settings to pull and run OpenBB Terminal Docker image. **Install Docker Desktop** -You can find `Docker Desktop` for Linux here: [Download Docker Desktop](https://www.docker.com/products/docker-desktop) +You can find `Docker Desktop` for MacOS here: [Download Docker Desktop](https://www.docker.com/products/docker-desktop) **Start Docker** @@ -169,7 +169,7 @@ The `xhost +$IP` and `DISPLAY=$IP:0` parts are there to allow charts display. **Install Docker Desktop** -You can find `Docker Desktop` for Windows here: [Download Docker Desktop](https://www.docker.com/products/docker-desktop) +You can find `Docker Desktop` for Linux here: [Download Docker Desktop](https://www.docker.com/products/docker-desktop) **Start Docker** diff --git a/website/content/terminal/quickstart/installation/_index.md b/website/content/terminal/quickstart/installation/installation.md similarity index 100% rename from website/content/terminal/quickstart/installation/_index.md rename to website/content/terminal/quickstart/installation/installation.md diff --git a/website/content/terminal/quickstart/installation/macos.md b/website/content/terminal/quickstart/installation/macos.md index 51c79f37d5d3..62a16fca4545 100644 --- a/website/content/terminal/quickstart/installation/macos.md +++ b/website/content/terminal/quickstart/installation/macos.md @@ -55,7 +55,9 @@ Step by step instructions: **Step 4:** Unmount the installer, by "Ejecting OpenBB Terminal" from, locations, in Finder. -**Step 5:** Launch the application by double-clicking on the `OpenBB Terminal` application. +**Step 5:** Launch the application by double-clicking on the `OpenBB Terminal` application. If everything was successful you should see a screen like the one below: + +

run_the_terminal

**Note:** During the first launch, a warning message may appear. Click, "Open". diff --git a/website/content/terminal/quickstart/installation/source.md b/website/content/terminal/quickstart/installation/source.md index 14b7f1466074..7985dc65f14b 100644 --- a/website/content/terminal/quickstart/installation/source.md +++ b/website/content/terminal/quickstart/installation/source.md @@ -20,7 +20,7 @@ keywords: ] --- -This section guides you a long to install the OpenBB Terminal via Python. This installation type supports both Windows and Unix systems (Linux + MacOS). Before starting the installation process, make sure you the following pieces of software are installed. +This section guides you a long to install the OpenBB Terminal via Python. This installation type supports both Windows and Unix systems (Linux + MacOS). Before starting the installation process, make sure the following pieces of software are installed.
Miniconda Miniconda is a Python environment and package manager. It is required for installing certain dependencies. diff --git a/website/content/terminal/quickstart/installation/windows.md b/website/content/terminal/quickstart/installation/windows.md index 927bf077c980..b7f728f0be1a 100644 --- a/website/content/terminal/quickstart/installation/windows.md +++ b/website/content/terminal/quickstart/installation/windows.md @@ -39,4 +39,4 @@ This section provides you with the installation file as well as the guide to ins The first time this takes a bit longer to load, this can take up to a few minutes. If everything was successful you should see a screen like the one below: -image +

run_the_terminal

From 1fc633bf7ca6291fc36b6b345e3cc7cc8c92a192 Mon Sep 17 00:00:00 2001 From: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Date: Mon, 6 Mar 2023 13:56:57 +0000 Subject: [PATCH 07/21] fix country choices (#4403) --- openbb_terminal/helper_funcs.py | 5 +++++ .../mutual_funds/mutual_fund_controller.py | 20 +++++++++---------- 2 files changed, 14 insertions(+), 11 deletions(-) diff --git a/openbb_terminal/helper_funcs.py b/openbb_terminal/helper_funcs.py index c8ab2ccc3c13..9d7a0ae8be82 100644 --- a/openbb_terminal/helper_funcs.py +++ b/openbb_terminal/helper_funcs.py @@ -657,6 +657,11 @@ def valid_hour(hr: str) -> int: return new_hr +def lower_str(string: str) -> str: + """Convert string to lowercase.""" + return string.lower() + + def us_market_holidays(years) -> list: """Get US market holidays.""" if isinstance(years, int): diff --git a/openbb_terminal/mutual_funds/mutual_fund_controller.py b/openbb_terminal/mutual_funds/mutual_fund_controller.py index 8d4fca6bd984..e6ca90744a59 100644 --- a/openbb_terminal/mutual_funds/mutual_fund_controller.py +++ b/openbb_terminal/mutual_funds/mutual_fund_controller.py @@ -15,6 +15,7 @@ from openbb_terminal.helper_funcs import ( EXPORT_ONLY_FIGURES_ALLOWED, check_positive, + lower_str, valid_date, ) from openbb_terminal.menu import session @@ -79,7 +80,7 @@ def print_help(self): mt = MenuText("funds/") mt.add_cmd("country") mt.add_raw("\n") - mt.add_param("_country", self.country.title()) + mt.add_param("_country", self.country) mt.add_raw("\n") mt.add_cmd("search") mt.add_cmd("load") @@ -181,29 +182,26 @@ def call_country(self, other_args: List[str]): add_help=False, formatter_class=argparse.ArgumentDefaultsHelpFormatter, prog="country", - description="Set a country for funds", + description="Set a country for funds.", ) parser.add_argument( "-n", "--name", - type=str, + type=lower_str, choices=self.fund_countries, dest="name", help="country to select", - default="", + default="united_states", + metavar="NAME", ) if other_args and "-" not in other_args[0][0]: other_args.insert(0, "-n") ns_parser = self.parse_known_args_and_warn(parser, other_args) if ns_parser: - country_candidate = ns_parser.name - if country_candidate.lower() in self.fund_countries: + country_candidate = ns_parser.name.lower() + if country_candidate in self.fund_countries: self.country = country_candidate - console.print(f"{country_candidate.title()} selected.") - else: - console.print( - f'" {country_candidate.title()} " not a valid country to select.' - ) + console.print(f"'{country_candidate}' selected.") return self.queue From 45e4f8ba0995bc891ae29ba0cd18697f0d12a0be Mon Sep 17 00:00:00 2001 From: teh_coderer Date: Mon, 6 Mar 2023 08:30:41 -0600 Subject: [PATCH 08/21] Hotfix/plotsbackend start (#4404) * readd removed plots_backend().start() from merged PR * Update backend.py --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> --- openbb_terminal/config_terminal.py | 8 ++++++-- openbb_terminal/core/models/preferences_model.py | 2 ++ openbb_terminal/core/plots/backend.py | 2 +- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/openbb_terminal/config_terminal.py b/openbb_terminal/config_terminal.py index 859c02db4ea4..44d7a66830ca 100644 --- a/openbb_terminal/config_terminal.py +++ b/openbb_terminal/config_terminal.py @@ -5,11 +5,12 @@ import i18n # IMPORTATION INTERNAL -from openbb_terminal.core.config.paths import MISCELLANEOUS_DIRECTORY from openbb_terminal.base_helpers import load_env_vars, strtobool +from openbb_terminal.core.config.paths import MISCELLANEOUS_DIRECTORY +from openbb_terminal.core.plots.backend import plots_backend from openbb_terminal.core.session.current_user import get_current_user -from .helper_classes import TerminalStyle as _TerminalStyle +from .helper_classes import TerminalStyle as _TerminalStyle # # Terminal UX section current_user = get_current_user() @@ -19,6 +20,9 @@ current_user.preferences.RICH_STYLE, ) +# Start Backend for plotting +plots_backend().start(load_env_vars("DEBUG_MODE", strtobool, False)) + # Logging section # USE IN LOG LINES + FOR FOLDER NAME INSIDE S3 BUCKET diff --git a/openbb_terminal/core/models/preferences_model.py b/openbb_terminal/core/models/preferences_model.py index 8196ca550048..5c2e381771fe 100644 --- a/openbb_terminal/core/models/preferences_model.py +++ b/openbb_terminal/core/models/preferences_model.py @@ -30,6 +30,8 @@ class PreferencesModel: PLOT_WIDTH: PositiveInt = 800 PLOT_HEIGHT_PERCENTAGE: PositiveFloat = 50.0 PLOT_WIDTH_PERCENTAGE: PositiveFloat = 70.0 + # Whether to open plot image exports after they are created + PLOT_OPEN_EXPORT: bool = False # FEATURE FLAGS SYNC_ENABLED: bool = True diff --git a/openbb_terminal/core/plots/backend.py b/openbb_terminal/core/plots/backend.py index b10b48c15b90..12ea12532917 100644 --- a/openbb_terminal/core/plots/backend.py +++ b/openbb_terminal/core/plots/backend.py @@ -179,7 +179,7 @@ async def process_image(self, export_image: Path): img_path.unlink(missing_ok=True) renderPDF.drawToFile(drawing, str(export_image)) - if strtobool(os.environ.get("OPENBB_PLOT_OPEN_EXPORT", False)): + if get_current_user().preferences.PLOT_OPEN_EXPORT: if sys.platform == "win32": os.startfile(export_image) # nosec: B606 else: From 1d22396ac09d82651bfaa951bb68d87c9bc39142 Mon Sep 17 00:00:00 2001 From: Colin Delahunty <72827203+colin99d@users.noreply.github.com> Date: Mon, 6 Mar 2023 11:05:10 -0500 Subject: [PATCH 09/21] Update helper_classes.py (#4378) Co-authored-by: James Maslek --- openbb_terminal/helper_classes.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openbb_terminal/helper_classes.py b/openbb_terminal/helper_classes.py index 90bf2ba730a1..ada9841ff8c9 100644 --- a/openbb_terminal/helper_classes.py +++ b/openbb_terminal/helper_classes.py @@ -123,7 +123,7 @@ def __init__( if mpl_style in self.mpl_styles_available: self.mpl_style = self.mpl_styles_available[mpl_style] else: - self.mpl_style = self.mpl_styles_available["dark"] + self.mpl_style = self.mpl_styles_available.get("dark", "") if mpl_style in self.mpl_rcparams_available: with open(self.mpl_rcparams_available[mpl_style]) as stylesheet: From e83648f8d1e63f29cc4cdb63fd4f185e8d0b8eec Mon Sep 17 00:00:00 2001 From: jeroen Date: Mon, 6 Mar 2023 20:43:51 +0100 Subject: [PATCH 10/21] Add improvements to the website --- .../content/terminal/guides/advanced/data.md | 119 ++++----- .../guides/advanced/scripts-and-routines.md | 127 +++++----- .../content/terminal/guides/basics/index.md | 14 +- .../guides/intros/stocks/dark-pool-shorts.md | 2 +- .../guides/intros/stocks/options/index.md | 2 +- .../content/terminal/quickstart/api-keys.md | 229 ++++++++++-------- .../terminal/quickstart/installation/macos.md | 7 +- .../quickstart/installation/source.md | 16 +- .../quickstart/installation/windows.md | 2 +- 9 files changed, 269 insertions(+), 249 deletions(-) diff --git a/website/content/terminal/guides/advanced/data.md b/website/content/terminal/guides/advanced/data.md index de944be91705..6006d2295df7 100644 --- a/website/content/terminal/guides/advanced/data.md +++ b/website/content/terminal/guides/advanced/data.md @@ -6,122 +6,93 @@ keywords: [export, import, data, excel, xlsx, csv, json, png, pdf, jpg, openbbus --- ## The OpenBBUserData Folder -The `OpenBBUserData` folder is where files are saved when they are created from within the OpenBB Terminal, like exports and generated reports. It is also where user-generated files are stored, such as: +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//OpenBBUserData` +- Windows: `C:/Users//OpenBBUserData` -- Screener presets -- Portfolio files -- Exported files -- Files to be imported by various functions -- Styles and themes +Within the folder you can find files that you have exported as well as files that you wish to import directly into the OpenBB Terminal. For example, this could be an orderbook which you can store in `OpenBBUserData/portfolio/holdings`. -The folder's location is at the root of user account for the operating system. +![OpenBBUserData Folder](https://user-images.githubusercontent.com/85772166/195742985-19f0e420-d8f7-4fea-a145-a0243b8f2ddc.png) -- Linux: `~/home//OpenBBUserData` -- macOS: `Macintosh HD/Users//OpenBBUserData` -- Windows: `C:\Users\\OpenBBUserData` +This folder contains all things user-created. For example: + + - Screener presets + - Portfolio files + - Exported files + - Files to be imported by various functions + - Styles and themes + - Preferred data sources **Note:** With a WSL-enabled Windows installation, this folder will be under the Linux partition ## Exporting Files -Most Terminal functions have the ability to export results as a file to the `OpenBBUserData` folder. This can be confirmed by engaging the help dialogue. +Within many of the functionalities, we offer the capability to export to Excel (xlsx and csv) or JSON. This can be demonstrated with the `--export` argument, e.g. if you wish to export to `xlsx` you would add `--export xlsx`. -```console -/economy/fred --help -``` +For example, if you wish to download market data you can do so from the stocks menu with the following: ```console -usage: fred [-p PARAMETER] [-s START_DATE] [-e END_DATE] [-q QUERY [QUERY ...]] [-h] [--export EXPORT] [--sheet-name SHEET_NAME [SHEET_NAME ...]] [--raw] [-l LIMIT] - -Query the FRED database and plot data based on the Series ID. [Source: FRED] - -options: - -p PARAMETER, --parameter PARAMETER - Series ID of the Macro Economic data from FRED (default: ) - -s START_DATE, --start START_DATE - Starting date (YYYY-MM-DD) of data (default: None) - -e END_DATE, --end END_DATE - Ending date (YYYY-MM-DD) of data (default: None) - -q QUERY [QUERY ...], --query QUERY [QUERY ...] - Query the FRED database to obtain Series IDs given the query search term. (default: None) - -h, --help show this help message (default: False) - --export EXPORT Export raw data into csv, json, xlsx and figure into png, jpg, pdf, svg (default: ) - --sheet-name SHEET_NAME [SHEET_NAME ...] - Name of excel sheet to save data to. Only valid for .xlsx files. (default: None) - --raw Flag to display raw data (default: False) - -l LIMIT, --limit LIMIT - Number of entries to show in data. (default: 100) - -For more information and examples, use 'about fred' to access the related guide. - - +/stocks/load AAPL -s 2010-01-01 --export xlsx ``` -For exporting data from tables, the valid output types are: - -- CSV -- JSON -- XLSX +This results in the following: -Images can be exported as: +![Export Example](https://user-images.githubusercontent.com/46355364/214817681-fd5324c3-003c-45eb-adf4-96d5b41a3c02.png) -- JPG -- PDF -- PNG -- SVG - -Deploying the `--export` flag can include just the file type: +We also allow you to define a file name, for example for the same stock tickers, we can also add in the filename. This time, we export to `csv`. ```console -/stocks/ $ load aapl --export csv +/stocks/load AAPL -s 2010-01-01 --export apple.csv ``` -```console -Loading Daily data for AAPL with starting period 2020-02-13. -Saved file: /Users/danglewood/OpenBBUserData/exports/20230217_204550_OpenBBTerminal_openbb_terminal_load_AAPL.csv -``` +Which results in the following: -Or, the file can be named explicitly: +![Filename Example](https://user-images.githubusercontent.com/46355364/214818131-597b3bd0-9c66-43f1-bf0e-2c0a703e2645.png) -```console -/stocks/ $ load aapl --export aapl_daily.csv -``` +Lastly, when you select the `xlsx` option, you can also specify the sheet name with `--sheet-name` which allows multiple datasets to be send to the same Excel file. Using the same stock ticker, we can define the following. First, get market data from the `stocks` menu: ```console -Loading Daily data for AAPL with starting period 2020-02-13. -Saved file: /Users/danglewood/OpenBBUserData/exports/aapl_daily.csv +/stocks/load AAPL -s 2010-01-01 --export apple.xlsx --sheet-name Market Data ``` -When `xlsx` is the file type, an additional argument for the sheet name is available. The purpose of this functionality is to export multiple items to the same spreadsheet; for example: +Then enter the `fa` (Fundamental Analysis) menu and type: -```console -/stocks/load aapl --export watchlist.xlsx --sheet-name AAPL -``` +:::note +This requires an API key from FinancialModelingPrep. Please have a look [here](https://docs.openbb.co/terminal/quickstart/api-keys). +::: + +**Income Statement:** ```console -Loading Daily data for AAPL with starting period 2020-02-13. -Saved file: /Users/danglewood/OpenBBUserData/exports/watchlist.xlsx +income --source FinancialModelingPrep -l 10 --export apple.xlsx --sheet-name Income Statement ``` +**Balance Sheet:** ```console -/stocks/load msft --export watchlist.xlsx --sheet-name MSFT +balance --source FinancialModelingPrep -l 10 --export apple.xlsx --sheet-name Balance Sheet ``` +**Cash Flow Statement:** + ```console -Loading Daily data for MSFT with starting period 2020-02-13. -Saved file: /Users/danglewood/OpenBBUserData/exports/watchlist.xlsx +cash --source FinancialModelingPrep -l 10 --export apple.xlsx --sheet-name Cash Flow Statement ``` -![Exporting Data](https://user-images.githubusercontent.com/85772166/221929090-5477a635-fccc-42a1-9ee3-7e7485988452.png) +This generates a file for Apple with market data from 2010-01-01 until now and income, balance and cash flow statements over the last 10 years as seen in the image below. + +![Sheet Name Example](https://user-images.githubusercontent.com/46355364/214824561-6eaf3a88-746a-4abc-91e1-420c9036c00d.png) + +Next to that, we also allow exporting to images, this can be PNG, JPG, PDF and SVG. For example, using our `portfolio` menu we can export the charts to any type of format which again can be found within the `OpenBBUserData` folder. +![image](https://user-images.githubusercontent.com/46355364/214819518-cec40468-9019-440c-8bfe-7bcabc207578.png) ## Importing Data -Menus, such as Econometrics, Forecast, or Portfolio, allow the user to import their own dataset. Files available to import will be included with the choices presented by auto-complete. In the Econometrics menu, this is activated after pressing the space bar, `load -f`. +Menus, such as [Econometrics](https://docs.openbb.co/terminal/guides/intros/econometrics) or [Portfolio](https://docs.openbb.co/terminal/guides/intros/portfolio), allow the user to import their own dataset. Files available to import will be included with the selections made available by auto-complete. In the Econometrics menu, this is activated after pressing the space bar, `load -f ` -![Loading data in the Econometrics menu](https://user-images.githubusercontent.com/85772166/221930794-d754e63f-262f-410b-b698-e03823c5d30b.png) +![Importing Data](https://user-images.githubusercontent.com/85772166/204921760-38742f6c-ec78-4009-9c23-54dcb0504524.png) -The Econometrics menu looks at the `exports` and `custom_imports/econometrics` folder. The `portfolio` menu looks in the `portfolio/holdings` folder whereas the `portfolio/po` menu looks at the `portfolio/allocation` and `portfolio/optimization` folder for the load and file command respectively. Please make sure to read the relevant guides to understand how this works. +The Econometrics menu looks into the `exports` and `custom_imports/econometrics` folder. For the Portfolio functionalities the `portfolio` menu looks into the `portfolio/holdings` folder whereas the `portfolio/po` menu looks into the `portfolio/allocation` and `portfolio/optimization` folder for the `load` and `file` command respectively. Please make sure to read the relevant guides to understand how this works. ## Custom Path for OpenBBUserData folder diff --git a/website/content/terminal/guides/advanced/scripts-and-routines.md b/website/content/terminal/guides/advanced/scripts-and-routines.md index 05ba04dcfcd5..409e61565207 100644 --- a/website/content/terminal/guides/advanced/scripts-and-routines.md +++ b/website/content/terminal/guides/advanced/scripts-and-routines.md @@ -4,9 +4,7 @@ title: Scripts & Routines description: OpenBB Routine files, `.openbb`, are simple scripts for automating processes and repetitive tasks. They represent a 1:1 relationship with any command in the OpenBB Terminal; one line represents one function. A routine file can be created or modified in any basic text editor, the only difference between a plain-text file and an OpenBB Routine file is the `.openbb` file extension. Additionally, routine files can be captured with the macro recorder, controlled with global commands, `record` & `stop`. Upon `stop`, the script is automatically saved to the, `~/OpenBBUserData/routines/`, folder. Routine files stored there are callable from the main menu, using the `exe` function. By deploying variable arguments - `$ARGV[0]` - to any line in the script, dates, symbols, exported filenames, or any Terminal function argument, scripts become dynamic. keywords: [scripts, routines, .do file, stata, spss, r studio, python, automation, data collection, aggregation, script, routine, openbb terminal] --- -## OpenBB Routine Files - -OpenBB Routine files, `.openbb`, are simple scripts for automating processes and repetitive tasks. They represent a 1:1 relationship with any command in the OpenBB Terminal; one line represents one function. A routine file can be created or modified in any basic text editor, the only difference between a plain-text file and an OpenBB Routine file is the `.openbb` file extension. Additionally, routine files can be captured with the macro recorder, controlled with global commands, `record` & `stop`. Upon `stop`, the script is automatically saved to the, `~/OpenBBUserData/routines/`, folder. Routine files stored there are callable from the main menu, using the `exe` function. By deploying variable arguments - `$ARGV[0]` - to any line in the script, dates, symbols, exported filenames, or any Terminal function argument, scripts become dynamic. +OpenBB Routine Scripts, `.openbb`, are simple scripts for automating processes and repetitive tasks. They represent a 1:1 relationship with any command in the OpenBB Terminal; one line represents one function. A routine file can be created or modified in any basic text editor, the only difference between a plain-text file and an OpenBB Routine file is the `.openbb` file extension. Additionally, routine files can be captured with the macro recorder, controlled with global commands, `record` & `stop`. Upon `stop`, the script is automatically saved to the, `~/OpenBBUserData/routines/`, folder. Routine files stored there are callable from the main menu, using the `exe` function. By deploying variable arguments - `$ARGV[0]` - to any line in the script, dates, symbols, exported filenames, or any Terminal function argument, scripts become dynamic. Run a routine file from the main menu, with the `exe` command. Below, the `--help` dialogue is displayed. @@ -23,97 +21,118 @@ options: -h, --help show this help message (default: False) ``` +Other software like STATA, SPSS and R-Studio share similar functionality in the area of Econometrics and the OpenBB routine scripts venture into the area of financial analysis and data collection to speed up the process. For example, not only is it possible to automate a set of functionality, it is also possible to export a large amount of data to Excel through the usage of `--export` and `--sheet-name` making data collection efficient, reproducible and customizable. + ## The Macro Recorder -With the macro recorder, it is easy to get started; just enter `record`. To follow along, copy the block below into the Terminal at the main menu. +As a starting point, you can use the `record` and `stop` functionalitsy. This shares similarities with that of Excel's VBA methods. This means that any command you run will be automatically recorded for the routine script and once you type `stop` it automatically saves the file. For example, if you cope the following code in the OpenBB Terminal and run it, you will see an example. ```console -record/stocks/load qqq/forecast/expo QQQ/autoselect QQQ/stop +record/economy/cpi/treasury/index sp500/stop ``` -![Routines](https://user-images.githubusercontent.com/85772166/219550644-26ecaf27-cbf9-4314-8f3b-d9f20e8fcb88.png) - -![Routines](https://user-images.githubusercontent.com/85772166/219550698-3b1cd675-4e1f-4d3e-a630-9ed00b689b2b.png) +The following shows the script being ran and the charts that are created because of it. -The routine has been successfully captured, and the next time the Terminal is opened, this routine will be visible when calling the `exe` function. +![Routines](https://user-images.githubusercontent.com/46355364/223204998-70d9e5da-f84e-4c22-90c4-576dcf87c1df.png) -![Routines](https://user-images.githubusercontent.com/85772166/221951059-3ccf7235-5b0e-48ba-9f6c-3d0aaadd20cf.png) +After the script is finished, you are able to access the routine file when using `exe --file`. The naming of the file can differ for you based on the time you are executing the script. You can find this script inside the `routines` folder within the `OpenBBUserData` folder (as found [here](https://docs.openbb.co/terminal/guides/advanced/data)) -## Editing & Inserting Arguments +![Routines](https://user-images.githubusercontent.com/46355364/223205394-77e7a33d-e9fa-4686-b32f-e8d183b265e6.png) -Let's take a look at the routine file that was just generated. This is what was captured, the recorder interpreted each `/` as a new command: +## Create your own script -```console -stocks +As mentioned earlier, the scripts and routines reside in the `routines` folder within the `OpenBBUserData` folder (as found [here](https://docs.openbb.co/terminal/guides/advanced/data)) and are automatically shown when you type `exe` from the home screen (`home`). -load qqq +:::note To manually create your own .openbb script use the following: +1. Download the file that can be used as a template **[here](https://www.dropbox.com/s/73g9qx9xgtbb2ec/routines_template.openbb?dl=1)**. +2. Move the file inside the `routines` folder within the [OpenBBUserData](https://docs.openbb.co/terminal/guides/advanced/data) folder and, optionally, adjust the name to your liking. +3. Open the file with a Text Editor (e.g. Notepad or TextEdit) and adjust the file accordingly. +4. Open up the OpenBB Terminal, and type `exe --file`. The file should then be one of the options. +5. Select the file to run the routine script. +::: -forecast +As long as the file remains in the `routines` folder, you will be able to find your file automatically as shown below. Note that this also shows the script that was created within [The Macro Recorder](#the-macro-recorder) section. -expo QQQ +![Script Showcase](https://user-images.githubusercontent.com/46355364/223206633-abebdee3-9221-49b1-a55e-5221572e9781.png) -autoselect QQQ -``` +## Explanation of scripts -A routine file that is locked to any single symbol will likely be less desirable than one which can be applied to any ticker. OpenBB routine files overcome this obstacle by allowing for an unlimited number of variable arguments - `$ARGV[0]` - to be assigned anywhere in the script. Let's go ahead and edit our Routine file to accommodate any symbol. +The script file follows the following logic: -```console -stocks +- **Comments**: any text after a hashtag (`#`) is referred to as a comment. This is used to explain what is happening within the script and is not taking into account when running terminal commands. +- **Commands**: any text *without* a hashtag is being ran inside the OpenBB Terminal. E.g. on the second line it says `stocks` thus within the OpenBB Terminal the script will enter `stocks` and run this for you. -load $ARGV[0] +These scripts have a 1-to-1 relationship with how you would normally use the terminal. To get a better understanding of how the terminal is used, please see Structure of the OpenBB Terminal. The example below can be executed by running `exe --example`. -forecast +``` +# Go into the stocks context +stocks -expo $ARGV[0] +# Load a company ticker, e.g. Apple +load AAPL -autoselect $ARGV[0] -``` +# Show a candle chart with a 20 day Moving Average +candle --ma 20 -Open the file with a text editor, make the changes, save the file, and then run the `exe` command again; except now, add the `--input` argument with a new ticker. For demonstration purposes, the routine file used in the example has been renamed to be `demo_routine.openbb`. Because the file name was changed, the Terminal will need to be restarted for the new name to be recognized. In subsequent edits, this will not be necessary because the file is read from start-to-finish with every execution. +# Switch over to the Fundamental Analysis menu +fa -```console -exe demo_routine.openbb --input SPY -``` +# Show Earnings per Share (EPS) estimates +epsfc -![Routines](https://user-images.githubusercontent.com/85772166/219550837-fe6ece69-2336-40fc-8db9-fc7b62b784c6.png) +# Show price targets charts +pt -Additional variables can be assigned to perform other functions, a date for example. Let's modify the routine file to include a start date as part of the `load` function. For those following along at home, modify the second command in the script to be: +# Show future estimations +est -```console -load $ARGV[0] --start $ARGV[1] +# Return to home +home ``` -The additional argument is added to the previous `exe` syntax as a comma-separated list. +## Executing a script -```console -exe demo_routine.openbb --input SPY,2022-01-01 -``` +By going to the main menu as depicted below (accessible with `home`), the `exe` command can be used. With this command you can run any `.openbb` script. These scripts are located where the application is located inside the `routines` folder as found in the `OpenBBUserData` folder. -![Routines](https://user-images.githubusercontent.com/85772166/219550901-13205851-a12f-4ef9-85f4-a2bfa24be9c9.png) +Thus, using the earlier mentioned script, we can enter `exe --file routines_template.openbb` which automatically runs all commands within the script file. Thus, it will return a candle chart with a moving average of 20 days, expectations and price targets from analysts and estimated future performance before returning to the home window. -This process is limited only to the imagination. Large, reptitive, tasks can be automated by extrapolating on the process above. +![OpenBB Routine Script Execution](https://user-images.githubusercontent.com/46355364/223207167-dfab3a74-d34d-47d4-bf6e-44944e8fbfa2.png) -## Commenting +## Custom arguments -Commenting within an OpenBB routine file is how the author of a script can communicate to the end-user. Commented lines - beginning with, "#" - are passed over during execution of the routine. Let's update the example routine file with a few comments to illustrate. +Next to that, it is also possible to add in custom arguments to your script making the script more interactive and allow you to do the same analysis for multiple companies. This is done in the following script (and can be downloaded [here](https://www.dropbox.com/s/usooz6y29r1xldb/routines_template_with_inputs.openbb?dl=1)): -```console -# This routine is a demonstration of the OpenBB routine files. -# Read the docs here: https://docs.openbb.co/terminal/guides/advanced/scripts-and-routines +``` +# This script requires you to use arguments. This can be done with the following: +# exe --file routines_template_with_inputs.openbb -i TSLA,AAPL,MSFT -# Start of routine +# Go to the stocks menu stocks -load $ARGV[0] --start $ARGV[1] +# Load a ticker, given the argument used. E.g. -i TSLA +load $ARGV[0] + +# Enter the Technical Analysis (ta) menu +ta -forecast +# Show the fibonacci retracement levels +fib -expo $ARGV[0] +# Enter the comparison analysis (ca) menu +../ca -autoselect $ARGV[0] +# Set two extra tickers based on the arguments used. E.g. -i TSLA,AAPL,MSFT +add $ARGV[1],$ARGV[2] -# End of routine -# Please note that the outputs of this routine will be different than the depictions above, because, you are now in the future. +# Plot the historical prices +historical + +# Return to home +home ``` -For convenience, the routine file constructed in the example above can be downloaded directly [here](https://github.com/OpenBB-finance/OpenBBTerminal/files/10763257/demo_routine.openbb.zip). +This script includes `$ARGV[0]`, `$ARGV[1]` and `$ARGV[2]`. This means that the script requires you to submit three arguments. In this case, they refer to stock tickers. Therefore, like the script also says, you can include these arguments with `-i` followed by three tickers (e.g. `routines_template_with_inputs.openbb`). This results in the following: + +![OpenBB Script with Input](https://user-images.githubusercontent.com/46355364/223207706-42995834-577f-4747-8185-42a016f441d9.png) + +It is a simple script but it gives an understanding what the possibilities are. Do make sure you saved this script in the `routines` folder else you are not able to execute it. \ No newline at end of file diff --git a/website/content/terminal/guides/basics/index.md b/website/content/terminal/guides/basics/index.md index 848c1fc79e83..df9cd7ef0ce7 100644 --- a/website/content/terminal/guides/basics/index.md +++ b/website/content/terminal/guides/basics/index.md @@ -8,7 +8,7 @@ The OpenBB Terminal is based off the +image The OpenBB Terminal is centered around keyboard input. To navigate and perform analysis you will have to type in the name of the command followed by an `ENTER` (⏎). If you wish to see information about the OpenBB Terminal you can do so by typing `about` and then press `ENTER` (⏎). As you are typing, you will notice that you receive suggestions, by using the `DOWN` (⌄) arrow and pressing `ENTER` (⏎) you can select the command and execute it. @@ -108,7 +108,7 @@ We can check that this period has changed by looking into the Explanation of Menus, some information also transfers over to other menus and this includes the loaded market data from load. So, if you would visit the `ta` menu (which stands for Technical Analysis) you will see that, by running any command, the selected period above is depicted again. Return to the Stocks menu again by using `q` and use it again to return to the home screen which can be shown with `?`. @@ -116,7 +116,7 @@ As mentioned in the Explanation of Menus, so The OpenBB Terminal is built on a lot of different data sources. The example above collects data from Yahoo Finance. This could be undesirable and therefore we allow for a variety of different data sources. Think of Polygon, IEX Cloud, Alpha Vantage and Binance to name a few. Some of these sources require you to set an API Key to connect with their data. :::note Setting API Keys -For an elaborate explanation of defining API keys to greatly extend the capabilities of the OpenBB Terminal, please have a look [**here**](/terminal/guides/advanced/api-keys). +For an elaborate explanation of defining API keys to greatly extend the capabilities of the OpenBB Terminal, please have a look [**here**](/terminal/guides/basics/api-keys). ::: This becomes apparent when you receive a message like the following: @@ -129,7 +129,7 @@ API_FINNHUB_KEY not defined. Set API Keys in ~/.openbb_terminal/.env or under ke We ensure that any source has a (usually extensive) free tier before we include the source. For example, you will be able to obtain 30+ years of fundamental data and query extensive economic databases by collecting just a few of the API keys. -The [keys menu](/terminal/guides/advanced/api-keys) serves the purpose of providing you to set API keys so that this type of functionality becomes available. For example, in the case of `rot` you will see that the source is "FinnHub". +The [keys menu](/terminal/guides/basics/api-keys) serves the purpose of providing you to set API keys so that this type of functionality becomes available. For example, in the case of `rot` you will see that the source is "FinnHub". ``` (🦋) /stocks/fa/ $ ? @@ -152,7 +152,7 @@ The [keys menu](/terminal/guides/advanced/api-keys) serves the purpose of provid │ sust sustainability values (environment, social and governance) [YahooFinance] ``` -Therefore, you need to acquire an API key from FinnHub through the website and enter the key within the [keys menu](/terminal/guides/advanced/api-keys). +Therefore, you need to acquire an API key from FinnHub through the website and enter the key within the [keys menu](/terminal/basics/api-keys). ### Importing and exporting data @@ -190,6 +190,10 @@ Lastly, when you select the `xlsx` option, you can also specify the sheet name w Then enter the `fa` (Fundamental Analysis) menu and type: +:::note +This requires an API key from FinancialModelingPrep. Please have a look [here](https://docs.openbb.co/terminal/quickstart/api-keys). +::: + **Income Statement:** ```console diff --git a/website/content/terminal/guides/intros/stocks/dark-pool-shorts.md b/website/content/terminal/guides/intros/stocks/dark-pool-shorts.md index 35b9e3b5bead..c0c2fad08974 100644 --- a/website/content/terminal/guides/intros/stocks/dark-pool-shorts.md +++ b/website/content/terminal/guides/intros/stocks/dark-pool-shorts.md @@ -8,7 +8,7 @@ The purpose of this menu is to provide the user with tools for gauging the level image -To use every feature in the Dark Pools menu, an API key for Quandl must be obtained (for free) and authorized on the local installation. See the Setting API Keys Guide for help setting up the API keys in the OpenBB Terminal. The four commands at the bottom of the menu rely on a loaded ticker while the six above do not. +To use every feature in the Dark Pools menu, an API key for Quandl must be obtained (for free) and authorized on the local installation. See the Setting API Keys Guide for help setting up the API keys in the OpenBB Terminal. The four commands at the bottom of the menu rely on a loaded ticker while the six above do not. ### How to use diff --git a/website/content/terminal/guides/intros/stocks/options/index.md b/website/content/terminal/guides/intros/stocks/options/index.md index c7b2726a2f0a..23c37c72a904 100644 --- a/website/content/terminal/guides/intros/stocks/options/index.md +++ b/website/content/terminal/guides/intros/stocks/options/index.md @@ -11,7 +11,7 @@ Navigate to the menu by typing `options`, from the `Stocks` menu, and then press image -By default, the Terminal loads a ticker using Tradier as the source. Sign up for a free developer account and then enter that token using the `Keys menu`. Alternatively, there is a choice to use yFinance data sets by attaching the argument as shown below. Help dialogues are displayed for any command by adding `-h` to the string. It is worth noting that this load command is different than the load command elsewhere. +By default, the Terminal loads a ticker using Tradier as the source. Sign up for a free developer account and then enter that token using the `Keys menu`. Alternatively, there is a choice to use yFinance data sets by attaching the argument as shown below. Help dialogues are displayed for any command by adding `-h` to the string. It is worth noting that this load command is different than the load command elsewhere. ```` (🦋) /stocks/options/ $ load -h diff --git a/website/content/terminal/quickstart/api-keys.md b/website/content/terminal/quickstart/api-keys.md index 6bab5b3bd09f..63914277aa8e 100644 --- a/website/content/terminal/quickstart/api-keys.md +++ b/website/content/terminal/quickstart/api-keys.md @@ -49,59 +49,18 @@ mykeys --show **We recommend gradually obtaining keys, when the use of a specific function requires it.** -## Summary List - -
-Click to expand the list of data providers - -| Command | Name | URL | -| :------------ | :--------------------------------------- | :--------------------------------------------------------------------------------- | -| av | AlphaVantage | https://www.alphavantage.co/support/#api-key | -| binance | Binance | https://binance.com | -| bitquery | Bitquery | https://bitquery.io/ | -| cmc | CoinMarketCap | https://coinmarketcap.com/api/ | -| coinbase | Coinbase | https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key | -| coinglass | Coinglass | https://coinglass.github.io/API-Reference/#api-key | -| cpanic | Crypto Panic | https://cryptopanic.com/developers/api/ | -| databento | Databento | https://docs.databento.com/getting-started | -| degiro | DeGiro | https://www.degiro.com/ | -| eodhd | EODHD | https://eodhistoricaldata.com/r/?ref=869U7F4J | -| ethplorer | Ethplorer | https://github.com/EverexIO/Ethplorer/wiki/Ethplorer-API | -| finnhub | Finnhub | https://finnhub.io/ | -| fmp | Financial Modelling Prep | https://site.financialmodelingprep.com/developer/docs/ | -| fred | Federal Reserve Economic Database (FRED) | https://fred.stlouisfed.org | -| github | GitHub | https://docs.github.com/en/rest/guides/getting-started-with-the-rest-api | -| glassnode | Glassnode | https://docs.glassnode.com/basic-api/api-key#how-to-get-an-api-key/ | -| iex | IEX Cloud | https://iexcloud.io/ | -| intrinio | Intrinio | https://intrinio.com/ | -| messari | Messari | https://messari.io/api/docs | -| news | News API | https://newsapi.org/ | -| oanda | Oanda | https://developer.oanda.com | -| polygon | Polygon | https://polygon.io | -| quandl | Quandl | https://www.quandl.com | -| reddit | Reddit | https://www.reddit.com/wiki/api | -| rh | Robinhood | https://robinhood.com/us/en/ | -| santiment | Santiment | https://app.santiment.net/ | -| shroom | ShroomDK | https://sdk.flipsidecrypto.xyz/shroomdk | -| smartstake | Smartstake | https://www.smartstake.io | -| stocksera | Stocksera | https://stocksera.pythonanywhere.com/ | -| tokenterminal | Token Terminal | https://tokenterminal.com/ | -| tradier | Tradier | https://documentation.tradier.com/ | -| twitter | Twitter | https://developer.twitter.com | -| walert | Whale Alert | https://docs.whale-alert.io/ | - -
- ## Instructions by Source This section covers all API keys listed above and include detailed instructions how to obtain each API key. By clicking on each name, the section will expand and instructions are provided. ### AlphaVantage +> Alpha Vantage provides enterprise-grade financial market data through a set of powerful and developer-friendly data APIs and spreadsheets. From traditional asset classes (e.g., stocks, ETFs, mutual funds) to economic indicators, from foreign exchange rates to commodities, from fundamental data to technical indicators, Alpha Vantage is your one-stop-shop for real-time and historical global market data delivered through cloud-based APIs, Excel, and Google Sheets. +
-Go to: https://www.alphavantage.co/support/#api-key +Instructions -[AlphaVantage](https://www.alphavantage.co/support/#api-key) +Go to: https://www.alphavantage.co/support/#api-key ![AlphaVantage](https://user-images.githubusercontent.com/46355364/207820936-46c2ba00-81ff-4cd3-98a4-4fa44412996f.png) @@ -115,10 +74,12 @@ Fill out the form, pass Captcha, and click on, "GET FREE API KEY". The issued ke ### Binance +> Binance cryptocurrency exchange - We operate the worlds biggest bitcoin exchange and altcoin crypto exchange in the world by volume +
-Go to: https://www.binance.com/en/support/faq/how-to-create-api-360002502072 +Instructions -[Binance](https://www.binance.com/en/support/faq/how-to-create-api-360002502072) +Go to: https://www.binance.com/en/support/faq/how-to-create-api-360002502072 ![Binance](https://user-images.githubusercontent.com/46355364/207839805-f71cf12a-62d2-41cb-ba19-0c35917abc40.png) @@ -132,10 +93,12 @@ These instructions should provide clear guidance for obtaining an API Key. Enter ### Bitquery +> Bitquery is an API-first product company dedicated to power and solve blockchain data problems using the ground truth of on-chain data. +
-Go to: https://bitquery.io/ +Instructions -[Bitquery](https://bitquery.io/) +Go to: https://bitquery.io/< ![Bitquery](https://user-images.githubusercontent.com/46355364/207840322-5532a3f9-739f-4e28-9839-a58db932882e.png) @@ -157,10 +120,12 @@ Enter this API key into the OpenBB Terminal by typing: ### CoinMarketCap +> CoinMarketCap is the world's most-referenced price-tracking website for cryptoassets in the rapidly growing cryptocurrency space. Its mission is to make crypto discoverable and efficient globally by empowering retail users with unbiased, high quality and accurate information for drawing their own informed conclusions. +
-Go to: https://coinmarketcap.com/api +Instructions -[CoinMarketCap](https://coinmarketcap.com/api) +Go to: https://coinmarketcap.com/api< ![CoinMarketCap](https://user-images.githubusercontent.com/46355364/207831111-3f09ed75-740e-4121-a67e-6e1f36e8ab9a.png) @@ -182,10 +147,12 @@ Enter the API key into the OpenBB Terminal by typing: ### Coinbase +> Coinbase is a secure online platform for buying, selling, transferring, and storing cryptocurrency. +
-Go to: https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key +Instructions -[Coinbase](https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key) +Go to: https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key ![Coinbase](https://user-images.githubusercontent.com/46355364/207841901-647f0aef-0c74-454d-b99e-367d784259f0.png) @@ -199,10 +166,12 @@ Follow the instructions to obtain the credentials for the specific account. Ente ### Coinglass +> Coinglass is a cryptocurrency futures trading & information platform,where you can find the Bitcoin Liquidations ,Bitcoin open interest, Grayscale Bitcoin Trust，Bitcoin longs vs shorts ratio and actively compare funding rates for crypto futures.Above all the quantities are shown as per their respective contract value. +
-Go to: https://www.coinglass.com/ +Instructions -[Coinglass](https://www.coinglass.com/) +Go to: https://www.coinglass.com/< ![Coinglass](https://user-images.githubusercontent.com/46355364/207844601-8510687a-e54f-49b9-961f-5ef6718f58ab.png) @@ -220,10 +189,12 @@ With the account created, find the assigned API key within the account profile p ### Crypto Panic +> CryptoPanic is a news aggregator platform indicating impact on price and market for traders and cryptocurrency enthusiasts. +
-Go to: https://cryptopanic.com/developers/api/ +Instructions -[Crypto Panic](https://cryptopanic.com/developers/api/) +Go to: https://cryptopanic.com/developers/api/ ![Crypto Panic](https://user-images.githubusercontent.com/46355364/207848733-27e5a804-7ae7-4ca2-88b2-848b32929b6f.png) @@ -241,10 +212,12 @@ Enter that value in the OpenBB Terminal by typing: ### Databento +> Databento eliminates tens of thousands of dollars in upfront expenses per dataset without sacrificing data integrity. We give you the flexibility to pick up real-time full exchange feeds and terabytes of historical data, whenever you need it. +
-Go to: https://docs.databento.com/getting-started +Instructions -[Databento](https://docs.databento.com/getting-started) +Go to: https://docs.databento.com/getting-started ![Databento](https://user-images.githubusercontent.com/85772166/221943074-7a5e55c1-6193-42d8-a04c-431603a69a05.png) @@ -260,12 +233,14 @@ Enter this into the terminal with:
-### Degiro +### DEGIRO + +> DEGIRO is Europe's fastest growing online stock broker. DEGIRO distinguishes itself from its competitors by offering extremely low trading commissions.
-Go to: https://www.degiro.com/ +Instructions -[Degiro](https://www.degiro.com/) +Go to: https://www.degiro.com/ ![Degiro](https://user-images.githubusercontent.com/46355364/207838353-001d350c-872c-4770-a586-fb21318122eb.png) @@ -281,10 +256,12 @@ Instructions for setting up 2FA authorization are [here](https://github.com/Chav ### EODHD +> Historical End of Day, Intraday, and Live prices API, with Fundamental Financial data API for more than 120000 stocks, ETFs and funds all over the world. +
-Go to: https://eodhistoricaldata.com/r/?ref=869U7F4J +Instructions -[EODHD](https://eodhistoricaldata.com/r/?ref=869U7F4J) +Go to: https://eodhistoricaldata.com/r/?ref=869U7F4J< ![EODHD](https://user-images.githubusercontent.com/46355364/207849214-23763c95-7314-42ae-b97d-cb5810686498.png) @@ -306,10 +283,12 @@ Enter this string into the OpenBB Terminal by typing: ### Finnhub +> With the sole mission of democratizing financial data, we are proud to offer a FREE realtime API for stocks, forex and cryptocurrency. +
-Go to: https://finnhub.io/ +Instructions -[Finnhub](https://finnhub.io/) +Go to: https://finnhub.io/ ![Finnhub](https://user-images.githubusercontent.com/46355364/207832028-283c3321-8c05-4ee8-b4d2-41cdc940f408.png) @@ -331,10 +310,12 @@ Add this key to the OpenBB Terminal by entering: ### Financial Modeling Prep +> Enchance your application with our data that goes up to 30 years back in history. Earnings calendar, financial statements, multiple exchanges and more! +
-Go to: https://site.financialmodelingprep.com/developer/docs +Instructions -[FinancialModelingPrep](https://site.financialmodelingprep.com/developer/docs) +Go to: https://site.financialmodelingprep.com/developer/docs ![FinancialModelingPrep](https://user-images.githubusercontent.com/46355364/207821920-64553d05-d461-4984-b0fe-be0368c71186.png) @@ -356,10 +337,12 @@ Enter the key into the OpenBB Terminal with: ### FRED +> FRED is the trusted source for economic data since 1991. Download, graph, and track 819,000 US and international time series from 110 sources. +
-Go to: https://fred.stlouisfed.org +Instructions -[FRED](https://fred.stlouisfed.org) +Go to: https://fred.stlouisfed.org ![FRED](https://user-images.githubusercontent.com/46355364/207827137-d143ba4c-72cb-467d-a7f4-5cc27c597aec.png) @@ -385,10 +368,12 @@ Enter the API key into the OpenBB Terminal with: ### GitHub +> GitHub is where over 100 million developers shape the future of software. +
-Go to: https://github.com +Instructions -[GitHub](https://github.com) +Go to: https://github.com ![GitHub](https://user-images.githubusercontent.com/46355364/207846953-7feae777-3c3b-4f21-9dcf-84817c732618.png) @@ -410,10 +395,12 @@ After creating the app, the key will be issued. Enter this token into the OpenBB ### Glassnode +> Glassnode makes blockchain data accessible for everyone. We source and carefully dissect on-chain data, to deliver contextualized and actionable insights. +
-Go to: https://studio.glassnode.com +Instructions -[Glassnode](https://studio.glassnode.com) +Go to: https://studio.glassnode.com ![Glassnode](https://user-images.githubusercontent.com/46355364/207843761-799078ff-fa64-4d39-a6eb-ba01d250be69.png) @@ -433,12 +420,14 @@ Enter this key in the OpenBB terminal with:
-### IEX Cloud +### IEX Cloud (Apperate) + +> Apperate is a streaming data platform for finance with integrated IEX Cloud Data Bundles. We help developers skip the headaches of building with real-time data.
-Go to: https://iexcloud.io +Instructions -[IEX Cloud](https://iexcloud.io) +Go to: https://iexcloud.io ![IEX Cloud](https://user-images.githubusercontent.com/46355364/207833088-e879e9f2-3180-4e50-ba9e-f40ee958f98a.png) @@ -464,10 +453,12 @@ Add this API key to the OpenBB Terminal by entering: ### Intrinio +> Intrinio is more than a financial data API provider – we're a real time data partner. That means we're your guide to every step of the financial data. +
-Go to: https://intrinio.com/starter-plan +Instructions -[Intrinio](https://intrinio.com/starter-plan) +Go to: https://intrinio.com/starter-plan ![Intrinio](https://user-images.githubusercontent.com/85772166/219207556-fcfee614-59f1-46ae-bff4-c63dd2f6991d.png) @@ -481,10 +472,12 @@ An API key will be issued with a subscription. Find the token value within the a ### Messari +> Gain an edge over the crypto market with professional grade data, tools, and research. +
-Go to: https://messari.io +Instructions -[Messari](https://messari.io) +Go to: https://messari.io ![Messari](https://user-images.githubusercontent.com/46355364/207848122-ec6a41e4-76b7-4620-adc3-1f1c19f4bca6.png) @@ -506,10 +499,12 @@ Copy the API key and add it to the OpenBB Terminal by entering: ### News API +> News API is a simple, easy-to-use REST API that returns JSON search results for current and historic news articles published by over 80,000 worldwide sources. +
-Go to: https://newsapi.org +Instructions -[News API](https://newsapi.org) +Go to: https://newsapi.org ![News API](https://user-images.githubusercontent.com/46355364/207828250-0c5bc38c-90b4-427d-a611-b43c98c8e7ab.png) @@ -531,10 +526,12 @@ Add this API key into the OpenBB Terminal by entering: ### Oanda +> OANDA's Currency Converter allows you to check the latest foreign exchange average bid/ask rates and convert all major world currencies. +
-Go to: https://developer.oanda.com +Instructions -[Oanda](https://developer.oanda.com) +Go to: https://developer.oanda.com ![Oanda](https://user-images.githubusercontent.com/46355364/207839324-d30aa2b6-be83-41ff-9b1b-146cac566789.png) @@ -552,10 +549,12 @@ Upon completion of the account setup, enter the credentials into the OpenBB Term ### Polygon +> Live & historical data for US stocks for all 19 exchanges. Instant access to real-time and historical stock market data. +
-Go to: https://polygon.io +Instructions -[Polygon](https://polygon.io) +Go to: https://polygon.io ![Polygon](https://user-images.githubusercontent.com/46355364/207825623-fcd7f0a3-131a-4294-808c-754c13e38e2a.png) @@ -577,10 +576,12 @@ Enter the key into the OpenBB Terminal by typing: ### Quandl +> The premier source for financial, economic, and alternative datasets, serving investment professionals. Quandl’s platform is used by over 400,000 people, including analysts from the world’s top hedge funds, asset managers and investment banks. +
-Go to: https://www.quandl.com +Instructions -[Quandl](https://www.quandl.com) +Go to: https://www.quandl.com ![Quandl](https://user-images.githubusercontent.com/46355364/207823899-208a3952-f557-4b73-aee6-64ac00faedb7.png) @@ -602,10 +603,12 @@ Enter the key into the OpenBB Terminal with: ### Reddit +> Reddit is a network of communities where people can dive into their interests, hobbies and passions. +
-Sign in to Reddit, and then go to: https://old.reddit.com/prefs/apps/ +Instructions -[Reddit](https://old.reddit.com/prefs/apps/) +Sign in to Reddit, and then go to: https://old.reddit.com/prefs/apps/ ![Reddit](https://preview.redd.it/540vrn3k0cn91.png?width=986&format=png&auto=webp&v=enabled&s=88228cd0cf4415b3487b8d35e1097f0caa804e15) @@ -631,10 +634,12 @@ After submitting the form, check for a confirmation email. The credentials will ### Robinhood +> Robinhood has commission-free investing, and tools to help shape your financial future. +
-Go to: https://robinhood.com/us/en +Instructions -[Robinhood](https://robinhood.com/us/en) +Go to: https://robinhood.com/us/en ![Robinhood](https://user-images.githubusercontent.com/46355364/207838058-a2311632-6459-4cfd-bc0a-639ee3931574.png) @@ -650,10 +655,12 @@ The first login will request 2FA authorization from the device connected to the ### Santiment +> We provide tools to help you analyze crypto markets and find data-driven opportunities to optimize your investing. +
-Go to: https://app.santiment.net +Instructions -![Santiment](https://user-images.githubusercontent.com/46355364/207849709-a5f10b03-138c-4e09-89f6-8a18cfbaf008.png) +Go to: https://app.santiment.net Click on, "Sign up", and register for an account. @@ -673,10 +680,12 @@ Add it to the OpenBB Terminal by entering: ### ShroomDK +> ShroomDK (SDK), by Flipside Crypto gives you programmatic query access to the most comprehensive blockchain data sets in Web3, for free. +
-Go to: https://sdk.flipsidecrypto.xyz/shroomdk +Instructions -[ShroomDK](https://sdk.flipsidecrypto.xyz/shroomdk) +Go to: https://sdk.flipsidecrypto.xyz/shroomdk ![ShroomDK](https://user-images.githubusercontent.com/46355364/207850122-b8cd225e-0a65-4ea8-8069-0b40fff1600e.png) @@ -698,10 +707,12 @@ Enter it into the OpenBB Terminal by typing: ### Stocksera +> Empowering investors to take advantage of alternative data. We track trending tickers on social media and provide alternative data for easy due-diligence & analysis. +
-Go to: https://stocksera.pythonanywhere.com +Instructions -[Stocksera](https://stocksera.pythonanywhere.com) +Go to: https://stocksera.pythonanywhere.com ![Stocksera](https://user-images.githubusercontent.com/46355364/207853896-ee233569-26bb-4244-b115-43ac8885757a.png) @@ -723,10 +734,12 @@ Add the key to the OpenBB Terminal by entering: ### Token Terminal +> Token Terminal is a platform that aggregates financial data on the leading blockchains and decentralized applications. +
-Go to: https://tokenterminal.com +Instructions -[Token Terminal](https://tokenterminal.com) +Go to: https://tokenterminal.com ![Token Terminal](https://user-images.githubusercontent.com/46355364/207850735-69368b4f-6a3e-46b8-ba69-3b79d9231f15.png) @@ -748,10 +761,12 @@ Add the key to the OpenBB Terminal by typing: ### Tradier +> Tradier, the home of active traders. Our open collaboration platform allows investors to truly customize their trading experience like never before. +
-Go to: https://documentation.tradier.com +Instructions -[Tradier](https://documentation.tradier.com) +Go to: https://documentation.tradier.com ![Tradier](https://user-images.githubusercontent.com/46355364/207829178-a8bba770-f2ea-4480-b28e-efd81cf30980.png) @@ -765,6 +780,8 @@ Click on, "Open Account", to start the sign-up process. After the account has be ### Twitter +> From breaking news and entertainment to sports and politics, get the full story with all the live commentary. +
Upcoming changes to the Twitter API will deprecate the current functionality, it is uncertain if the current features will continue to work. @@ -774,10 +791,12 @@ Click on, "Open Account", to start the sign-up process. After the account has be ### Whale Alert +> Whale Alert continuously collects and analyzes billions of blockchain transactions and related-off chain data from hundreds of reliable sources and converts it into an easy to use standardized format. Our world-class analytics and custom high speed database solutions process transactions the moment they are made, resulting in the largest and most up-to-date blockchain dataset in the world. +
-Go to: https://docs.whale-alert.io +Instructions -[Whale Alert](https://docs.whale-alert.io) +Go to: https://docs.whale-alert.io ![Whale Alert](https://user-images.githubusercontent.com/46355364/207842892-3f71ee7a-6cd3-48a2-82e4-fa5ec5b13807.png) diff --git a/website/content/terminal/quickstart/installation/macos.md b/website/content/terminal/quickstart/installation/macos.md index 62a16fca4545..e43ec39a80f2 100644 --- a/website/content/terminal/quickstart/installation/macos.md +++ b/website/content/terminal/quickstart/installation/macos.md @@ -21,8 +21,9 @@ keywords: --- import InstallerButton from "@site/src/components/General/InstallerButton"; -Install the OpenBB Terminal on MacOS (Big Sur or later). There are two versions of the installers available for MacOS, Intel-based and Apple Silicon (M1). Apple Silicon users will need to install Rosetta prior to installation. +Install the OpenBB Terminal on MacOS (Big Sur or later). There are two versions of the installers available for MacOS, Intel-based and Apple Silicon (M1). +:::info Apple Silicon users will need to install Rosetta prior to installation To understand whether you are using an Apple Sillicon (M1) device or an Intel-based device click on the Apple Icon at the top left of your MacBook and select "About This Mac". Then under "Chip" if it says something like "Apple M1 Pro" or "Apple M1 Max", you know you have an Apple Silicon MacBook. If it says for example "2,3 GHz Quad-Core Intel Core i7" you know that you have an Intel-based MacBook and you can continue by clicking on the "Mac Intel Installer" button.
Rosetta Installation Instructions (Apple Sillicon users only) @@ -36,6 +37,8 @@ softwareupdate --install-rosetta 4. After the installation process has finished, you can proceed to the "Mac M1 Installer" button.
+::: + Once all of this is confirmed, you can use the following installation buttons. @@ -57,7 +60,7 @@ Step by step instructions: **Step 5:** Launch the application by double-clicking on the `OpenBB Terminal` application. If everything was successful you should see a screen like the one below: -

run_the_terminal

+

run_the_terminal

**Note:** During the first launch, a warning message may appear. Click, "Open". diff --git a/website/content/terminal/quickstart/installation/source.md b/website/content/terminal/quickstart/installation/source.md index 7985dc65f14b..98a08f258e04 100644 --- a/website/content/terminal/quickstart/installation/source.md +++ b/website/content/terminal/quickstart/installation/source.md @@ -20,7 +20,7 @@ keywords: ] --- -This section guides you a long to install the OpenBB Terminal via Python. This installation type supports both Windows and Unix systems (Linux + MacOS). Before starting the installation process, make sure the following pieces of software are installed. +This section guides you a long to install the OpenBB Terminal via Python. This installation type supports both Windows and Unix systems (Linux + MacOS). **Before starting the installation process, make sure the following pieces of software are installed.**
Miniconda Miniconda is a Python environment and package manager. It is required for installing certain dependencies. @@ -40,6 +40,7 @@ Go [here](https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-instal
CMake (Mac and Linux only) + If you have a **MacBook**, check if homebrew is installed by running `brew --version` If Homebrew is not installed, run: @@ -66,6 +67,7 @@ sudo apt install -y gcc cmake
VcXsrv (Windows and Linux only) + Since a WSL installation is headless by default (i.e., there is only access to a terminal running a Linux distribution) there are additional steps required to display visualizations. A more detailed tutorial is found, [here](https://medium.com/@shaoyenyu/make-matplotlib-works-correctly-with-x-server-in-wsl2-9d9928b4e36a). - Dynamically export the DISPLAY environment variable in WSL2: @@ -94,7 +96,7 @@ Alternatives to `VcXsrv` include: Once you have met all of these requirements, you are ready to install the OpenBB Terminal. -**Creating a virtual environment** +## Creating a virtual environment When a terminal window is opened, if the base Conda environment - look for `(base)` to the left of the cursor on the command line - is not activated automatically, find the path for it by entering: @@ -120,7 +122,7 @@ Create the environment by copying the code below into the command line: conda create -n obb -c conda-forge python=3.10.9 pip pybind11 cmake git cvxpy lightgbm poetry ``` -**Activate the obb environment** +## Activate the obb environment After the packages from the previous step are installled, activate the newly created environment by entering: @@ -128,7 +130,7 @@ After the packages from the previous step are installled, activate the newly cre conda activate obb ``` -**Install OpenBB Terminal** +## Install the OpenBB Terminal From your code editor or command line, browse to the location the OpenBB Terminal source code should live. Make sure you have completed the previous steps. @@ -161,7 +163,7 @@ python terminal.py **TROUBLESHOOTING:** Having difficulty getting through the installation, or encountering errors? Check out the [troubleshooting page](/terminal/quickstart/troubleshooting), or reach out to our [Discord](https://discord.gg/Up2QGbMKHY) community for help. -**Advanced: About Poetry** +:::info About Poetry By default we advise using `conda` and `poetry` for environment setup and dependency management. Conda ships binaries for packages like `numpy` so these dependencies are not built from source locally by `pip`. Poetry solves the dependency tree in a way that the dependencies of dependencies of dependencies use versions that are compatible with each other. @@ -182,4 +184,6 @@ pip install -r requirements.txt The dependency tree is solved by poetry. -Note: The libraries specified in the requirements files have been tested and work for the purpose of this project, however, these may be older versions. Hence, it is recommended for the user to set up a virtual python environment prior to installing these. This allows to keep dependencies required by different projects in separate places. \ No newline at end of file +Note: The libraries specified in the requirements files have been tested and work for the purpose of this project, however, these may be older versions. Hence, it is recommended for the user to set up a virtual python environment prior to installing these. This allows to keep dependencies required by different projects in separate places. + +::: \ No newline at end of file diff --git a/website/content/terminal/quickstart/installation/windows.md b/website/content/terminal/quickstart/installation/windows.md index b7f728f0be1a..ff3b9153f2d0 100644 --- a/website/content/terminal/quickstart/installation/windows.md +++ b/website/content/terminal/quickstart/installation/windows.md @@ -39,4 +39,4 @@ This section provides you with the installation file as well as the guide to ins The first time this takes a bit longer to load, this can take up to a few minutes. If everything was successful you should see a screen like the one below: -

run_the_terminal

+

run_the_terminal

From 8ad742d4b5c8d407a7b05c0d3dfcd03955179ef8 Mon Sep 17 00:00:00 2001 From: jeroen Date: Mon, 6 Mar 2023 20:44:54 +0100 Subject: [PATCH 11/21] Fix keys wrong redirect --- openbb_terminal/terminal_helper.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/openbb_terminal/terminal_helper.py b/openbb_terminal/terminal_helper.py index 9eb665264d49..e868b2aae179 100644 --- a/openbb_terminal/terminal_helper.py +++ b/openbb_terminal/terminal_helper.py @@ -134,7 +134,7 @@ def open_openbb_documentation( path = "/" command = "" elif "keys" in path: - path = "/guides/advanced/api-keys" + path = "/guides/basics/api-keys" command = "" elif "settings" in path: path = "/guides/advanced/customizing-the-terminal" @@ -170,7 +170,7 @@ def open_openbb_documentation( if command: if command == "keys": - path = "/guides/advanced/api-keys" + path = "/guides/basics/api-keys" command = "" elif "settings" in path or "featflags" in path: path = "/guides/advanced/customizing-the-terminal" From 313908e709161035346f04c6a94b897abe8a9ddd Mon Sep 17 00:00:00 2001 From: jeroen Date: Mon, 6 Mar 2023 20:57:58 +0100 Subject: [PATCH 12/21] Update installation --- .../content/terminal/quickstart/installation/installation.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/website/content/terminal/quickstart/installation/installation.md b/website/content/terminal/quickstart/installation/installation.md index 20de799e574c..a7627ff8ce01 100644 --- a/website/content/terminal/quickstart/installation/installation.md +++ b/website/content/terminal/quickstart/installation/installation.md @@ -23,6 +23,4 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import InstallerButton from "@site/src/components/General/InstallerButton"; -The OpenBB Terminal can be directly installed on a Mac or Windows machine via the installer packages below. While not available for Linux is currently available, it can be installed from the command line in a virtual Python environment. Having trouble? Reach us on [Discord](https://openbb.co/discord) or visit our [contact page](https://openbb.co/contact). - -Follow along with the instructions for the preferred installation method: +The OpenBB Terminal can be installed via a variety of ways. The most user-friendly approach is using the installer versions, you are able to find the installer version of Windows [here](installation/windows) and that of MacOS [here](installation/macos). Furthermore, for those that are used to Docker environments, there is support for Docker for Windows, MacOS and Linux as found [here](/terminal/quickstart/installation/docker). The source code resides on GitHub and is written in Python. For those familiar with the usage of Python and Git and want access to development versions of the OpenBB Terminal, have a look [here](installation/source). From bf62fd425da837d0a50c51bee540639e218ed74f Mon Sep 17 00:00:00 2001 From: jeroen Date: Mon, 6 Mar 2023 21:07:06 +0100 Subject: [PATCH 13/21] Update requirements --- .../quickstart/installation/installation.md | 6 +++++- .../terminal/quickstart/installation/macos.md | 8 ++++++++ .../quickstart/installation/windows.md | 8 ++++++++ .../terminal/quickstart/requirements.md | 20 ------------------- 4 files changed, 21 insertions(+), 21 deletions(-) delete mode 100644 website/content/terminal/quickstart/requirements.md diff --git a/website/content/terminal/quickstart/installation/installation.md b/website/content/terminal/quickstart/installation/installation.md index a7627ff8ce01..e791d0290fa4 100644 --- a/website/content/terminal/quickstart/installation/installation.md +++ b/website/content/terminal/quickstart/installation/installation.md @@ -23,4 +23,8 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import InstallerButton from "@site/src/components/General/InstallerButton"; -The OpenBB Terminal can be installed via a variety of ways. The most user-friendly approach is using the installer versions, you are able to find the installer version of Windows [here](installation/windows) and that of MacOS [here](installation/macos). Furthermore, for those that are used to Docker environments, there is support for Docker for Windows, MacOS and Linux as found [here](/terminal/quickstart/installation/docker). The source code resides on GitHub and is written in Python. For those familiar with the usage of Python and Git and want access to development versions of the OpenBB Terminal, have a look [here](installation/source). +The OpenBB Terminal can be installed via a variety of ways. The most user-friendly approach is using the installer versions, you are able to find the installer version of Windows [here](installation/windows) and that of MacOS [here](installation/macos). + +Furthermore, for those that are used to Docker environments, there is support for Docker for Windows, MacOS and Linux as found [here](/terminal/quickstart/installation/docker). + +The source code resides on GitHub and is written in Python. For those familiar with the usage of Python and Git and want access to development versions of the OpenBB Terminal, have a look [here](installation/source). \ No newline at end of file diff --git a/website/content/terminal/quickstart/installation/macos.md b/website/content/terminal/quickstart/installation/macos.md index e43ec39a80f2..0654a6a0d833 100644 --- a/website/content/terminal/quickstart/installation/macos.md +++ b/website/content/terminal/quickstart/installation/macos.md @@ -23,6 +23,14 @@ import InstallerButton from "@site/src/components/General/InstallerButton"; Install the OpenBB Terminal on MacOS (Big Sur or later). There are two versions of the installers available for MacOS, Intel-based and Apple Silicon (M1). +Note that the minimal requirements are: + +- MacOS Monterey or newer +- Modern CPU (Intel processor made in the last 5 years or Apple Silicon chip) +- At least 4GB of RAM +- At least 5GB of free storage +- Internet connection (cable or 4G mobile) + :::info Apple Silicon users will need to install Rosetta prior to installation To understand whether you are using an Apple Sillicon (M1) device or an Intel-based device click on the Apple Icon at the top left of your MacBook and select "About This Mac". Then under "Chip" if it says something like "Apple M1 Pro" or "Apple M1 Max", you know you have an Apple Silicon MacBook. If it says for example "2,3 GHz Quad-Core Intel Core i7" you know that you have an Intel-based MacBook and you can continue by clicking on the "Mac Intel Installer" button. diff --git a/website/content/terminal/quickstart/installation/windows.md b/website/content/terminal/quickstart/installation/windows.md index ff3b9153f2d0..2303a255eef7 100644 --- a/website/content/terminal/quickstart/installation/windows.md +++ b/website/content/terminal/quickstart/installation/windows.md @@ -23,6 +23,14 @@ import InstallerButton from "@site/src/components/General/InstallerButton"; This section provides you with the installation file as well as the guide to install the OpenBB Terminal via Windows (10 or greater). +Note that the minimal requirements are: + +- Windows 10 or newer +- Modern CPU (Intel or AMD processor made in the last 5 years) +- At least 4GB of RAM +- At least 5GB of free storage +- Internet connection (cable or 4G mobile) + **Step 1:** Download the file by clicking on the button.

diff --git a/website/content/terminal/quickstart/requirements.md b/website/content/terminal/quickstart/requirements.md deleted file mode 100644 index 2f40ba3e576c..000000000000 --- a/website/content/terminal/quickstart/requirements.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Requirements -sidebar_position: 1 -description: General system requirements for installing the OpenBB Terminal. -keywords: [installation, installer, install, guide, mac, windows, linux, python, github, macos, how to, explanation, requirements, openbb terminal] ---- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Installation of the OpenBB Terminal requires downloading around 4GB of data. Querying data (by running commands) does not require a lot of bandwidth but you will certainly have a more pleasant experience if you are on a fast internet connection. 4G networks provide a good enough experience so if you're traveling your personal hot-spot will do. While it's technically possible to use a subset of the functionality in off-line mode, you will not be able to use any data that is queried from the APIs of data providers and services. - -## Minimum System Requirements - -- A modern CPU compatible with the Intel Math Kernel Library, supporting SSE3 & SSE4.2 instructions. -- Windows 10 or higher. -- MacOS Monterey or higher, with Rosetta installed. -- Check the Ubuntu hardware certified hardware page [here](https://ubuntu.com/certified?q=&limit=20&category=Desktop&category=Laptop). -- 4GB RAM or more -- 5GB free storage -- Internet connection From 1c1c628fe1c41f897a3832f4219301dc1789666b Mon Sep 17 00:00:00 2001 From: jeroen Date: Mon, 6 Mar 2023 21:15:33 +0100 Subject: [PATCH 14/21] move things around --- .../terminal/quickstart/installation/macos.md | 28 +++++++++---------- .../quickstart/installation/windows.md | 21 +++++++------- 2 files changed, 24 insertions(+), 25 deletions(-) diff --git a/website/content/terminal/quickstart/installation/macos.md b/website/content/terminal/quickstart/installation/macos.md index 0654a6a0d833..9f3aca45dcf5 100644 --- a/website/content/terminal/quickstart/installation/macos.md +++ b/website/content/terminal/quickstart/installation/macos.md @@ -23,6 +23,13 @@ import InstallerButton from "@site/src/components/General/InstallerButton"; Install the OpenBB Terminal on MacOS (Big Sur or later). There are two versions of the installers available for MacOS, Intel-based and Apple Silicon (M1). +

+ +

+ + +
Minimal Requirements + Note that the minimal requirements are: - MacOS Monterey or newer @@ -31,6 +38,8 @@ Note that the minimal requirements are: - At least 5GB of free storage - Internet connection (cable or 4G mobile) +
+ :::info Apple Silicon users will need to install Rosetta prior to installation To understand whether you are using an Apple Sillicon (M1) device or an Intel-based device click on the Apple Icon at the top left of your MacBook and select "About This Mac". Then under "Chip" if it says something like "Apple M1 Pro" or "Apple M1 Max", you know you have an Apple Silicon MacBook. If it says for example "2,3 GHz Quad-Core Intel Core i7" you know that you have an Intel-based MacBook and you can continue by clicking on the "Mac Intel Installer" button. @@ -47,26 +56,17 @@ softwareupdate --install-rosetta
::: - -Once all of this is confirmed, you can use the following installation buttons. - -

- -

- Step by step instructions: -**Step 1:** Download the DMG file from the links above. - -**Step 2:** Mount the downloaded DMG file by double-clicking on it. - -**Step 3:** Click and drag the OpenBB Terminal folder and hold it over the Applications shortcut. This opens a new Finder window, then drag the OpenBB Terminal folder into the Applications folder. +1. Download the DMG file from the links above. +2. Mount the downloaded DMG file by double-clicking on it. +3. Click and drag the OpenBB Terminal folder and hold it over the Applications shortcut. This opens a new Finder window, then drag the OpenBB Terminal folder into the Applications folder. ![MacOS Installation](https://user-images.githubusercontent.com/11668535/173027899-9b25ae4f-1eef-462c-9dc9-86086e9cf197.png) -**Step 4:** Unmount the installer, by "Ejecting OpenBB Terminal" from, locations, in Finder. +4. Unmount the installer, by "Ejecting OpenBB Terminal" from, locations, in Finder. -**Step 5:** Launch the application by double-clicking on the `OpenBB Terminal` application. If everything was successful you should see a screen like the one below: +5. Launch the application by double-clicking on the `OpenBB Terminal` application. If everything was successful you should see a screen like the one below:

run_the_terminal

diff --git a/website/content/terminal/quickstart/installation/windows.md b/website/content/terminal/quickstart/installation/windows.md index 2303a255eef7..3a0d62aff589 100644 --- a/website/content/terminal/quickstart/installation/windows.md +++ b/website/content/terminal/quickstart/installation/windows.md @@ -23,7 +23,9 @@ import InstallerButton from "@site/src/components/General/InstallerButton"; This section provides you with the installation file as well as the guide to install the OpenBB Terminal via Windows (10 or greater). -Note that the minimal requirements are: + + +
Minimal Requirements - Windows 10 or newer - Modern CPU (Intel or AMD processor made in the last 5 years) @@ -31,20 +33,17 @@ Note that the minimal requirements are: - At least 5GB of free storage - Internet connection (cable or 4G mobile) -**Step 1:** Download the file by clicking on the button. - -

- -

- -**Step 2:** Open the downloaded `exe` file by double-clicking on it. +
-**Step 3:** Follow the prompts to complete the installation process +Find a step by step guide below: -**Step 4:** Double-click on the application that appeared on your Desktop, you are now able to run the OpenBB Terminal +1. Download the file by clicking on the button. +2. Open the downloaded `exe` file by double-clicking on it. +3. Follow the prompts to complete the installation process +4. Double-click on the application that appeared on your Desktop, you are now able to run the OpenBB Terminal

run_the_terminal

The first time this takes a bit longer to load, this can take up to a few minutes. If everything was successful you should see a screen like the one below: -

run_the_terminal

+

run_the_terminal

\ No newline at end of file From 58cc00d2fc11173143e518aa3a8982ab51d25352 Mon Sep 17 00:00:00 2001 From: jeroen Date: Mon, 6 Mar 2023 22:04:37 +0100 Subject: [PATCH 15/21] Restructure everything --- openbb_terminal/terminal_helper.py | 4 +- pyproject.toml | 2 +- .../{quickstart/troubleshooting.md => faq.md} | 4 +- .../advanced}/api-keys.md | 232 ++++++++++-------- .../sdk/guides/advanced/changing-sources.md | 2 +- website/content/sdk/guides/advanced/data.md | 2 +- .../sdk/{quickstart => }/installation.md | 100 +++----- .../content/sdk/quickstart/_category_.json | 4 - .../content/sdk/quickstart/requirements.md | 35 --- website/content/sdk/reference/_category_.json | 2 +- .../{quickstart/troubleshooting.md => faq.md} | 4 +- .../advanced}/api-keys.md | 8 +- .../guides/advanced/changing-sources.md | 2 +- .../advanced/customizing-the-terminal.md | 2 +- .../content/terminal/guides/advanced/data.md | 2 +- .../guides/advanced/scripts-and-routines.md | 2 +- .../content/terminal/guides/basics/index.md | 6 +- .../guides/intros/stocks/dark-pool-shorts.md | 2 +- .../guides/intros/stocks/options/index.md | 2 +- .../{quickstart => }/installation/docker.md | 0 .../installation/installation.md | 0 .../{quickstart => }/installation/macos.md | 0 .../{quickstart => }/installation/source.md | 0 .../{quickstart => }/installation/windows.md | 2 +- .../terminal/quickstart/_category_.json | 4 - .../terminal/reference/_category_.json | 2 +- website/{content/sdk/quickstart => }/pypi.md | 0 27 files changed, 186 insertions(+), 239 deletions(-) rename website/content/sdk/{quickstart/troubleshooting.md => faq.md} (99%) rename website/content/sdk/{quickstart => guides/advanced}/api-keys.md (73%) rename website/content/sdk/{quickstart => }/installation.md (51%) delete mode 100644 website/content/sdk/quickstart/_category_.json delete mode 100644 website/content/sdk/quickstart/requirements.md rename website/content/terminal/{quickstart/troubleshooting.md => faq.md} (99%) rename website/content/terminal/{quickstart => guides/advanced}/api-keys.md (99%) rename website/content/terminal/{quickstart => }/installation/docker.md (100%) rename website/content/terminal/{quickstart => }/installation/installation.md (100%) rename website/content/terminal/{quickstart => }/installation/macos.md (100%) rename website/content/terminal/{quickstart => }/installation/source.md (100%) rename website/content/terminal/{quickstart => }/installation/windows.md (98%) delete mode 100644 website/content/terminal/quickstart/_category_.json rename website/{content/sdk/quickstart => }/pypi.md (100%) diff --git a/openbb_terminal/terminal_helper.py b/openbb_terminal/terminal_helper.py index e868b2aae179..9eb665264d49 100644 --- a/openbb_terminal/terminal_helper.py +++ b/openbb_terminal/terminal_helper.py @@ -134,7 +134,7 @@ def open_openbb_documentation( path = "/" command = "" elif "keys" in path: - path = "/guides/basics/api-keys" + path = "/guides/advanced/api-keys" command = "" elif "settings" in path: path = "/guides/advanced/customizing-the-terminal" @@ -170,7 +170,7 @@ def open_openbb_documentation( if command: if command == "keys": - path = "/guides/basics/api-keys" + path = "/guides/advanced/api-keys" command = "" elif "settings" in path or "featflags" in path: path = "/guides/advanced/customizing-the-terminal" diff --git a/pyproject.toml b/pyproject.toml index afab943907b1..c884f1dbda92 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -8,7 +8,7 @@ packages = [ { include = "openbb_terminal" }, ] include = ["terminal.py"] -readme = "website/content/sdk/quickstart/pypi.md" +readme = "website/pypi.md" homepage = "https://openbb.co" repository = "https://github.com/OpenBB-finance/OpenBBTerminal" documentation = "https://docs.openbb.co/sdk" diff --git a/website/content/sdk/quickstart/troubleshooting.md b/website/content/sdk/faq.md similarity index 99% rename from website/content/sdk/quickstart/troubleshooting.md rename to website/content/sdk/faq.md index 1f1a48fe950c..9d645bee7270 100644 --- a/website/content/sdk/quickstart/troubleshooting.md +++ b/website/content/sdk/faq.md @@ -1,6 +1,6 @@ --- -title: Troubleshooting -sidebar_position: 4 +title: FAQ +sidebar_position: 6 keywords: [faq, questions, openbb, terminal, troubleshooting, errors, bugs, issues, problems, installation, contributors, developers, github, pip] --- Still experiencing trouble after consulting this page? Reach us on [Discord](https://openbb.co/discord) or visit our [contact page](https://openbb.co/contact). diff --git a/website/content/sdk/quickstart/api-keys.md b/website/content/sdk/guides/advanced/api-keys.md similarity index 73% rename from website/content/sdk/quickstart/api-keys.md rename to website/content/sdk/guides/advanced/api-keys.md index e9623d12af7d..70c94c1da15a 100644 --- a/website/content/sdk/quickstart/api-keys.md +++ b/website/content/sdk/guides/advanced/api-keys.md @@ -1,6 +1,6 @@ --- title: Setting API Keys -sidebar_position: 3 +sidebar_position: 1 description: API (Application Programming Interface) keys are access credentials for accessing data from a particular source. They are a string of random characters assigned, by the data provider, to an individual account. Most vendors offer a free tier requiring only a valid email address. Each key is entered into the OpenBB SDk from the `openbb.keys` module, using the syntax described below. The docstrings for each source will also display the expected inputs. keywords: [api, keys, api keys, data provider, data, free, alpha vantage, fred, iex, twitter, degiro, binance, coinglass, polygon, intrinio, sdk] --- @@ -67,57 +67,18 @@ openbb.keys.mykeys(show = True) **We recommend gradually obtaining keys, when the use of a specific function requires it.** -## Summary List - -
-Click to expand the list of data providers - -| Command | Name | URL | -| :------------ | :--------------------------------------- | :--------------------------------------------------------------------------------- | -| av | AlphaVantage | https://www.alphavantage.co/support/#api-key | -| binance | Binance | https://binance.com | -| bitquery | Bitquery | https://bitquery.io/ | -| cmc | CoinMarketCap | https://coinmarketcap.com/api/ | -| coinbase | Coinbase | https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key | -| coinglass | Coinglass | https://coinglass.github.io/API-Reference/#api-key | -| cpanic | Crypto Panic | https://cryptopanic.com/developers/api/ | -| databento | Databento | https://docs.databento.com/getting-started | -| degiro | DeGiro | https://www.degiro.com/ | -| eodhd | EODHD | https://eodhistoricaldata.com/r/?ref=869U7F4J | -| ethplorer | Ethplorer | https://github.com/EverexIO/Ethplorer/wiki/Ethplorer-API | -| finnhub | Finnhub | https://finnhub.io/ | -| fmp | Financial Modelling Prep | https://site.financialmodelingprep.com/developer/docs/ | -| fred | Federal Reserve Economic Database (FRED) | https://fred.stlouisfed.org | -| github | GitHub | https://docs.github.com/en/rest/guides/getting-started-with-the-rest-api | -| glassnode | Glassnode | https://docs.glassnode.com/basic-api/api-key#how-to-get-an-api-key/ | -| iex | IEX Cloud | https://iexcloud.io/ | -| intrinio | Intrinio | https://intrinio.com/ | -| messari | Messari | https://messari.io/api/docs | -| news | News API | https://newsapi.org/ | -| oanda | Oanda | https://developer.oanda.com | -| polygon | Polygon | https://polygon.io | -| quandl | Quandl | https://www.quandl.com | -| reddit | Reddit | https://www.reddit.com/wiki/api | -| rh | Robinhood | https://robinhood.com/us/en/ | -| santiment | Santiment | https://app.santiment.net/ | -| shroom | ShroomDK | https://sdk.flipsidecrypto.xyz/shroomdk | -| smartstake | Smartstake | https://www.smartstake.io | -| stocksera | Stocksera | https://stocksera.pythonanywhere.com/ | -| tokenterminal | Token Terminal | https://tokenterminal.com/ | -| tradier | Tradier | https://documentation.tradier.com/ | -| twitter | Twitter | https://developer.twitter.com | -| walert | Whale Alert | https://docs.whale-alert.io/ | - -
- ## Instructions by Source This section covers all API keys listed above and include detailed instructions how to obtain each API key. By clicking on each name, the section will expand and instructions are provided. Include, `persist = True` in the syntax to permanently store the key on the machine. ### AlphaVantage +> Alpha Vantage provides enterprise-grade financial market data through a set of powerful and developer-friendly data APIs and spreadsheets. From traditional asset classes (e.g., stocks, ETFs, mutual funds) to economic indicators, from foreign exchange rates to commodities, from fundamental data to technical indicators, Alpha Vantage is your one-stop-shop for real-time and historical global market data delivered through cloud-based APIs, Excel, and Google Sheets. +
-Go to: https://www.alphavantage.co/support/#api-key +Instructions + +Go to: https://www.alphavantage.co/support/#api-key [AlphaVantage](https://www.alphavantage.co/support/#api-key) @@ -133,10 +94,12 @@ openbb.keys.av(key = 'REPLACE_WITH_KEY', persist = True) ### Binance +> Binance cryptocurrency exchange - We operate the worlds biggest bitcoin exchange and altcoin crypto exchange in the world by volume +
-Go to: https://www.binance.com/en/support/faq/how-to-create-api-360002502072 +Instructions -[Binance](https://www.binance.com/en/support/faq/how-to-create-api-360002502072) +Go to: https://www.binance.com/en/support/faq/how-to-create-api-360002502072 ![Binance](https://user-images.githubusercontent.com/46355364/207839805-f71cf12a-62d2-41cb-ba19-0c35917abc40.png) @@ -154,10 +117,12 @@ openbb.keys.binance( ### Bitquery +> Bitquery is an API-first product company dedicated to power and solve blockchain data problems using the ground truth of on-chain data. +
-Go to: https://bitquery.io/ +Instructions -[Bitquery](https://bitquery.io/) +Go to: https://bitquery.io/< ![Bitquery](https://user-images.githubusercontent.com/46355364/207840322-5532a3f9-739f-4e28-9839-a58db932882e.png) @@ -179,10 +144,14 @@ openbb.keys.bitquery(key = 'REPLACE_WITH_KEY', persist = True) ### CoinMarketCap +### CoinMarketCap + +> CoinMarketCap is the world's most-referenced price-tracking website for cryptoassets in the rapidly growing cryptocurrency space. Its mission is to make crypto discoverable and efficient globally by empowering retail users with unbiased, high quality and accurate information for drawing their own informed conclusions. +
-Go to: https://coinmarketcap.com/api +Instructions -[CoinMarketCap](https://coinmarketcap.com/api) +Go to: https://coinmarketcap.com/api ![CoinMarketCap](https://user-images.githubusercontent.com/46355364/207831111-3f09ed75-740e-4121-a67e-6e1f36e8ab9a.png) @@ -204,10 +173,12 @@ openbb.keys.cmc(key = 'REPLACE_WITH_KEY', persist = True) ### Coinbase +> Coinbase is a secure online platform for buying, selling, transferring, and storing cryptocurrency. +
-Go to: https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key +Instructions -[Coinbase](https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key) +Go to: https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key ![Coinbase](https://user-images.githubusercontent.com/46355364/207841901-647f0aef-0c74-454d-b99e-367d784259f0.png) @@ -226,10 +197,12 @@ openbb.keys.coinbase( ### Coinglass +> Coinglass is a cryptocurrency futures trading & information platform,where you can find the Bitcoin Liquidations ,Bitcoin open interest, Grayscale Bitcoin Trust，Bitcoin longs vs shorts ratio and actively compare funding rates for crypto futures.Above all the quantities are shown as per their respective contract value. +
-Go to: https://www.coinglass.com/ +Instructions -[Coinglass](https://www.coinglass.com/) +Go to: https://www.coinglass.com/ ![Coinglass](https://user-images.githubusercontent.com/46355364/207844601-8510687a-e54f-49b9-961f-5ef6718f58ab.png) @@ -247,10 +220,12 @@ openbb.keys.coinglass(key = 'REPLACE_WITH_KEY', persist = True) ### Crypto Panic +> CryptoPanic is a news aggregator platform indicating impact on price and market for traders and cryptocurrency enthusiasts. +
-Go to: https://cryptopanic.com/developers/api/ +Instructions -[Crypto Panic](https://cryptopanic.com/developers/api/) +Go to: https://cryptopanic.com/developers/api/ ![Crypto Panic](https://user-images.githubusercontent.com/46355364/207848733-27e5a804-7ae7-4ca2-88b2-848b32929b6f.png) @@ -268,10 +243,12 @@ openbb.keys.cpanic(key = 'REPLACE_WITH_KEY', persist = True) ### Databento +> Databento eliminates tens of thousands of dollars in upfront expenses per dataset without sacrificing data integrity. We give you the flexibility to pick up real-time full exchange feeds and terabytes of historical data, whenever you need it. +
-Go to: https://docs.databento.com/getting-started +Instructions -[Databento](https://docs.databento.com/getting-started) +Go to: https://docs.databento.com/getting-started ![Databento](https://user-images.githubusercontent.com/85772166/221944000-394e7123-5bb3-4218-b949-f0958b6353da.png) @@ -289,10 +266,12 @@ openbb.keys.databento(key = 'REPLACE_WITH_KEY') ### Degiro +> DEGIRO is Europe's fastest growing online stock broker. DEGIRO distinguishes itself from its competitors by offering extremely low trading commissions. +
-Go to: https://www.degiro.com/ +Instructions -[Degiro](https://www.degiro.com/) +Go to: https://www.degiro.com/ ![Degiro](https://user-images.githubusercontent.com/46355364/207838353-001d350c-872c-4770-a586-fb21318122eb.png) @@ -312,10 +291,12 @@ Instructions for setting up 2FA authorization are [here](https://github.com/Chav ### EODHD +> Historical End of Day, Intraday, and Live prices API, with Fundamental Financial data API for more than 120000 stocks, ETFs and funds all over the world. +
-Go to: https://eodhistoricaldata.com/r/?ref=869U7F4J +Instructions -[EODHD](https://eodhistoricaldata.com/r/?ref=869U7F4J) +Go to: https://eodhistoricaldata.com/r/?ref=869U7F4J ![EODHD](https://user-images.githubusercontent.com/46355364/207849214-23763c95-7314-42ae-b97d-cb5810686498.png) @@ -337,10 +318,12 @@ openbb.keys.eodhd(key = 'REPLACE_WITH_KEY', persist = True) ### Finnhub +> With the sole mission of democratizing financial data, we are proud to offer a FREE realtime API for stocks, forex and cryptocurrency. +
-Go to: https://finnhub.io/ +Instructions -[Finnhub](https://finnhub.io/) +Go to: https://finnhub.io/ ![Finnhub](https://user-images.githubusercontent.com/46355364/207832028-283c3321-8c05-4ee8-b4d2-41cdc940f408.png) @@ -362,8 +345,12 @@ openbb.keys.finnhub(key = 'REPLACE_WITH_KEY', persist = True) ### Financial Modeling Prep +> Enchance your application with our data that goes up to 30 years back in history. Earnings calendar, financial statements, multiple exchanges and more! +
-Go to: https://site.financialmodelingprep.com/developer/docs +Instructions + +Go to: https://site.financialmodelingprep.com/developer/docs [FinancialModelingPrep](https://site.financialmodelingprep.com/developer/docs) @@ -387,10 +374,12 @@ openbb.keys.fmp(key = 'REPLACE_WITH_KEY', persist = True) ### FRED +> FRED is the trusted source for economic data since 1991. Download, graph, and track 819,000 US and international time series from 110 sources. +
-Go to: https://fred.stlouisfed.org +Instructions -[FRED](https://fred.stlouisfed.org) +Go to: https://fred.stlouisfed.org ![FRED](https://user-images.githubusercontent.com/46355364/207827137-d143ba4c-72cb-467d-a7f4-5cc27c597aec.png) @@ -416,10 +405,10 @@ openbb.keys.fred(key = 'REPLACE_WITH_KEY', persist = True) ### GitHub -
-Go to: https://github.com +> GitHub is where over 100 million developers shape the future of software. -[GitHub](https://github.com) +
+Instructions ![GitHub](https://user-images.githubusercontent.com/46355364/207846953-7feae777-3c3b-4f21-9dcf-84817c732618.png) @@ -441,10 +430,12 @@ openbb.keys.github(key = 'REPLACE_WITH_KEY', persist = True) ### Glassnode +> Glassnode makes blockchain data accessible for everyone. We source and carefully dissect on-chain data, to deliver contextualized and actionable insights. +
-Go to: https://studio.glassnode.com +Instructions -[Glassnode](https://studio.glassnode.com) +Go to: https://studio.glassnode.com ![Glassnode](https://user-images.githubusercontent.com/46355364/207843761-799078ff-fa64-4d39-a6eb-ba01d250be69.png) @@ -464,12 +455,14 @@ openbb.keys.glassnode(key = 'REPLACE_WITH_KEY', persist = True)
-### IEX Cloud +### IEX Cloud (Apperate) + +> Apperate is a streaming data platform for finance with integrated IEX Cloud Data Bundles. We help developers skip the headaches of building with real-time data.
-Go to: https://iexcloud.io +Instructions -[IEX Cloud](https://iexcloud.io) +Go to: https://iexcloud.io ![IEX Cloud](https://user-images.githubusercontent.com/46355364/207833088-e879e9f2-3180-4e50-ba9e-f40ee958f98a.png) @@ -495,10 +488,12 @@ openbb.keys.iex(key = 'REPLACE_WITH_KEY', persist = True) ### Intrinio +> Intrinio is more than a financial data API provider – we're a real time data partner. That means we're your guide to every step of the financial data. +
-Go to: https://intrinio.com/starter-plan +Instructions -[Intrinio](https://intrinio.com/starter-plan) +Go to: https://intrinio.com/starter-plan ![Intrinio](https://user-images.githubusercontent.com/85772166/219207307-d6605460-ae2c-46d3-8b4e-f82057cfce59.png) @@ -512,10 +507,12 @@ openbb.keys.intrinio(key = 'REPLACE_WITH_KEY', persist = True) ### Messari +> Gain an edge over the crypto market with professional grade data, tools, and research. +
-Go to: https://messari.io +Instructions -[Messari](https://messari.io) +Go to: https://messari.io ![Messari](https://user-images.githubusercontent.com/46355364/207848122-ec6a41e4-76b7-4620-adc3-1f1c19f4bca6.png) @@ -537,10 +534,12 @@ openbb.keys.messari(key = 'REPLACE_WITH_KEY', persist = True) ### News API +> News API is a simple, easy-to-use REST API that returns JSON search results for current and historic news articles published by over 80,000 worldwide sources. +
-Go to: https://newsapi.org +Instructions -[News API](https://newsapi.org) +Go to: https://newsapi.org ![News API](https://user-images.githubusercontent.com/46355364/207828250-0c5bc38c-90b4-427d-a611-b43c98c8e7ab.png) @@ -562,10 +561,12 @@ openbb.keys.news(key = 'REPLACE_WITH_KEY', persist = True) ### Oanda +> OANDA's Currency Converter allows you to check the latest foreign exchange average bid/ask rates and convert all major world currencies. +
-Go to: https://developer.oanda.com +Instructions -[Oanda](https://developer.oanda.com) +Go to: https://developer.oanda.com ![Oanda](https://user-images.githubusercontent.com/46355364/207839324-d30aa2b6-be83-41ff-9b1b-146cac566789.png) @@ -588,10 +589,12 @@ openbb.keys.oanda( ### Polygon +> Live & historical data for US stocks for all 19 exchanges. Instant access to real-time and historical stock market data. +
-Go to: https://polygon.io +Instructions -[Polygon](https://polygon.io) +Go to: https://polygon.io ![Polygon](https://user-images.githubusercontent.com/46355364/207825623-fcd7f0a3-131a-4294-808c-754c13e38e2a.png) @@ -613,10 +616,10 @@ openbb.keys.polygon(key = 'REPLACE_WITH_KEY', persist = True) ### Quandl -
-Go to: https://www.quandl.com +> The premier source for financial, economic, and alternative datasets, serving investment professionals. Quandl’s platform is used by over 400,000 people, including analysts from the world’s top hedge funds, asset managers and investment banks. -[Quandl](https://www.quandl.com) +
+Instructions ![Quandl](https://user-images.githubusercontent.com/46355364/207823899-208a3952-f557-4b73-aee6-64ac00faedb7.png) @@ -638,10 +641,12 @@ openbb.keys.quandl(key = 'REPLACE_WITH_KEY', persist = True) ### Reddit +> Reddit is a network of communities where people can dive into their interests, hobbies and passions. +
-Sign in to Reddit, and then go to: https://old.reddit.com/prefs/apps/ +Instructions -[Reddit](https://old.reddit.com/prefs/apps/) +Sign in to Reddit, and then go to: https://old.reddit.com/prefs/apps/ ![Reddit](https://preview.redd.it/540vrn3k0cn91.png?width=986&format=png&auto=webp&v=enabled&s=88228cd0cf4415b3487b8d35e1097f0caa804e15) @@ -674,10 +679,12 @@ openbb.keys.reddit( ### Robinhood +> Robinhood has commission-free investing, and tools to help shape your financial future. +
-Go to: https://robinhood.com/us/en +Instructions -[Robinhood](https://robinhood.com/us/en) +Go to: https://robinhood.com/us/en ![Robinhood](https://user-images.githubusercontent.com/46355364/207838058-a2311632-6459-4cfd-bc0a-639ee3931574.png) @@ -696,10 +703,12 @@ The first login will request 2FA authorization from the device connected to the ### Santiment +> We provide tools to help you analyze crypto markets and find data-driven opportunities to optimize your investing. +
-Go to: https://app.santiment.net +Instructions -[Santiment](https://app.santiment.net) +Go to: https://app.santiment.net ![Santiment](https://user-images.githubusercontent.com/46355364/207849709-a5f10b03-138c-4e09-89f6-8a18cfbaf008.png) @@ -721,10 +730,12 @@ openbb.keys.santiment(key = 'REPLACE_WITH_KEY', persist = True) ### ShroomDK +> ShroomDK (SDK), by Flipside Crypto gives you programmatic query access to the most comprehensive blockchain data sets in Web3, for free. +
-Go to: https://sdk.flipsidecrypto.xyz/shroomdk +Instructions -[ShroomDK](https://sdk.flipsidecrypto.xyz/shroomdk) +Go to: https://sdk.flipsidecrypto.xyz/shroomdk ![ShroomDK](https://user-images.githubusercontent.com/46355364/207850122-b8cd225e-0a65-4ea8-8069-0b40fff1600e.png) @@ -746,10 +757,12 @@ openbb.keys.shroom(key = 'REPLACE_WITH_KEY', persist = True) ### Stocksera +> Empowering investors to take advantage of alternative data. We track trending tickers on social media and provide alternative data for easy due-diligence & analysis. +
-Go to: https://stocksera.pythonanywhere.com +Instructions -[Stocksera](https://stocksera.pythonanywhere.com) +Go to: https://stocksera.pythonanywhere.com ![Stocksera](https://user-images.githubusercontent.com/46355364/207853896-ee233569-26bb-4244-b115-43ac8885757a.png) @@ -771,10 +784,12 @@ openbb.keys.stocksera(key = 'REPLACE_WITH_KEY', persist = True) ### Token Terminal +> Token Terminal is a platform that aggregates financial data on the leading blockchains and decentralized applications. +
-Go to: https://tokenterminal.com +Instructions -[Token Terminal](https://tokenterminal.com) +Go to: https://tokenterminal.com ![Token Terminal](https://user-images.githubusercontent.com/46355364/207850735-69368b4f-6a3e-46b8-ba69-3b79d9231f15.png) @@ -796,10 +811,12 @@ openbb.keys.tokenterminal(key = 'REPLACE_WITH_KEY', persist = True) ### Tradier +> Tradier, the home of active traders. Our open collaboration platform allows investors to truly customize their trading experience like never before. +
-Go to: https://documentation.tradier.com +Instructions -[Tradier](https://documentation.tradier.com) +Go to: https://documentation.tradier.com ![Tradier](https://user-images.githubusercontent.com/46355364/207829178-a8bba770-f2ea-4480-b28e-efd81cf30980.png) @@ -813,6 +830,8 @@ openbb.keys.tradier(key = 'REPLACE_WITH_KEY', persist = True) ### Twitter +> From breaking news and entertainment to sports and politics, get the full story with all the live commentary. +
Upcoming changes to the Twitter API will deprecate the current functionality, it is uncertain if the features will continue to work. @@ -822,11 +841,12 @@ openbb.keys.tradier(key = 'REPLACE_WITH_KEY', persist = True) ### Whale Alert -
-Go to: https://docs.whale-alert.io +> Whale Alert continuously collects and analyzes billions of blockchain transactions and related-off chain data from hundreds of reliable sources and converts it into an easy to use standardized format. Our world-class analytics and custom high speed database solutions process transactions the moment they are made, resulting in the largest and most up-to-date blockchain dataset in the world. -[Whale Alert](https://docs.whale-alert.io) +
+Instructions +Go to: https://docs.whale-alert.io ![Whale Alert](https://user-images.githubusercontent.com/46355364/207842892-3f71ee7a-6cd3-48a2-82e4-fa5ec5b13807.png) Click on, "sign up here". diff --git a/website/content/sdk/guides/advanced/changing-sources.md b/website/content/sdk/guides/advanced/changing-sources.md index 415fb3e4d63a..ba1320fe6c71 100644 --- a/website/content/sdk/guides/advanced/changing-sources.md +++ b/website/content/sdk/guides/advanced/changing-sources.md @@ -1,6 +1,6 @@ --- title: Changing Sources -sidebar_position: 2 +sidebar_position: 3 description: Many commands have multiple datasources attached to it. A great example is /stocka/fa/income that allows you to select YahooFinance, Polygon, AlphaVantage, FinancialModelingPrep or EODHD. Many have a default source but you can change the default sources of each command via the sources menu. keywords: [source, sources, default source, datasources, api keys, api, keys, openbb sdk] --- diff --git a/website/content/sdk/guides/advanced/data.md b/website/content/sdk/guides/advanced/data.md index b1d276976187..1578d580e547 100644 --- a/website/content/sdk/guides/advanced/data.md +++ b/website/content/sdk/guides/advanced/data.md @@ -1,6 +1,6 @@ --- title: Importing and Exporting Data -sidebar_position: 3 +sidebar_position: 2 description: The OpenBBUserData folder's default location is the home of the system user account. By default this will be the following paths. Within the folder you can find files that you have exported as well as files that you wish to import directly into the OpenBB Terminal. For example, this could be an orderbook which you can store in OpenBBUserData/portfolio/holdings. keywords: [export, import, data, excel, xlsx, csv, json, png, pdf, jpg, openbbuserdata, where is data exported, market data, financial data, free, openbb sdk] --- diff --git a/website/content/sdk/quickstart/installation.md b/website/content/sdk/installation.md similarity index 51% rename from website/content/sdk/quickstart/installation.md rename to website/content/sdk/installation.md index 171163a40ef5..8d3631549e40 100644 --- a/website/content/sdk/quickstart/installation.md +++ b/website/content/sdk/installation.md @@ -4,48 +4,40 @@ sidebar_position: 2 description: The OpenBB SDK provides programmatic access to all Terminal functions. This layer of code allows users to build their own tools and applications on top of the existing architecture. Follow these steps to install on a local machine. keywords: [installation, installer, install, guide, mac, windows, linux, python, github, macos, how to, explanation, openbb, sdk, api, pip, pypi,] --- -The OpenBB SDK provides programmatic access to all Terminal functions. This layer of code allows users to build their own tools and applications on top of the existing architecture. Follow these steps to install on a local machine. +The OpenBB SDK provides programmatic access to all Terminal functions. This layer of code allows users to build their own tools and applications on top of the existing architecture. Follow these steps to install on a local machine. **If the OpenBB Terminal has already been installed in a virtual Python environment, no additional installations are required.** -:::note NOTE +
Minimum Requirements -- Make sure you meet all [requirements](requirements.md) before proceeding. -- If the OpenBB Terminal has already been installed in a virtual Python environment, no additional installations are required. +- Windows 10, +- Modern CPU (made in the last 5 years) +- At least 4GB of RAM +- At least 5GB of free storage +- Internet connection (cable or 4G mobile) -::: +
-## 1. System Preparation - -Prepare the system by installing the following items: - -### 1.1 Install Miniconda - -[Install Miniconda](https://docs.conda.io/en/latest/miniconda.html) +Before continuing with the installation process, make sure the following software is installed: +
Miniconda Miniconda is a Python environment and package manager. It is required for installing certain dependencies. -- Go [here](https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links) to find the download for your operating system or use the links below: - - - Apple-Silicon Systems: [Miniconda for MacOS](https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.pkg) - - Intel-based Mac Systems: [Miniconda for MacOS](https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh) - - Linux and WSL Systems: [Miniconda for Linux](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh) - - Raspberry PI Systems: [Miniconda for Raspberry PI](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-aarch64.sh) - - Windows Systems: [Miniconda for Windows](https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe) - - **NOTE for Apple Silicon Users:** Install Rosetta from the command line: `softwareupdate --install-rosetta` +Go [here](https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links) to find the download for your operating system or use the links below: - **NOTE for Windows users:** Install/update Microsoft C++ Build Tools from [here](https://visualstudio.microsoft.com/visual-cpp-build-tools/). +- Apple-Silicon Systems: [Miniconda for MacOS](https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.pkg) +- Intel-based Mac Systems: [Miniconda for MacOS](https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh) +- Linux and WSL Systems: [Miniconda for Linux](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh) +- Raspberry PI Systems: [Miniconda for Raspberry PI](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-aarch64.sh) +- Windows Systems: [Miniconda for Windows](https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe) -### 1.2 Install CMake -**CMake is required by several Python modules.** +**NOTE for Apple Silicon Users:** Install Rosetta from the command line: `softwareupdate --install-rosetta` -**For Windows:** +**NOTE for Windows users:** Install/update Microsoft C++ Build Tools from [here](https://visualstudio.microsoft.com/visual-cpp-build-tools/). +
-CMake is installed as a part of Microsoft C++ Build Tools. Skip ahead to the next step. +
CMake (Mac and Linux only) -**For MacOS:** - -Check if homebrew is installed by running `brew --version` +If you have a **MacBook**, check if homebrew is installed by running `brew --version` If Homebrew is not installed, run: @@ -62,20 +54,17 @@ brew install cmake brew install gcc ``` -**For Linux:** +If you have a **Linux** computer, use the following script: ```bash sudo apt update && sudo apt upgrade sudo apt install -y gcc cmake ``` +
-## 2. Create Python Environment - -The first step is to create the virtual Python environment. +## Create Python Environment -### 2.1 Confirm Conda Base - -When a terminal window is opened, if the base Conda environment - look for `(base)` to the left of the cursor on the command line - is not activated automatically, find the path for it by entering: +The first step is to create the virtual Python environment. When a terminal window is opened, if the base Conda environment - look for `(base)` to the left of the cursor on the command line - is not activated automatically, find the path for it by entering: ```console conda env list @@ -99,15 +88,13 @@ As of writing, the most recent version of `Conda` is, `23.1.0`. If required, upd conda install -c conda-forge -n base conda=23.1.0 ``` -### 2.2 Create the Environment - Create the environment by copying the code below into the command line: ```console conda create -n obb -c conda-forge python=3.10.9 pip pybind11 cmake git cvxpy lightgbm poetry ``` -### 2.3 Activate the Environment +## Activate the Environment After the packages from Step 2 install, activate the newly created environment by entering: @@ -115,9 +102,9 @@ After the packages from Step 2 install, activate the newly created environment b conda activate obb ``` -## 3. Install the OpenBB SDK +## Install the OpenBB SDK -### 3A. Install From PyPi +### Install From PyPi ```bash pip install "openbb[all]" @@ -135,23 +122,23 @@ The [OpenBB Terminal](https://docs.openbb.co/terminal) is part of the installati openbb ``` -### 3B. Install via Git Clone +### Install via Git Clone -#### 3B.1 Clone the Project +From your code editor or command line, browse to the location the OpenBB Terminal source code should live. Make sure you have completed the previous steps. -Cloning the GitHub repo will download the source code to the current working directory. +This starts by cloning the GitHub repository. This will download the source code to the current working directory. ```console git clone https://github.com/OpenBB-finance/OpenBBTerminal.git ``` -#### 3B.2 CD into OpenBBTerminal +Then, navigate to this folder. This can be done in command line or through the code editor by opening the folder. ```console cd OpenBBTerminal ``` -#### 3B.3 Install Remaining Packages +There are a few packages that required to be installed. This is done through Poetry, a package manager. ```bash pip install qdldl==0.1.5.post3 @@ -172,28 +159,13 @@ python terminal.py ## Updating the OpenBB SDK Version -Use the code below to check the version number of the OpenBB SDK. - -```python -from openbb_terminal.sdk import openbb -openbb.__version__ -``` - -Which prints a string similar to: `'2.4.1'` - -### A. Updating a PyPi Installation - -To upgrade the OpenBB SDK to the latest version, with the `obb` Python environment active, enter: +To upgrade the OpenBB SDK to the latest version via `pypi`, with the `obb` Python environment active, enter: ```console pip install -U openbb[all] ``` -### B. Updating a Git Clone Installation - -#### B.1 Fetch changes to the code - -With the `obb` Python environment activated, navigate into the root folder of the cloned project. Then, pull the changes from GitHub: +To update the OpenBB SDK via the Git Clone method with the `obb` Python environment activated, navigate into the root folder of the cloned project. Then, pull the changes from GitHub: ```console git fetch @@ -202,8 +174,6 @@ git pull **Note:** If working from a forked repo, the `git pull` command will need to be adjusted to pull from the desired branch, like `origin` or `upstream`. For example, `git pull origin main`; `git pull origin develop` -#### B.2 Run Poetry Install - Update any changes to the dependencies by running: ```console diff --git a/website/content/sdk/quickstart/_category_.json b/website/content/sdk/quickstart/_category_.json deleted file mode 100644 index 62073edce46c..000000000000 --- a/website/content/sdk/quickstart/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Getting Started", - "position": 2 -} diff --git a/website/content/sdk/quickstart/requirements.md b/website/content/sdk/quickstart/requirements.md deleted file mode 100644 index 501fa4f11542..000000000000 --- a/website/content/sdk/quickstart/requirements.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Requirements -sidebar_position: 1 -description: General system requirements for installing the OpenBB SDK. -keywords: [installation, installer, install, guide, mac, windows, linux, python, github, macos, how to, explanation, requirements, openbb, sdk, system] ---- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Installation of the OpenBB Terminal requires downloading around 4GB of data. Querying data (by running commands) does not require a lot of bandwidth but you will certainly have a more pleasant experience if you are on a fast internet connection. 4G networks provide a good enough experience so if you're traveling your personal hot-spot will do. While it's technically possible to use a subset of the functionality in off-line mode, you will not be able to use any data that is queried from the APIs of data providers and services. - -## Minimum System Requirements - -- A modern CPU compatible with the Intel Math Kernel Library, supporting SSE3 & SSE4.2 instructions. -- Windows 10 or higher. -- MacOS Monterey or higher, with Rosetta installed. -- Check the Ubuntu hardware certified hardware page [here](https://ubuntu.com/certified?q=&limit=20&category=Desktop&category=Laptop). -- 4GB RAM or more -- 5GB free storage -- Internet connection - -## Virtual Environments - -- [Miniconda3](https://docs.conda.io/en/latest/miniconda.html) -- [Installing Python Packages](https://packaging.python.org/en/latest/tutorials/installing-packages/) - -Virtual Python environments are containers for Python applications, and allows the operating system to remain unchanged. The OpenBB SDK is built on top of 300+ open-source libraries. The dependency tree is complex and the components are carefully selected to work with each other. This makes it critical to install the OpenBB SDK in an isolated, dedicated, virtual environment. We recommend a Conda virtual environment because this is currently the only package manager compatible with every function. - -It is not recommended to install in a Global environment, such as Homebrew or `usr/local/bin/python3`. Create and activate a new environment before installing the OpenBB SDK. - -## GitHub - -[GitHub](https://github.com/OpenBB-finance/OpenBBTerminal) is where the OpenBB source code is maintained. Cloning the [repository](https://github.com/OpenBB-finance/OpenBBTerminal.git) is recommended for those wishing to develop functions, inspect the source code, or be on the bleeding-edge of development. Syncing the local folder - `git pull` - to the main branch of the repository will keep the installation up-to-date, and `git checkout` provides a way to test development or contributor branches. GitHub can also be used as a personal storage vault and take advantage of automated actions. It's a great place to build, store, and maintain small databases for free. - -Users encountering bugs are encouraged to report them [here](https://github.com/OpenBB-finance/OpenBBTerminal/issues/new/choose) by creating a new issue, if no open issue for the bug already exists. diff --git a/website/content/sdk/reference/_category_.json b/website/content/sdk/reference/_category_.json index 0d35d5b83804..648a3250e1d6 100644 --- a/website/content/sdk/reference/_category_.json +++ b/website/content/sdk/reference/_category_.json @@ -1,4 +1,4 @@ { - "label": "SDK Reference", + "label": "Reference", "position": 4 } \ No newline at end of file diff --git a/website/content/terminal/quickstart/troubleshooting.md b/website/content/terminal/faq.md similarity index 99% rename from website/content/terminal/quickstart/troubleshooting.md rename to website/content/terminal/faq.md index 329b3c4d7eaf..33b4d0362296 100644 --- a/website/content/terminal/quickstart/troubleshooting.md +++ b/website/content/terminal/faq.md @@ -1,6 +1,6 @@ --- -title: Troubleshooting -sidebar_position: 4 +title: FAQ +sidebar_position: 5 keywords: [faq, questions, openbb, terminal, troubleshooting, errors, bugs, issues, problems, installation, contributors, developers, github, pip] --- Still experiencing trouble after consulting this page? Reach us on [Discord](https://openbb.co/discord) or visit our [contact page](https://openbb.co/contact). diff --git a/website/content/terminal/quickstart/api-keys.md b/website/content/terminal/guides/advanced/api-keys.md similarity index 99% rename from website/content/terminal/quickstart/api-keys.md rename to website/content/terminal/guides/advanced/api-keys.md index 63914277aa8e..9fe43ca2b5e3 100644 --- a/website/content/terminal/quickstart/api-keys.md +++ b/website/content/terminal/guides/advanced/api-keys.md @@ -1,6 +1,6 @@ --- title: Settings API Keys -sidebar_position: 3 +sidebar_position: 1 description: API (Application Programming Interface) keys are access credentials for accessing data from a particular source. They are a string of random characters assigned, by the data provider, to an individual account. Most vendors offer a free tier requiring only a valid email address. Each key is entered into the Terminal from the `/keys` menu, using the syntax described below. The `--help` dialogue for each source will also display the expected inputs. keywords: [api, keys, api keys, data provider, data, free, alpha vantage, fred, iex, twitter, degiro, binance, coinglass, polygon, intrinio, openbb terminal] --- @@ -125,7 +125,7 @@ Enter this API key into the OpenBB Terminal by typing:
Instructions -Go to: https://coinmarketcap.com/api< +Go to: https://coinmarketcap.com/api ![CoinMarketCap](https://user-images.githubusercontent.com/46355364/207831111-3f09ed75-740e-4121-a67e-6e1f36e8ab9a.png) @@ -171,7 +171,7 @@ Follow the instructions to obtain the credentials for the specific account. Ente
Instructions -Go to: https://www.coinglass.com/< +Go to: https://www.coinglass.com/ ![Coinglass](https://user-images.githubusercontent.com/46355364/207844601-8510687a-e54f-49b9-961f-5ef6718f58ab.png) @@ -261,7 +261,7 @@ Instructions for setting up 2FA authorization are [here](https://github.com/Chav
Instructions -Go to: https://eodhistoricaldata.com/r/?ref=869U7F4J< +Go to: https://eodhistoricaldata.com/r/?ref=869U7F4J ![EODHD](https://user-images.githubusercontent.com/46355364/207849214-23763c95-7314-42ae-b97d-cb5810686498.png) diff --git a/website/content/terminal/guides/advanced/changing-sources.md b/website/content/terminal/guides/advanced/changing-sources.md index d2f76b701952..45cf14c9346b 100644 --- a/website/content/terminal/guides/advanced/changing-sources.md +++ b/website/content/terminal/guides/advanced/changing-sources.md @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: 4 title: Changing Sources description: Many commands have multiple datasources attached to it. A great example is /stocka/fa/income that allows you to select YahooFinance, Polygon, AlphaVantage, FinancialModelingPrep or EODHD. Many have a default source but you can change the default sources of each command via the sources menu. keywords: [source, sources, default source, datasources, api keys, api, keys, openbb terminal] diff --git a/website/content/terminal/guides/advanced/customizing-the-terminal.md b/website/content/terminal/guides/advanced/customizing-the-terminal.md index 7afb074a3fb2..1486d920475a 100644 --- a/website/content/terminal/guides/advanced/customizing-the-terminal.md +++ b/website/content/terminal/guides/advanced/customizing-the-terminal.md @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 5 title: Customizing the Terminal description: To adjust the lay-out and settings of the OpenBB Terminal you can access the settings menu. This menu allows you to tweak how the terminal behaves. Next to that, to enable or disable certain functionalities of the terminal you can use the featflags menu. keywords: [settings, featflags, feature flags, lay-out, advanced, customizing, openbb terminal] diff --git a/website/content/terminal/guides/advanced/data.md b/website/content/terminal/guides/advanced/data.md index 6006d2295df7..d8645e57f622 100644 --- a/website/content/terminal/guides/advanced/data.md +++ b/website/content/terminal/guides/advanced/data.md @@ -1,6 +1,6 @@ --- title: Importing and Exporting Data -sidebar_position: 3 +sidebar_position: 2 description: The `OpenBBUserData` folder is where files are saved when they are created from within the OpenBB Terminal, like exports and generated reports. It is also where user-generated files are stored. keywords: [export, import, data, excel, xlsx, csv, json, png, pdf, jpg, openbbuserdata, terminal, user, data, presets, screener, portfolio, styles, themes] --- diff --git a/website/content/terminal/guides/advanced/scripts-and-routines.md b/website/content/terminal/guides/advanced/scripts-and-routines.md index 409e61565207..3a57f3d88931 100644 --- a/website/content/terminal/guides/advanced/scripts-and-routines.md +++ b/website/content/terminal/guides/advanced/scripts-and-routines.md @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 3 title: Scripts & Routines description: OpenBB Routine files, `.openbb`, are simple scripts for automating processes and repetitive tasks. They represent a 1:1 relationship with any command in the OpenBB Terminal; one line represents one function. A routine file can be created or modified in any basic text editor, the only difference between a plain-text file and an OpenBB Routine file is the `.openbb` file extension. Additionally, routine files can be captured with the macro recorder, controlled with global commands, `record` & `stop`. Upon `stop`, the script is automatically saved to the, `~/OpenBBUserData/routines/`, folder. Routine files stored there are callable from the main menu, using the `exe` function. By deploying variable arguments - `$ARGV[0]` - to any line in the script, dates, symbols, exported filenames, or any Terminal function argument, scripts become dynamic. keywords: [scripts, routines, .do file, stata, spss, r studio, python, automation, data collection, aggregation, script, routine, openbb terminal] diff --git a/website/content/terminal/guides/basics/index.md b/website/content/terminal/guides/basics/index.md index df9cd7ef0ce7..6344f7977dae 100644 --- a/website/content/terminal/guides/basics/index.md +++ b/website/content/terminal/guides/basics/index.md @@ -116,7 +116,7 @@ As mentioned in the Explanation of Menus, so The OpenBB Terminal is built on a lot of different data sources. The example above collects data from Yahoo Finance. This could be undesirable and therefore we allow for a variety of different data sources. Think of Polygon, IEX Cloud, Alpha Vantage and Binance to name a few. Some of these sources require you to set an API Key to connect with their data. :::note Setting API Keys -For an elaborate explanation of defining API keys to greatly extend the capabilities of the OpenBB Terminal, please have a look [**here**](/terminal/guides/basics/api-keys). +For an elaborate explanation of defining API keys to greatly extend the capabilities of the OpenBB Terminal, please have a look [**here**](/terminal/basics/advanced/api-keys). ::: This becomes apparent when you receive a message like the following: @@ -129,7 +129,7 @@ API_FINNHUB_KEY not defined. Set API Keys in ~/.openbb_terminal/.env or under ke We ensure that any source has a (usually extensive) free tier before we include the source. For example, you will be able to obtain 30+ years of fundamental data and query extensive economic databases by collecting just a few of the API keys. -The [keys menu](/terminal/guides/basics/api-keys) serves the purpose of providing you to set API keys so that this type of functionality becomes available. For example, in the case of `rot` you will see that the source is "FinnHub". +The [keys menu](/terminal/guides/advanced/api-keys) serves the purpose of providing you to set API keys so that this type of functionality becomes available. For example, in the case of `rot` you will see that the source is "FinnHub". ``` (🦋) /stocks/fa/ $ ? @@ -152,7 +152,7 @@ The [keys menu](/terminal/guides/basics/api-keys) serves the purpose of providin │ sust sustainability values (environment, social and governance) [YahooFinance] ``` -Therefore, you need to acquire an API key from FinnHub through the website and enter the key within the [keys menu](/terminal/basics/api-keys). +Therefore, you need to acquire an API key from FinnHub through the website and enter the key within the [keys menu](/terminal/advanced/api-keys). ### Importing and exporting data diff --git a/website/content/terminal/guides/intros/stocks/dark-pool-shorts.md b/website/content/terminal/guides/intros/stocks/dark-pool-shorts.md index c0c2fad08974..35b9e3b5bead 100644 --- a/website/content/terminal/guides/intros/stocks/dark-pool-shorts.md +++ b/website/content/terminal/guides/intros/stocks/dark-pool-shorts.md @@ -8,7 +8,7 @@ The purpose of this menu is to provide the user with tools for gauging the level image -To use every feature in the Dark Pools menu, an API key for Quandl must be obtained (for free) and authorized on the local installation. See the Setting API Keys Guide for help setting up the API keys in the OpenBB Terminal. The four commands at the bottom of the menu rely on a loaded ticker while the six above do not. +To use every feature in the Dark Pools menu, an API key for Quandl must be obtained (for free) and authorized on the local installation. See the Setting API Keys Guide for help setting up the API keys in the OpenBB Terminal. The four commands at the bottom of the menu rely on a loaded ticker while the six above do not. ### How to use diff --git a/website/content/terminal/guides/intros/stocks/options/index.md b/website/content/terminal/guides/intros/stocks/options/index.md index 23c37c72a904..c7b2726a2f0a 100644 --- a/website/content/terminal/guides/intros/stocks/options/index.md +++ b/website/content/terminal/guides/intros/stocks/options/index.md @@ -11,7 +11,7 @@ Navigate to the menu by typing `options`, from the `Stocks` menu, and then press image -By default, the Terminal loads a ticker using Tradier as the source. Sign up for a free developer account and then enter that token using the `Keys menu`. Alternatively, there is a choice to use yFinance data sets by attaching the argument as shown below. Help dialogues are displayed for any command by adding `-h` to the string. It is worth noting that this load command is different than the load command elsewhere. +By default, the Terminal loads a ticker using Tradier as the source. Sign up for a free developer account and then enter that token using the `Keys menu`. Alternatively, there is a choice to use yFinance data sets by attaching the argument as shown below. Help dialogues are displayed for any command by adding `-h` to the string. It is worth noting that this load command is different than the load command elsewhere. ```` (🦋) /stocks/options/ $ load -h diff --git a/website/content/terminal/quickstart/installation/docker.md b/website/content/terminal/installation/docker.md similarity index 100% rename from website/content/terminal/quickstart/installation/docker.md rename to website/content/terminal/installation/docker.md diff --git a/website/content/terminal/quickstart/installation/installation.md b/website/content/terminal/installation/installation.md similarity index 100% rename from website/content/terminal/quickstart/installation/installation.md rename to website/content/terminal/installation/installation.md diff --git a/website/content/terminal/quickstart/installation/macos.md b/website/content/terminal/installation/macos.md similarity index 100% rename from website/content/terminal/quickstart/installation/macos.md rename to website/content/terminal/installation/macos.md diff --git a/website/content/terminal/quickstart/installation/source.md b/website/content/terminal/installation/source.md similarity index 100% rename from website/content/terminal/quickstart/installation/source.md rename to website/content/terminal/installation/source.md diff --git a/website/content/terminal/quickstart/installation/windows.md b/website/content/terminal/installation/windows.md similarity index 98% rename from website/content/terminal/quickstart/installation/windows.md rename to website/content/terminal/installation/windows.md index 3a0d62aff589..fe5014fc5b33 100644 --- a/website/content/terminal/quickstart/installation/windows.md +++ b/website/content/terminal/installation/windows.md @@ -35,7 +35,7 @@ This section provides you with the installation file as well as the guide to ins
-Find a step by step guide below: +Step by step instructions: 1. Download the file by clicking on the button. 2. Open the downloaded `exe` file by double-clicking on it. diff --git a/website/content/terminal/quickstart/_category_.json b/website/content/terminal/quickstart/_category_.json deleted file mode 100644 index 62073edce46c..000000000000 --- a/website/content/terminal/quickstart/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Getting Started", - "position": 2 -} diff --git a/website/content/terminal/reference/_category_.json b/website/content/terminal/reference/_category_.json index bfb65b5a51f1..648a3250e1d6 100644 --- a/website/content/terminal/reference/_category_.json +++ b/website/content/terminal/reference/_category_.json @@ -1,4 +1,4 @@ { - "label": "Terminal Reference", + "label": "Reference", "position": 4 } \ No newline at end of file diff --git a/website/content/sdk/quickstart/pypi.md b/website/pypi.md similarity index 100% rename from website/content/sdk/quickstart/pypi.md rename to website/pypi.md From 37b9c32a02d889557ffc8bf83811f6c41cedca2b Mon Sep 17 00:00:00 2001 From: jeroen Date: Mon, 6 Mar 2023 22:13:42 +0100 Subject: [PATCH 16/21] Details --- website/content/terminal/installation/macos.md | 4 +--- website/content/terminal/installation/windows.md | 2 +- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/website/content/terminal/installation/macos.md b/website/content/terminal/installation/macos.md index 9f3aca45dcf5..59a6bf676140 100644 --- a/website/content/terminal/installation/macos.md +++ b/website/content/terminal/installation/macos.md @@ -28,9 +28,7 @@ Install the OpenBB Terminal on MacOS (Big Sur or later). There are two versions

-
Minimal Requirements - -Note that the minimal requirements are: +
Minimum Requirements - MacOS Monterey or newer - Modern CPU (Intel processor made in the last 5 years or Apple Silicon chip) diff --git a/website/content/terminal/installation/windows.md b/website/content/terminal/installation/windows.md index fe5014fc5b33..e349ba84a2d2 100644 --- a/website/content/terminal/installation/windows.md +++ b/website/content/terminal/installation/windows.md @@ -25,7 +25,7 @@ This section provides you with the installation file as well as the guide to ins -
Minimal Requirements +
Minimum Requirements - Windows 10 or newer - Modern CPU (Intel or AMD processor made in the last 5 years) From db013cf9fa012015f273596f7bbf30fa769b2c42 Mon Sep 17 00:00:00 2001 From: jose-donato Date: Tue, 7 Mar 2023 13:15:35 +0000 Subject: [PATCH 17/21] fix: mac issue and redirect installation --- .../terminal/installation/installation.md | 9 +- .../content/terminal/installation/macos.md | 16 ++-- .../General/TerminalInstallerRedirect.tsx | 83 +++++++++++++++++++ website/src/css/custom.css | 3 + website/src/theme/Tabs/index.js | 60 +------------- 5 files changed, 103 insertions(+), 68 deletions(-) create mode 100644 website/src/components/General/TerminalInstallerRedirect.tsx diff --git a/website/content/terminal/installation/installation.md b/website/content/terminal/installation/installation.md index e791d0290fa4..97c2d66ec6c8 100644 --- a/website/content/terminal/installation/installation.md +++ b/website/content/terminal/installation/installation.md @@ -19,12 +19,13 @@ keywords: openbb terminal, ] --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import InstallerButton from "@site/src/components/General/InstallerButton"; + +import TerminalInstallerRedirect from "@site/src/components/General/TerminalInstallerRedirect"; + + The OpenBB Terminal can be installed via a variety of ways. The most user-friendly approach is using the installer versions, you are able to find the installer version of Windows [here](installation/windows) and that of MacOS [here](installation/macos). Furthermore, for those that are used to Docker environments, there is support for Docker for Windows, MacOS and Linux as found [here](/terminal/quickstart/installation/docker). -The source code resides on GitHub and is written in Python. For those familiar with the usage of Python and Git and want access to development versions of the OpenBB Terminal, have a look [here](installation/source). \ No newline at end of file +The source code resides on GitHub and is written in Python. For those familiar with the usage of Python and Git and want access to development versions of the OpenBB Terminal, have a look [here](installation/source). diff --git a/website/content/terminal/installation/macos.md b/website/content/terminal/installation/macos.md index 59a6bf676140..751d47bf147b 100644 --- a/website/content/terminal/installation/macos.md +++ b/website/content/terminal/installation/macos.md @@ -19,14 +19,16 @@ keywords: openbb terminal, ] --- + import InstallerButton from "@site/src/components/General/InstallerButton"; -Install the OpenBB Terminal on MacOS (Big Sur or later). There are two versions of the installers available for MacOS, Intel-based and Apple Silicon (M1). +Install the OpenBB Terminal on MacOS (Big Sur or later). There are two versions of the installers available for MacOS, Intel-based and Apple Silicon (M1). -

+

-

- +
Minimum Requirements @@ -45,9 +47,11 @@ To understand whether you are using an Apple Sillicon (M1) device or an Intel-ba 1. Press ⌘ (Command) + SPACE to open spotlight search, and type `Terminal` and hit Return (⏎). 2. Copy and paste the following code in the Terminal and hit ENTER (⏎): + ```console softwareupdate --install-rosetta ``` + 3. This will start up the Rosetta installation process and you will receive a message regarding the Licence Agreement. Type `A` and hit Return (⏎). 4. After the installation process has finished, you can proceed to the "Mac M1 Installer" button. @@ -57,7 +61,7 @@ softwareupdate --install-rosetta Step by step instructions: 1. Download the DMG file from the links above. -2. Mount the downloaded DMG file by double-clicking on it. +2. Mount the downloaded DMG file by double-clicking on it. 3. Click and drag the OpenBB Terminal folder and hold it over the Applications shortcut. This opens a new Finder window, then drag the OpenBB Terminal folder into the Applications folder. ![MacOS Installation](https://user-images.githubusercontent.com/11668535/173027899-9b25ae4f-1eef-462c-9dc9-86086e9cf197.png) @@ -70,4 +74,4 @@ Step by step instructions: **Note:** During the first launch, a warning message may appear. Click, "Open". -

run_the_terminal

\ No newline at end of file +

run_the_terminal

diff --git a/website/src/components/General/TerminalInstallerRedirect.tsx b/website/src/components/General/TerminalInstallerRedirect.tsx new file mode 100644 index 000000000000..376d285716f2 --- /dev/null +++ b/website/src/components/General/TerminalInstallerRedirect.tsx @@ -0,0 +1,83 @@ +import ExecutionEnvironment from "@docusaurus/ExecutionEnvironment"; +import React from "react"; +import { useLocation } from "@docusaurus/router"; +import { useEffect } from "react"; + +function getOSName() { + const userAgent = ExecutionEnvironment.canUseDOM ? navigator.userAgent : ""; + if (userAgent.indexOf("Windows") > -1) { + return "Windows"; + } else if (userAgent.indexOf("Mac") > -1) { + return "Mac"; + } else if (userAgent.indexOf("X11") > -1) { + return "UNIX"; + } else if (userAgent.indexOf("Linux") > -1) { + return "Linux"; + } else { + return "Other"; + } +} + +export default function TerminalInstallerRedirect() { + const { pathname } = useLocation(); + if (ExecutionEnvironment.canUseDOM) { + useEffect(() => { + setTimeout(() => { + if (pathname === "/terminal/installation") { + const osName = getOSName(); + if (osName === "Windows") { + const windowsLink = document.querySelector( + 'a[href="/terminal/installation/windows"]' + ); + if (windowsLink && windowsLink instanceof HTMLElement) { + windowsLink.click(); + } + } else if (osName === "Mac") { + const macLink = document.querySelector( + 'a[href="/terminal/installation/mac"]' + ); + if (macLink && macLink instanceof HTMLElement) { + macLink.click(); + } + } else { + const linuxLink = document.querySelector( + 'a[href="/terminal/installation/source"]' + ); + if (linuxLink && linuxLink instanceof HTMLElement) { + linuxLink.click(); + } + } + } + }, 2000); + }, []); + } + + return ( +
+
+ + Redirecting + Operating system detected +
+ + You are being redirected to the installation page for your operating + system. + +
+ ); +} diff --git a/website/src/css/custom.css b/website/src/css/custom.css index 7beb761d86cb..b148854208dd 100644 --- a/website/src/css/custom.css +++ b/website/src/css/custom.css @@ -78,6 +78,9 @@ ._group-tab { @apply w-full flex mb-12; } + .card { + @apply w-full rounded-md border border-white p-9 shadow; + } } @import url("https://fonts.googleapis.com/css2?family=Fira+Code:wght@400;700&display=swap"); diff --git a/website/src/theme/Tabs/index.js b/website/src/theme/Tabs/index.js index 02b043cd5ae9..fbeb1e6e7c78 100644 --- a/website/src/theme/Tabs/index.js +++ b/website/src/theme/Tabs/index.js @@ -1,4 +1,4 @@ -import React, { cloneElement, useEffect } from "react"; +import React, { cloneElement } from "react"; import clsx from "clsx"; import { useScrollPositionBlocker, @@ -7,52 +7,12 @@ import { import useIsBrowser from "@docusaurus/useIsBrowser"; import styles from "./styles.module.css"; import { useLocation } from "@docusaurus/router"; -import ExecutionEnvironment from "@docusaurus/ExecutionEnvironment"; - -function getOSName() { - const userAgent = ExecutionEnvironment.canUseDOM ? navigator.userAgent : ""; - if (userAgent.indexOf("Windows") > -1) { - return "Windows"; - } else if (userAgent.indexOf("Mac") > -1) { - return "Mac"; - } else if (userAgent.indexOf("X11") > -1) { - return "UNIX"; - } else if (userAgent.indexOf("Linux") > -1) { - return "Linux"; - } else { - return "Other"; - } -} - -function getQueryVariable(query, variable) { - // substring query - const vars = query.substring(1).split("&"); - for (let i = 0; i < vars.length; i++) { - let pair = vars[i].split("="); - if (decodeURIComponent(pair[0]) == variable) { - return decodeURIComponent(pair[1]); - } - } - return null; -} - -function getInstallationTabType() { - const osName = getOSName(); - if (osName === "Windows") { - return "windows"; - } else if (osName === "Mac") { - return "mac"; - } else if (osName === "Linux" || osName === "UNIX") { - return "python"; - } - return "windows"; -} function TabList({ className, block, selectedValue, selectValue, tabValues }) { const tabRefs = []; const { blockElementScrollPositionUntilNextRender } = useScrollPositionBlocker(); - const { pathname, search } = useLocation(); + const { pathname } = useLocation(); const handleTabChange = (event) => { const newTab = event.currentTarget; @@ -64,22 +24,6 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) { } }; - if (ExecutionEnvironment.canUseDOM) { - useEffect(() => { - if (pathname.startsWith("/terminal/quickstart/installation")) { - const value = getQueryVariable(search, "tab"); - const osTabValue = getInstallationTabType(); - selectValue( - value - ? ["mac", "windows", "python", "docker"].includes(value) - ? value - : osTabValue - : osTabValue - ); - } - }, []); - } - const handleKeydown = (event) => { let focusElement = null; switch (event.key) { From 966e2f6d1f35c1573dd1d7cbdf9f73d25eddc317 Mon Sep 17 00:00:00 2001 From: jose-donato Date: Wed, 8 Mar 2023 10:42:19 +0000 Subject: [PATCH 18/21] fix: mac macos --- website/src/components/General/TerminalInstallerRedirect.tsx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/src/components/General/TerminalInstallerRedirect.tsx b/website/src/components/General/TerminalInstallerRedirect.tsx index 376d285716f2..5a77ea69afa0 100644 --- a/website/src/components/General/TerminalInstallerRedirect.tsx +++ b/website/src/components/General/TerminalInstallerRedirect.tsx @@ -34,14 +34,14 @@ export default function TerminalInstallerRedirect() { } } else if (osName === "Mac") { const macLink = document.querySelector( - 'a[href="/terminal/installation/mac"]' + 'a[href="/terminal/installation/macos"]' ); if (macLink && macLink instanceof HTMLElement) { macLink.click(); } } else { const linuxLink = document.querySelector( - 'a[href="/terminal/installation/source"]' + 'a[href="/terminal/installation/docker"]' ); if (linuxLink && linuxLink instanceof HTMLElement) { linuxLink.click(); From c66fea5ccb7397d7459b2a978843bb4d6b8626aa Mon Sep 17 00:00:00 2001 From: jeroen Date: Wed, 8 Mar 2023 14:47:23 +0100 Subject: [PATCH 19/21] Remove installation .md and make it dropdown --- .../terminal/installation/_category_.json | 4 +++ .../terminal/installation/installation.md | 31 ------------------- 2 files changed, 4 insertions(+), 31 deletions(-) create mode 100644 website/content/terminal/installation/_category_.json delete mode 100644 website/content/terminal/installation/installation.md diff --git a/website/content/terminal/installation/_category_.json b/website/content/terminal/installation/_category_.json new file mode 100644 index 000000000000..12e58396d042 --- /dev/null +++ b/website/content/terminal/installation/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Installation", + "position": 2 +} diff --git a/website/content/terminal/installation/installation.md b/website/content/terminal/installation/installation.md deleted file mode 100644 index 97c2d66ec6c8..000000000000 --- a/website/content/terminal/installation/installation.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Installation -sidebar_position: 2 -description: The OpenBB Terminal can be directly installed on a Mac or Windows machine via the installer packages below. While not available for Linux is currently available, it can be installed from the command line in a virtual Python environment. -keywords: - [ - installation, - installer, - install, - guide, - mac, - windows, - linux, - python, - github, - macos, - how to, - explanation, - openbb terminal, - ] ---- - -import TerminalInstallerRedirect from "@site/src/components/General/TerminalInstallerRedirect"; - - - -The OpenBB Terminal can be installed via a variety of ways. The most user-friendly approach is using the installer versions, you are able to find the installer version of Windows [here](installation/windows) and that of MacOS [here](installation/macos). - -Furthermore, for those that are used to Docker environments, there is support for Docker for Windows, MacOS and Linux as found [here](/terminal/quickstart/installation/docker). - -The source code resides on GitHub and is written in Python. For those familiar with the usage of Python and Git and want access to development versions of the OpenBB Terminal, have a look [here](installation/source). From 60beccf221725887cfb4d0cffcfef7890608ee22 Mon Sep 17 00:00:00 2001 From: jeroen Date: Wed, 8 Mar 2023 14:50:25 +0100 Subject: [PATCH 20/21] Update installation of SDK --- website/content/sdk/installation.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/website/content/sdk/installation.md b/website/content/sdk/installation.md index 8d3631549e40..d0d049c1ec3e 100644 --- a/website/content/sdk/installation.md +++ b/website/content/sdk/installation.md @@ -104,13 +104,17 @@ conda activate obb ## Install the OpenBB SDK +There are two methods to install the OpenBB SDK. The easiest way is to use PyPi as it requires a single command to be ran. If you would also be looking to make code edits, it can be benefifical to clone the repository. + ### Install From PyPi +Inside any terminal run the following: + ```bash pip install "openbb[all]" ``` -Done! The OpenBB SDK can now be imported to any Python session with the line of code below. +That's it! The OpenBB SDK can now be imported to any Python session with the line of code below. ```console from openbb_terminal.sdk import openbb From 25df9fd1043b2a795e4cf4f9f329569d463dc5ae Mon Sep 17 00:00:00 2001 From: jeroen Date: Wed, 8 Mar 2023 14:51:02 +0100 Subject: [PATCH 21/21] Grammar --- website/content/sdk/installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/sdk/installation.md b/website/content/sdk/installation.md index d0d049c1ec3e..4dfccc4bd134 100644 --- a/website/content/sdk/installation.md +++ b/website/content/sdk/installation.md @@ -104,7 +104,7 @@ conda activate obb ## Install the OpenBB SDK -There are two methods to install the OpenBB SDK. The easiest way is to use PyPi as it requires a single command to be ran. If you would also be looking to make code edits, it can be benefifical to clone the repository. +There are two methods to install the OpenBB SDK. The easiest way is to use PyPi as it requires a single command to be ran. If you would also be looking to make code edits, it can be beneficial to clone the repository. ### Install From PyPi