JupyterLab Form

An extension for jupyterlab to create scripted forms.

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

I personally use Ubuntu and install node and npm via nvm (https://github.com/creationix/nvm), python3 with pyenv (https://github.com/pyenv/pyenv), and jupyterlab simply via pip as so:

pip install jupyterlab

Installation

Once you have those requirements download and install jupyrerlab-forms by running the following:

git clone https://github.com/SimonBiggs/jupyterlab-form
cd jupyterlab-form
npm install
jupyter labextension install
jupyter lab

Then within the launcher tab press the Form button.

Development suggestions

The following code snippets are intended to be run within the jupyterlab-form directory.

Once off dev set up

To link the package to jupyterlab so that changes to the form 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)