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
4b8a82f3ae657ceadc87435ea65127e4df3d9dc7
OpenBB/jupyterlab/README.md
Theodore Aptekarev 4b8a82f3ae Introduce Jupyter Lab extensions (#718) 
* Add folder for Jupyter Lab extensions

* Add initial settings menu extension code

* Add initial terminal launcher extension code

* Add lab extension build files to ignore

* Update settings form sections to be populated from a loop

* Update terminal launcher

* Add script load env from settings

* Update settings schema

* Update settings forms to handle nested schema

* Satisfy eslint

* Lint python code black

* Remove unused python API

* Satisfy eslint

* Update extension icons

* Update terminal launcher menu commands

* Update settings infrastructure for both extensions

* Update docstrings

* Lint python code black

* Lint more python code black

* Add structure for website

* Update labels.yml

* Update the settings form population with user settings

* Add node_modules of the test folder to gitignore

* Add UI tests for the settings extension

* WIP: Update terminal launcher extension code and wip settings

* Add development setup documentation

* Pass settings to environment variables in the launcher

* Update settings extension schema to include custom python path

* Satisfy eslint and flake8

* Add setup.py to mypy exclude paths
The setup.py that goes with the jupyterlab extensions fails the mypy
check and excluding them is the only workaround atm

* Check mypy hook

* Fix linting error raised by pyupgrade

* Change setting name to be different from a system variable

* Update launcher to set env variables with bash stdin

* Clean up unused scripts

* Make jupyterlab mandatory in poetry

* Add Jupyter Lab extension installation docs

Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
Co-authored-by: didier <dro.lopes@campus.fct.unl.pt>
2021-09-09 21:34:04 -07:00

882 B
Vendored
Raw Blame History

Jupyter Lab Extensions for using Gamestonk Terminal

  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 -e jupyterlab/gst
pip install -e jupyterlab/gst-settings
jupyter labextension install jupyterlab/gst
jupyter labextension install jupyterlab/gst-settings

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