0.9.1 • Published 6 years ago

@o.calvo/reports v0.9.1

Weekly downloads
1
License
AGPL-3.0
Repository
-
Last release
6 years ago

Custom Reports Jupyter Extension

An extension for jupyterlab to launch custom report py files.

Requirements

Aquire Python3, JupyterLab, Node, npm, and git.

One way to get these, which is simple and platform independent, is to download miniconda from https://conda.io/miniconda.html, install it, and then run the following:

conda install nodejs jupyterlab git -c conda-forge

Installation

Once you have those requirements download and install @o.calvo/reports by running the following:

git clone https://gitlab.financialcad.com/o.calvo/jupyterlab-extension-reports.git
cd jupyterlab-extension-reports
npm install
jupyter labextension install
jupyter lab

Then within the launcher tab press any button in the new Reports category.

Development suggestions

An error shows everytime a form is selected. It is not clear to me what is currently causing it.

Once off dev set up

To link the package to jupyterlab so that changes to the reports extension are built with code changes run the following:

jupyter labextension link

Verify the link by running

jupyter labextension list

Run each development session

To have the extension auto compile the typescript when changes are made run the following:

npm run watch

Then to have jupyterlab automatically update whenever changes are detected run jupyterlab in watch mode in a directory of your choosing:

jupyter lab --watch

Environment suggestions

To work on the typescript code base I highly recommend https://code.visualstudio.com/.

I also recommend the following extensions:

  • Git Lens (Eric Amodio)
  • Angular Essentials (by John Papa)