Skip to content

README.md

Latest commit

 

History

History
79 lines (50 loc) · 2.41 KB

README.md

File metadata and controls

79 lines (50 loc) · 2.41 KB
Raw

prototype_gui2cell

Github Actions Status

TO DO.

Requirements

  • JupyterLab >= 4.0.0

Install

Please follow the development install instructions.

Contributing

Development install

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

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

# Set up a virtual environment and install package in development mode
uv sync

#install as development extension
jupyter labextension develop . --overwrite

# Rebuild extension Typescript source after making changes
# IMPORTANT: Unlike the steps above which are performed only once, do this step
# every time you make a change.
uv run jlpm build

# Try it in JupyterLab
uv run jupyter lab test.ipynb

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:

jupyter lab build --minimize=False

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