tenant_data_browser

A JupyterLab extension for browsing file/data trees in KBase CDM JupyterLab.

Requirements

• JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install tenant_data_browser

Uninstall

To remove the extension, execute:

pip uninstall tenant_data_browser

Contributing

Development install

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

# Clone the repo to your local environment
# Change directory to the tenant_data_browser directory
# Install Python dependencies and create virtual environment
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

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
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).

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

uv run jupyter lab build --minimize=False

Development uninstall

pip uninstall tenant_data_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 tenant-data-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