Skip to main content

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

Project description

JupyterLab Material Night Eighties theme

Build Node.js Package

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

Installation

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

Themes can also be installed from source. From a theme's subdirectory:

npm install
jupyter labextension link .

Screenshots

material_night_eighties

Requirements

  • node/npm
  • python
    • jupyterlab >= 3.1
    • jupyter-packaging
  • typescript

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

Uninstall

pip uninstall jupyterlab_material_night_eighties
jupyter labextension uninstall @ninerealmlabs/jupyterlab_material_night_eighties
# may have to delete file manually
rm -rf /path/to/envs/ENVNAME/share/jupyter/labextensions/@ninerealmlabs/jupyterlab_material_night_eighties

Bumping versions

Via arbennett/jupyterlab-themes

Because I have cobbled together a strange workflow for updating all of the themes at once it's a bit unwieldy to update the versioning consistently. This is the command I use (mostly for my own sake):

CURRENT_VERSION="v0.2.9"
NEW_VERSION="v0.2.10"
# add blank '' for mac sed
sed -i '' "s/\"version\": \"${CURRENT_VERSION}\"/\"version\": \"${NEW_VERSION}\"/g" ./**/package.json
sed -i '' "s/\"version\": \"${CURRENT_VERSION}\"/\"version\": \"${NEW_VERSION}\"/g" ./**/package-lock.json

npm install

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyterlab_material_night_eighties-0.2.10.tar.gz (146.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file jupyterlab_material_night_eighties-0.2.10.tar.gz.

File metadata

File hashes

Hashes for jupyterlab_material_night_eighties-0.2.10.tar.gz
Algorithm Hash digest
SHA256 281741c3a1adfa05caffc4ac44dbe423325c256075fbacaaf9248e248096b620
MD5 5bd3d836510e7ebd3bc72b5df6ddd2e5
BLAKE2b-256 7dfb6c4eea53cc75d9eeda4e4da7e005e53f2d1e0c9240e657dcf21f9f9b92ec

See more details on using hashes here.

File details

Details for the file jupyterlab_material_night_eighties-0.2.10-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_material_night_eighties-0.2.10-py3-none-any.whl
Algorithm Hash digest
SHA256 1aab2a65b98b4c7db1995ba4c5c9c4e9a4a047d06388bab9dd920a2d3df1cc8a
MD5 cfa90282aca243813f88795e7fae36c3
BLAKE2b-256 ad1dfcecd83b96d9ae9c882f2761b8298958a22dcb79625ff8fd82987037a740

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page