berdl_task_browser

A JupyterLab extension for browsing CTS data

Requirements

• JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install berdl_task_browser

Uninstall

To remove the extension, execute:

pip uninstall berdl_task_browser

Contributing

Development install

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

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab.

# Clone the repo to your local environment
# Change directory to the berdl_task_browser directory

# Install dependencies with uv
uv sync

# Link your development version of the extension with JupyterLab
uv run jupyter labextension develop . --overwrite

# Rebuild extension Typescript source after making changes
uv run jlpm build

Running for development

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
uv run jlpm watch

# Run JupyterLab in another terminal
KBASE_AUTH_TOKEN=your-token \
CDM_TASK_SERVICE_URL=https://ci.kbase.us/services/cts \
uv run 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).

Environment variables

Variable	Description
KBASE_AUTH_TOKEN	Auth token for CTS API (required for real API)
CDM_TASK_SERVICE_URL	CTS API endpoint (defaults to CI)
CTS_MOCK_MODE	Set to true to enable mock mode

Mock mode

For development without a real CTS API, enable mock mode:

CTS_MOCK_MODE=true uv run jupyter lab

Mock mode uses MSW (Mock Service Worker) to intercept API requests and return test data.

CORS proxy (alternative)

If you need to test against the real CTS API from localhost:

uv run python scripts/cts_proxy.py

This starts a CORS-enabled proxy on localhost:8080.

Source maps

By default, jlpm build generates 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:

jupyter lab build --minimize=False

Development uninstall

uv pip uninstall berdl_task_browser

In development mode, you will also need to remove the symlink created by jupyter labextension develop command. To find its location, you can run jupyter labextension list to figure out where the labextensions folder is located. Then you can remove the symlink named berdl-task-browser within that folder.

Testing the extension

Frontend tests

This extension is using Jest for JavaScript code testing.

To execute them, execute:

uv run jlpm
uv run jlpm test

Integration tests

This extension uses Playwright for the integration tests (aka user level tests). More precisely, the JupyterLab helper Galata is used to handle testing the extension in JupyterLab.

More information are provided within the ui-tests README.

Packaging the extension

See RELEASE