jupyterlab_wall

A JupyterLab extension to alert users of system events.

This extension is composed of a Python package named jupyterlab_wall for the server extension and a NPM package named jupyterlab-wall for the frontend extension.

Requirements

• JupyterLab >= 4 < 5

Install

pip install jupyterlab_wall

You will also need to define a set of alerts that should trigger, see 'jupyter_jupyterlab_wall_config.py' for examples. This config needs to be incorporated into your jupyter_server_config.py from one of the jupyter config paths to take effect. You can define a new jupyter_server_config.py with the contents of 'jupyter_jupyterlab_wall_config.py'.

You can see all the jupyter paths with:

jupyter --paths

As an example, you could copy the example alerts into your ${HOME}/.jupyter/ directory.

cp ./jupyter_jupyterlab_wall_config.py ${HOME}/.jupyter/jupyter_server_config.py

OR, append the example alerts to an existing file.

cat ./jupyter_jupyterlab_wall_config.py >> ${HOME}/.jupyter/jupyter_server_config.py

Troubleshoot

If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:

jupyter server extension list

If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:

jupyter labextension list

You can check to see what the current alerts config is:

jupyter server --show-config

If there are no alerts confined, a test_alert is defined internally that you can use to verify that the extension is working. You can create the file '/tmp/alert_test', which will trigger an alert in jupyterlab if the extension is working correctly.

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the jupyterlab_wall directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Uninstall

pip uninstall jupyterlab_wall

Testing

Python Tests

This extension uses pytest for Python tests. To run the tests, install the test dependencies and run pytest:

pip install pytest pytest-cov pytest-jupyter
python -m pytest --cov=jupyterlab_wall jupyterlab_wall/tests

JS Unit Tests

This extension uses jest for JavaScript/TypeScript unit tests. To run the tests:

jlpm test

Unit tests are located in the tests/ directory.

UI Tests

UI tests are powered by Playwright and Galata. To run them:

cd ui-tests
jlpm install
jlpm playwright install
jlpm test

These tests are automatically run in the GitHub Actions CI workflow on every push and pull request.