Skip to main content

Soho Vibes for JupyterLab

Project description

Rosé Pine for JupyterLab

All natural pine, faux fur and a bit of soho vibes for the classy minimalist

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install rose_pine_jupyterlab

Usage

  1. Open jupyter lab.
  2. Under Settings > Theme.
  3. Select Rosé Pine from the themes dropdown.

Gallery

  • Rosé Pine

Rosé Pine lab

Rosé Pine notebook

Uninstall

To remove the extension, execute:

pip uninstall rose_pine_jupyterlab

Contributing

Rose Pine Template

Prefer using @rose-pine/build when possible

Modify style/template.css using Rosé Pine variables, then build variants:

npx @rose-pine/build@latest -t style/template.css -o style/

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

# 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

pip uninstall rose_pine_jupyterlab

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 rose-pine-jupyterlab within that folder.

Packaging the extension

See RELEASE

Thanks to

npx @rose-pine/build@0.8.2 -t style/template.css -o style/

Generated by @rose-pine/build@0.8.2

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

rose_pine_jupyterlab-0.1.0.tar.gz (89.8 kB view details)

Uploaded Source

Built Distribution

rose_pine_jupyterlab-0.1.0-py3-none-any.whl (20.1 kB view details)

Uploaded Python 3

File details

Details for the file rose_pine_jupyterlab-0.1.0.tar.gz.

File metadata

  • Download URL: rose_pine_jupyterlab-0.1.0.tar.gz
  • Upload date:
  • Size: 89.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for rose_pine_jupyterlab-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ab0c32eb2be81c924734fd1bb46f923c5495ea7d0ee0ed719b81c4f4cf93a24b
MD5 772f4f4a6980530a0c71164108846a49
BLAKE2b-256 fa03664510ace7cae9ecbe3c74124ddb6445eb19e920bff184a795dfe07a3cdb

See more details on using hashes here.

File details

Details for the file rose_pine_jupyterlab-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for rose_pine_jupyterlab-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6d9ee2958aa0c9be45096232e1cd0c3320b2f67734a6dd062cb823d3e25bca03
MD5 785093594ed47b7bfb4aa32e80835daa
BLAKE2b-256 ad457f94752aa486287029379a88cb05f92f75cacb3953677b3ad9f71912858e

See more details on using hashes here.

Supported by

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