jupyterlab - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #ai #machine-learning #linux #java #windows #awesome #cli #kubernetes #pytorch #openai #open-source

jupyterlab

(★ 337)

📊 Soothing pastel theme for JupyterLab

File Explorer

Download Latest Version (.zip)

- - build.yml
  - check-release.yml
  - prep-release.yml
  - publish-release.yml
- .gitkeep
- frappe.webp
- github-social-preview.png
- latte.webp
- macchiato.webp
- mocha-brand.webp
- mocha.webp
- preview.webp
- settings.webp
- __init__.py
- markdown.md
- python.ipynb
- r.ipynb
- plugin.json
- index.ts
- palettes.ts
- index.css
- variables.css
.copier-answers.yml
.editorconfig
.gitignore
.prettierignore
.yarnrc.yml
CHANGELOG.md
index.tera
install.json
jupyterlab.tera
justfile
LICENSE
package.json
pyproject.toml
README.md
RELEASE.md
renovate.json
setup.py
tsconfig.json
yarn.lock

# Installation Guide

1. Get the code

git clone https://github.com/catppuccin/jupyterlab

Downloads the entire project code from GitHub to your computer.

cd jupyterlab

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

3. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install .

Installs the package published on PyPI directly — no need to clone the source.

jupyter notebook

Launches Jupyter in your browser so you can open and run the notebook (.ipynb) files.

✅ If it runs without errors and prints output in the terminal, it worked.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h3 align="center">
	<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/logos/exports/1544x1544_circle.png" width="100" alt="Logo"/><br/>
	<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px"/>
	Catppuccin for <a href="https://github.com/jupyterlab/jupyterlab">JupyterLab</a>
	<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px"/>
</h3>

<p align="center">
	<a href="https://github.com/catppuccin/jupyterlab/stargazers"><img src="https://img.shields.io/github/stars/catppuccin/jupyterlab?colorA=363a4f&colorB=b7bdf8&style=for-the-badge"></a>
	<a href="https://github.com/catppuccin/jupyterlab/issues"><img src="https://img.shields.io/github/issues/catppuccin/jupyterlab?colorA=363a4f&colorB=f5a97f&style=for-the-badge"></a>
	<a href="https://github.com/catppuccin/jupyterlab/contributors"><img src="https://img.shields.io/github/contributors/catppuccin/jupyterlab?colorA=363a4f&colorB=a6da95&style=for-the-badge"></a>
</p>

<p align="center">
	<img src="https://raw.githubusercontent.com/catppuccin/jupyterlab/main/assets/preview.webp"/>
</p>

## Previews

<details>
<summary>🌻 Latte</summary>
<img src="https://raw.githubusercontent.com/catppuccin/jupyterlab/main/assets/latte.webp"/>
</details>
<details>
<summary>🪴 Frappé</summary>
<img src="https://raw.githubusercontent.com/catppuccin/jupyterlab/main/assets/frappe.webp"/>
</details>
<details>
<summary>🌺 Macchiato</summary>
<img src="https://raw.githubusercontent.com/catppuccin/jupyterlab/main/assets/macchiato.webp"/>
</details>
<details>
<summary>🌿 Mocha</summary>
<img src="https://raw.githubusercontent.com/catppuccin/jupyterlab/main/assets/mocha.webp"/>
</details>

## Usage

1. Install the JupyterLab extension using `pip` or `conda`:
   - `pip install catppuccin-jupyterlab` or
   - `conda install -c conda-forge catppuccin-jupyterlab`.
2. Start/restart JupyterLab (`jupyter lab`). If it is already opened, you can reload it by executing "Reset Application State" in the Command Palette (`Ctrl + Shift + C`).
3. Go to the `Settings > Theme` menu option and choose the desired flavor.

It supports both JupyterLab v3 and v4.

## Customization

### Brand Color

It is possible to choose any of the Catppucin colors as your "brand" color. The default is `mauve`, but you can choose your favorite to make it your way!

<img src="https://raw.githubusercontent.com/catppuccin/jupyterlab/main/assets/mocha-brand.webp"/>

You can specify the colors by going to the `Settings > Settings Editor` (or `Ctrl + ,`), going to the `Theme - Catppuccin` section, then choosing your desired color in the lists of the dropdown menu.

<img src="https://raw.githubusercontent.com/catppuccin/jupyterlab/main/assets/settings.webp"/>

Alternatively, you can specify the json with the settings:
```json
{
    "brandColor": "mauve",
    "accentColor": "green"
}
```

> [!NOTE]
> Besides the "brand" color it is also possible to set the "accent" color (default is green), but it rarely appears in the JupyterLab interface.

## 💝 Thanks to

- [Gabriel Magno](https://github.com/gabrielmagno)

&nbsp;

<p align="center">
	<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/footers/gray0_ctp_on_line.svg?sanitize=true" />
</p>

<p align="center">
	Copyright &copy; 2021-present <a href="https://github.com/catppuccin" target="_blank">Catppuccin Org</a>
</p>

<p align="center">
	<a href="https://github.com/catppuccin/catppuccin/blob/main/LICENSE"><img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&logoColor=d9e0ee&colorA=363a4f&colorB=b7bdf8"/></a>
</p>