Skip to main content

An ariake dark palette based JupyterLab theme extension.

Project description

Jupyterlab Ariake Dark Theme


An ariake dark palette based JupyterLab theme extension.

updatebadge pypibadge mitbadgeci-badge emailbadge

visual

requirements

  • jupyterlab >= 4.0.0

install

to install the extension, execute:

pip install jupyterlab_ariakedark_theme

to check the installation, execute:

jupyter labextension list

uninstall

to remove the extension, execute:

pip uninstall jupyterlab_ariakedark_theme

contributing

to make personal customizations to the theme, edit the variables.css file, and then run the development install steps listed bellow.

feel free to make pending or other optimizations and pull requests, this theme is still under development and any contribution is very much appreciated.

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:
git clone https://github.com/eduardotlc/jupyterlab_ariakedark_theme
  • change directory to the jupyterlab_ariakedark_theme directory:
cd jupyterlab_ariakedark_theme
  • install package in development mode:
pip install -ve "."
  • 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 jupyterlab_ariakedark_theme

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

Other themes

See my others Jupyter Lab themes

materialdarkerbadge

midnightseabadge

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_ariakedark_theme-0.2.3.tar.gz (720.6 kB view details)

Uploaded Source

Built Distribution

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

jupyterlab_ariakedark_theme-0.2.3-py3-none-any.whl (220.2 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_ariakedark_theme-0.2.3.tar.gz.

File metadata

File hashes

Hashes for jupyterlab_ariakedark_theme-0.2.3.tar.gz
Algorithm Hash digest
SHA256 6d570092ed59a9f8f1da9f8724cd9e068cd43ede95c8652fa4a8e406f5d34440
MD5 0bcf9026562f14e772953471e4a0be70
BLAKE2b-256 56f92f64e9cddfcfcf44f906183a4f1e49849552ce56e9c2559637569d1f6732

See more details on using hashes here.

File details

Details for the file jupyterlab_ariakedark_theme-0.2.3-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_ariakedark_theme-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 148a316338683a08a719e33d44671dab4b2fe82d7d33fcb4ac432f18101ff0f5
MD5 4ae376a5a06e2e71945e388f31479ed7
BLAKE2b-256 ad8a321b0c86b2c9d4a4131fb602d632ccf8ab7f9496676ef4639f97fd1e9ead

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