Feature/plots backend

.github/workflows/unit-test.yml

@@ -79,6 +79,28 @@ jobs:
           virtualenvs-create: true
           virtualenvs-in-project: true
 
+      - name: Install nightly rust
+        run: curl --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain nightly
+
+      - name: Setup sudo apt installs for ubuntu-latest
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+              build-essential \
+              libgtk-3-dev \
+              libsoup-3.0-dev \
+              libssl-dev \
+              curl \
+              wget \
+              squashfs-tools \
+              gcc \
+              g++ \
+              make \
+              file \
+              librsvg2-dev \
+              libwebkit2gtk-4.1-dev \
+              libayatana-appindicator3-dev
+
       - name: Load cached venv
         id: cached-poetry-dependencies
         uses: actions/cache@v3
@@ -131,6 +153,25 @@ jobs:
           virtualenvs-create: true
           virtualenvs-in-project: true
 
+      - name: Setup sudo apt installs for ubuntu-latest
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+              build-essential \
+              libgtk-3-dev \
+              libsoup-3.0-dev \
+              libssl-dev \
+              curl \
+              wget \
+              squashfs-tools \
+              gcc \
+              g++ \
+              make \
+              file \
+              librsvg2-dev \
+              libwebkit2gtk-4.1-dev \
+              libayatana-appindicator3-dev
+
       - name: Load cached venv
         id: cached-poetry-dependencies
         uses: actions/cache@v3

.gitignore

@@ -39,6 +39,9 @@ website/functions
 *_sdk_audit.csv
 website/terminaltest
 !build/docker/compose.env
+openbb_terminal/core/plots/assets/plotly*.js
+openbb_terminal/core/plots/plotly_temp.html
+openbb_terminal/core/plots/table_temp.html
 .dccache
 
 # pyinstaller artifacts

CONTRIBUTING.md

@@ -761,16 +761,14 @@ def display_data(..., export: str = "", ...):
     export_data(export, os.path.dirname(os.path.abspath(__file__)), "func", data)
 ```
 
-List of external axes to include in a plot : `external_axes` *(Optional[List[plt.Axes]])*
+Whether to display plot or return figure *(False: display, True: return)* : `external_axes` *(bool)*
 
 ```python
-def display_data(..., external_axes: Optional[List[plt.Axes]] = None, ...):
+def display_data(..., external_axes: bool = False, ...):
     ...
-    if external_axes is None:
-        _, ax = plt.subplots(figsize=plot_autoscale(), dpi=PLOT_DPI)
-    else:
-        ax = external_axes[0]
-    ax.plot(...)
+    fig = OpenBBFigure()
+    fig.add_scatter(...)
+    return fig.show(external=external_axes)
 ```
 
 Field by which to sort : `sortby` *(str), e.g. "Volume"*
@@ -1218,7 +1216,8 @@ In the `_view.py` files it is common having at the end of each function `export_
         export,
         os.path.dirname(os.path.abspath(__file__)),
         "contracts",
