jupyterlab-material-night-eighties 0.3.2

A jupyterlab theme inspired by material darker and VSCode's material night eighties

JupyterLab Material Night Eighties theme

Theme for jupyterlab based on jupyterlab/theme-extension-cookiecutter-ts, inspired by oriolmirosa/jupyterlab_materialdarker, arbennett/jupyterlab-themes, VSCode Material Theme Kit, and base16

• JupyterLab Material Night Eighties theme
  • Requirements
  • Installation
  • Screenshots
  • Contributing
    • Development install
    • Updating dependencies
    • Development uninstall
    • Testing the extension
      • Frontend tests
      • Integration tests
    • Packaging the extension

Requirements

• JupyterLab >= 3.0

Installation

To install the extension, execute:

pip install jupyterlab-material-night-eighties

Themes can be installed directly from npm using the standard JupyterLab installation method:

jupyter labextension install @ninerealmlabs/jupyterlab_material_night_eighties

Screenshots

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

• Terminal A:

  # Watch the source directory in one terminal, automatically rebuilding when needed
  jlpm run watch
  

• Terminal B:

  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

Updating dependencies

Copy devDependencies in package.json from jupyterlab-extension-cookiecutter-ts

Then run

rm package-lock.json yarn.lock
npm update
npm install
yarn install

Development uninstall

pip uninstall jupyterlab-material-night-eighties

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 jupyterlab_material_night_eighties within that folder.

Testing the extension

Frontend tests

This extension is using Jest for JavaScript code testing.

To execute them, execute:

jlpm
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