From 3ae7defb8fe106917313b141d468271c6df73cbd Mon Sep 17 00:00:00 2001 From: Zedris <32003202+Zedris@users.noreply.github.com> Date: Thu, 31 Mar 2022 01:16:22 +0100 Subject: [PATCH] Add Raspberry PI installation (#1562) * Update README.md I added a Raspbian (Raspberry Pi) installation section for the readme. this entire installation took had me nuking my installation about 10-15 times to figure it out so it worked:P Thanks for all the help Dangle!! * Fixing link Co-authored-by: didierlopes.eth Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com> Co-authored-by: Chavithra PARANA --- openbb_terminal/README.md | 94 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 94 insertions(+) diff --git a/openbb_terminal/README.md b/openbb_terminal/README.md index 4ff8355597b..176d9dbb7ed 100644 --- a/openbb_terminal/README.md +++ b/openbb_terminal/README.md @@ -8,6 +8,7 @@
  • Anaconda & Python Installation
  • Docker Installation
  • Docker Web UI Installation
    • +
  • Raspberry-Pi-Installation - Portable GST
  • API Keys
    • @@ -305,6 +306,99 @@ Set the API keys [as explained here](https://github.com/OpenBB-finance/OpenBBTer Once you've put the API keys in that file, re-run the launch script, and it will use your API keys. There are a few things that still don't work, and you can see what works and what doesn't [here](https://github.com/CoconutMacaroon/OpenBBTerminal/blob/main/openbb_terminal_web/README.md#todo). +### Local Installation of GST on Raspberry Pi + +1. Running raspbian lite(headless) or desktop (both 64bit) we should first start off with an update/upgrade. + + ```bash + sudo apt update && sydo apt upgrade + ``` + + Once completed reboot and lets reopen. + +2. [Install Miniforge](https://github.com/conda-forge/miniforge) The community version of anaconda/miniconda that has Arm support. + + - Follow the on screen prompts to install miniforge(conda). + + ```bash + wget https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Linux-aarch64.sh + ``` + + - After following the steps, confirm that you have it by opening a terminal and running: `conda -V`. The output should be something along the lines of: `conda 4.9.2` + +3. Install git + + ```bash + conda install -c anaconda git + ``` + +4. Install Cmake + + ```bash + sudo apt update + sudo apt install -y cmake + pip install cmake + ``` + +5. Clone the Project + + - Via HTTPS: `git clone https://github.com/GamestonkTerminal/GamestonkTerminal.git` + - via SSH: `git clone git@github.com:GamestonkTerminal/GamestonkTerminal.git` + +6. Navigate into the project's folder + + ```bash + cd GamestonkTerminal/ + ``` + +7. Create Environment + + You can name the environment whatever you want. Although you could use names such as: `welikethestock`, `thisistheway` + or `diamondhands`, we recommend something simple and intuitive like `gst`. This is because this name will be used + from now onwards. + + ```bash + conda env create -n gst python=3.9 + ``` + +8. Activate the virtual environment + + ```bash + conda activate gst + ``` + + Note: At the end, you can deactivate it with: `conda deactivate`. + +9. Update all poetry dependencies + + ```bash + poetry update --lock + ``` + + Note: This is done to solve any issues with poetry dependencies for the arm architecture of the rpi + +10. Install using our updated poetry installation + + ```bash + poetry install + ``` + +11. You're ready to Gamestonk it on a Raspbery Pi! + + ```bash + python terminal.py + ``` + + Note: For a headless installation using raspbian lite also follow the Jupyter Lab installation + +12. Jupyter Lab (Optional. Early alpha). User the Terminal from Jupyter Lab + + You can install Jupyter Lab extensions that help you manage settings and launch the terminal in a JL bash console + using the commands in the [jupyterlab/README.md](jupyterlab/README.md) + +**NOTE:** When you close the terminal and re-open it, the only command you need to re-call is `conda activate gst` +before you call `python terminal.py` again. + ### API Keys The project is build around several different API calls, whether it is to access historical data or financials.