-        df_contracts
+        df_contracts,
+        figure=fig_contracts,
     )
 ```
 
@@ -1227,12 +1226,13 @@ Let's go into each of these arguments:
 - `export` corresponds to the type of file we are exporting.
   - If the user doesn't has anything selected, then this function doesn't do anything.
   - The user can export multiple files and even name the files.
-  - The allowed type of files `json,csv,xlsx` for raw data and `jpg,png,svg` for figures depends on the `export_allowed` variable defined in `parse_known_args_and_warn`.
+  - The allowed type of files `json,csv,xlsx` for raw data and `jpg,pdf,png,svg` for figures depends on the `export_allowed` variable defined in `parse_known_args_and_warn`.
 - `os.path.dirname(os.path.abspath(__file__))` corresponds to the directory path
   - This is important when `export folder` selected is the default because the data gets stored based on where it is called.
   - If this is called from a `common` folder, we can use `os.path.dirname(os.path.abspath(__file__)).replace("common", "stocks")` insteaad
 - `"contracts"` corresponds to the name of the exported file (+ unique datetime) if the user doesn't provide one
-- `df_contracts` corresponds to the dataframe with data. Although we don't call this function with the figure reference, because it is open, we can use `plt.savefig` to achieve that.
+- `df_contracts` corresponds to the dataframe with data.
+- `figure=fig_contracts` corresponds to the figure to be exported as an image or pdf.
 
 If `export_allowed=EXPORT_BOTH_RAW_DATA_AND_FIGURES` in `parse_known_args_and_warn`, valid examples are:
 

build/docker/openbb.dockerfile

@@ -25,6 +25,12 @@ RUN apt-get -y install --no-install-recommends \
     libxt6 \
     libgl1-mesa-glx \
     libpng16-16 \
+    libwebkit2gtk-4.0-dev \
+    build-essential \
+    libssl-dev \
+    libgtk-3-dev \
+    libayatana-appindicator3-dev \
+    librsvg2-dev \
     ffmpeg \
     python3-tk
 
@@ -38,8 +44,12 @@ WORKDIR /home/python
 # SETUP POETRY IMAGE
 FROM debian as poetry
 
+RUN curl https://sh.rustup.rs -sSf | sh -s -- -y --default-toolchain nightly
+
+ENV PATH="/home/python/.cargo/bin:${PATH}"
 ENV PATH="/home/python/.local/bin:${PATH}"
 
+RUN /bin/bash -c "source $HOME/.cargo/env"
 RUN pip install --upgrade pip wheel
 RUN pip install poetry==1.3.2
 

build/pyinstaller/build4mac.sh

@@ -24,6 +24,8 @@ mkdir DMG
 cp -r build/pyinstaller/macOS_package_assets/* DMG/
 mv dist/OpenBBTerminal DMG/"$DISK_IMAGE_NAME"/.OpenBB
 
+osascript build/pyinstaller/setup_icons_post.applescript
+
 # Create a DMG with create-dmg
 #
 # NOTE:

build/pyinstaller/setup_icons_post.applescript

@@ -0,0 +1,20 @@
+use framework "Foundation"
+use framework "AppKit"
+use scripting additions
+
+-- Get script location
+tell application "Finder"
+    set current_path to POSIX path of (container of (path to me) as alias)
+end tell
+
+-- Set OpenBB Terminal launcher icon in folder relative to script location
+set sourcePath to current_path & "../../images/openbb.icns"
+set destPath to current_path & "../../DMG/OpenBB Terminal/.OpenBB/OpenBBTerminal"
+set imageData to (current application's NSImage's alloc()'s initWithContentsOfFile:sourcePath)
+(current application's NSWorkspace's sharedWorkspace()'s setIcon:imageData forFile:destPath options:2)
+
+-- Set OpenBB OpenBBPlotsBackend icon relative to script location
+set sourcePath to current_path & "../../images/openbb.icns"
+set destPath to current_path & "../../DMG/OpenBB Terminal/.OpenBB/OpenBBPlotsBackend"
+set imageData to (current application's NSImage's alloc()'s initWithContentsOfFile:sourcePath)
+(current application's NSWorkspace's sharedWorkspace()'s setIcon:imageData forFile:destPath options:2)

build/pyinstaller/terminal.spec

@@ -1,5 +1,6 @@
-# -*- mode: python ; coding: utf-8 -*-
+# -*- mode: python ; coding: utf-8 -*-  # noqa
 import os
+import shutil
 import subprocess
 import sys
 from pathlib import Path
@@ -56,6 +57,10 @@ set_key(default_env_file, "OPENBB_LOGGING_COMMIT_HASH", str(commit_hash))
 # Files that are explicitly pulled into the bundle
 added_files = [
     (os.path.join(os.getcwd(), "openbb_terminal"), "openbb_terminal"),
+    (
+        os.path.join(os.getcwd(), "openbb_terminal", "core", "plots"),
+        "openbb_terminal/core/plots",
+    ),
     (os.path.join(pathex, "property_cached"), "property_cached"),
     (os.path.join(pathex, "user_agent"), "user_agent"),
     (os.path.join(pathex, "vaderSentiment"), "vaderSentiment"),
@@ -77,7 +82,11 @@ added_files = [
     (".env", "."),
     (os.path.join(pathex, "blib2to3", "Grammar.txt"), "blib2to3"),
     (os.path.join(pathex, "blib2to3", "PatternGrammar.txt"), "blib2to3"),
+    (shutil.which("voila"), "."),
+    (shutil.which("jupyter-lab"), "."),
+    (shutil.which("streamlit"), "."),
 ]
+
 if is_win:
     added_files.extend(
         [
@@ -108,6 +117,7 @@ hidden_imports = [
     "_sysconfigdata__darwin_darwin",
     "prophet",
     "debugpy",
+    "pywry.pywry",
     "scipy.sparse.linalg._isolve._iterative",
     "whisper",
     "transformers",
@@ -138,6 +148,53 @@ analysis_kwargs = dict(
 a = Analysis(**analysis_kwargs)
 pyz = PYZ(a.pure, a.zipped_data, cipher=analysis_kwargs["cipher"])
 
+# Executable icon
+if is_win:
+    exe_icon = (os.path.join(os.getcwd(), "images", "openbb_icon.ico"),)
+if is_darwin:
+    exe_icon = (os.path.join(os.getcwd(), "images", "openbb.icns"),)
+
+block_cipher = None
+# PyWry
+pywry_a = Analysis(
+    [os.path.join(pathex, "pywry", "backend.py")],
+    pathex=[],
+    binaries=[],
+    datas=[],
+    hiddenimports=[],
+    hookspath=[],
+    hooksconfig={},
+    runtime_hooks=[],
+    excludes=[],
+    win_no_prefer_redirects=False,
+    win_private_assemblies=False,
+    cipher=block_cipher,
+    noarchive=False,
+)
+pywry_pyz = PYZ(pywry_a.pure, pywry_a.zipped_data, cipher=block_cipher)
+
+
+# PyWry EXE
+pywry_exe = EXE(
+    pywry_pyz,
+    pywry_a.scripts,
+    [],
+    exclude_binaries=True,
+    name="OpenBBPlotsBackend",
+    debug=False,
+    bootloader_ignore_signals=False,
+    strip=False,
+    upx=True,
+    upx_exclude=[],
+    console=True,
+    disable_windowed_traceback=False,
+    target_arch="x86_64",
+    codesign_identity=None,
+    entitlements_file=None,
+    icon=exe_icon,
+)
+
+
 exe_args = [
     pyz,
     a.scripts,
@@ -156,6 +213,7 @@ exe_kwargs = dict(
     target_arch="x86_64",
     codesign_identity=None,
     entitlements_file=None,
+    icon=exe_icon,
 )
 
 
@@ -189,12 +247,16 @@ if is_win:
         text_color="white",
     )
     exe_args += [splash, splash.binaries]
-    exe_kwargs["icon"] = (os.path.join(os.getcwd(), "images", "openbb_icon.ico"),)
 
-if is_darwin:
-    exe_kwargs["icon"] = (os.path.join(os.getcwd(), "images", "openbb.icns"),)
 
 exe = EXE(*exe_args, **exe_kwargs)
+pywry_collect_args = [
+    pywry_a.binaries,
+    pywry_a.zipfiles,
+    pywry_a.datas,
+]
 
 if build_type == "folder":
-    coll = COLLECT(*([exe] + collect_args), **collect_kwargs)
+    coll = COLLECT(
+        *([exe] + collect_args + [pywry_exe] + pywry_collect_args), **collect_kwargs
+    )

openbb_terminal/__init__.py

@@ -1,2 +1,13 @@
 # flake8: noqa
-from . import common, cryptocurrency, economy, etf, forex, portfolio, reports, stocks
+from . import (
+    common,
+    cryptocurrency,
+    economy,
+    etf,
+    forex,
+    portfolio,
+    reports,
+    stocks,
+    fixedincome,
+)
+from .core.plots.plotly_helper import OpenBBFigure, plots_backend, theme, TerminalStyle