jupyter_theme_editor — jupyterlab-contrib 1.0.0 documentation (original) (raw)

GitHub Repo starsGithub Actions StatusBinder

A theme editor for JupyterLab.

This extension is composed of a Python package named jupyter_theme_editorfor the server extension and a NPM package named jupyter-theme-editorfor the frontend extension.

Requirements

Install

To install the extension, execute:

pip install jupyter_theme_editor

Uninstall

To remove the extension, execute:

pip uninstall jupyter_theme_editor

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

Contributing

Development install

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

The jlpm command is JupyterLab’s pinned version ofyarn that is installed with JupyterLab. You may useyarn or npm in lieu of jlpm below.

Clone the repo to your local environment

Change directory to the jupyter_theme_editor directory

Install package in development mode

pip install -e ".[test]"

Link your development version of the extension with JupyterLab

jupyter labextension develop . --overwrite

Server extension must be manually installed in develop mode

jupyter server extension enable jupyter_theme_editor

Rebuild extension Typescript source after making changes

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

jlpm 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 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

Development uninstall

Server extension must be manually disabled in develop mode

jupyter server extension disable jupyter_theme_editor pip uninstall jupyter_theme_editor

In development mode, you will also need to remove the symlink created by jupyter labextension developcommand. To find its location, you can run jupyter labextension list to figure out where the labextensionsfolder is located. Then you can remove the symlink named jupyter-theme-editor within that folder.

Testing the extension

Server tests

This extension is using Pytest for Python code testing.

Install test dependencies (needed only once):

pip install -e ".[test]"

Each time you install the Python package, you need to restore the front-end extension link

jupyter labextension develop . --overwrite

To execute them, run:

pytest -vv -r ap --cov jupyter_theme_editor

Frontend tests

This extension is using Jest for JavaScript code testing.

To execute them, execute:

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