Tutorial on Extension Development

1. Create a conda environment (if not already exist) and sos dependencies

Install NodeJS, JupyterLab, etc. in a conda environment

conda create -n jupyterlab-ext --override-channels --strict-channel-priority -c conda-forge \
    -c nodefaults jupyterlab=4 nodejs=20 git copier=7 jinja2-time
conda activate jupyterlab-ext

pip install sos-notebook
python -m sos_notebook.install

2. Git clone jupyterlab-sos

If developing codemirror-sos or transient-display-message, run yarn link in their respective directories, and run command like

yarn link codemirror-sos

to link their directories to node_modules.

3. Build

install dependencies, also avoids an error with running pip install -ve . directly

yarn install

Build an install the extension

pip install -ve .

Create a symbolic link from JupyterLab to our directory.

jupyter labextension develop --overwrite .

Releae

rm -rf jupyterlab_sos dist lib
git co jupyterlab_sos/__init__.py

python -m build
python -m twine upload dist/*