jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-27 04:31:13 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
6d2ad33e110650710919b992ae837631368f290a
OpenBB/jupyterlab/README.md
jmaslek b71abcfbf4 Updating some names (#1575) 
* quick econ fix

* black

* keys and feature flags

* terminal name 👀

* some more replacements

* some more replacements

* edit pyproject

* gst -> openbb

* add example portfolios back to git

* Update api from gst

* sorry.  skipping some tests

* another round of names

* another round of test edits

* Missed some .gst refs and update timezone

* water mark stuff

* Fixing Names in terminal.spec and name of GTFF_DEFAULTS to OBBFF_DEFAULTS

* fix more GST to OpenBB Terminal

* Logging : merge conflicts with main

* Revert wrong files

Co-authored-by: Andrew <andrew.kenreich@gmail.com>
Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
2022-03-29 09:46:26 -04:00

1.5 KiB
Vendored
Raw Blame History

Jupyter Ecosystem integration

The Jupyter ecosystem has created Open Source tools that have become the de-facto standard for data related tasks.

This folder contains source code for a bunch of tools that help using the functionality of the terminal in connection with Jupyter:

  1. Jupyter Lab Extensions for using OpenBB Terminal

1. Jupyter Lab Extensions for using OpenBB Terminal

Documentation, GST and GST-settings are 3 Jupyter Lab extensions that illustrate how the terminal can be integrated with Jupyter Lab based IDEs.

NOTE: The extensions should be considered prototypes and are not production-ready.

  1. Only bash is supported (only macOS, Linux and WSL). No support for Windows powershell or command prompt.
  2. The input values are not escaped

Installation

To install the Terminal Launcher and the Settings Extensions run the following commands from the root folder of the project:

pip install jupyterlab/gst
pip install jupyterlab/gst-settings
pip install jupyterlab/documentation
jupyter labextension install jupyterlab/gst
jupyter labextension install jupyterlab/gst-settings
jupyter labextension install jupyterlab/documentation

Development setup

In this section gst extension will be used as an example.

  • In one terminal window cd into the launcher extension folder and build the extension:
cd gst
jlpm
pip install -e .
jlpm run build
jupyter labextension develop . --overwrite
jlpm run watch
  • In the second tab run jupyter lab
jupyter lab