Catppuccin for Python
## Installation
Install with `pip` or your preferred dependency management tool.
```bash
pip install catppuccin
```
## Usage
Get access to the palette with the `catppuccin.PALETTE` constant:
```python
from catppuccin import PALETTE
PALETTE.latte.colors.mauve.hex
# '#8839ef'
PALETTE.mocha.colors.teal.rgb
# RGB(r=148, g=226, b=213)
```
The `Palette` data structure matches [the palette JSON](https://github.com/catppuccin/palette/blob/main/palette.json).
### Iteration
Both `Palette` and `FlavorColors` can be iterated to yield flavors and colors respectively:
```python
for flavor in PALETTE:
print(flavor.name)
# Latte
# Frappé
# Macchiato
# Mocha
for color in PALETTE.latte.colors:
print(f"{color.name}: {color.hex}")
# Rosewater: #f2d5cf
# Flamingo: #eebebe
# Pink: #f4b8e4
# ...
# Base: #303446
# Mantle: #292c3c
# Crust: #232634
```
### dataclasses
`Palette`, `Flavor`, `Color` et cetera are all [`dataclasses`](https://docs.python.org/3/library/dataclasses.html),
so you can also inspect and iterate their fields using methods from the dataclass module.
For example, to list all color names and their hex codes:
```python
from dataclasses import fields
from catppuccin import PALETTE
flavor = PALETTE.frappe
for field in fields(flavor.colors):
color = getattr(flavor.colors, field.name)
print(f"{field.name}: {color.hex}")
# rosewater: #f2d5cf
# flamingo: #eebebe
# pink: #f4b8e4
# ...
# base: #303446
# mantle: #292c3c
# crust: #232634
```
## Pygments Styles
This package provides a Pygments style for each of the four Catppuccin flavors.
Install Catppuccin with the `pygments` feature to include the relevant dependencies:
```bash
pip install catppuccin[pygments]
```
The styles are registered as importlib entrypoints, which allows Pygments to
find them by name:
```python
from pygments.styles import get_style_by_name
get_style_by_name("catppuccin-frappe")
# catppuccin.extras.pygments.FrappeStyle
```
The following style names are available:
- `catppuccin-latte`
- `catppuccin-frappe`
- `catppuccin-macchiato`
- `catppuccin-mocha`
They can also be accessed by directly importing them:
```python
from catppuccin.extras.pygments import MacchiatoStyle
```
### IPython
A minimal configuration:
```python
c.TerminalInteractiveShell.true_color = True
c.TerminalInteractiveShell.highlighting_style = "catppuccin-mocha"
```
Putting this into your [IPython configuration](https://ipython.readthedocs.io/en/stable/config/intro.html)
and ensuring `catppuccin[pygments]` is installed in the same environment will
give you Catppuccin Mocha syntax highlighting in the REPL. See [here](https://github.com/backwardspy/dots/blob/f6991570d6691212e27e266517656192f910ccbf/dot_config/ipython/profile_default/ipython_config.py)
for an example of a more complete configuration.
## Contribution
If you are looking to contribute, please read through our
[CONTRIBUTING.md](https://github.com/catppuccin/.github/blob/main/CONTRIBUTING.md)
first!
### Development
This project is maintained with [Poetry](https://python-poetry.org). If you
don't have Poetry yet, you can install it using the [installation
instructions](https://python-poetry.org/docs/#installation).
Install the project's dependencies including extras:
```bash
poetry install --all-extras
```
#### Codegen
[`catppuccin/palette.py`](./catppuccin/palette.py) is generated by a [build script](`./build.py`) based on the contents of [`palette.json`](./palette.json).
To update after downloading a new palette JSON file:
```console
poetry run python build.py
```
Formatting this file is done manually as with any other file, see [`Code Standards`](#code-standards) below.
#### Code Standards
Before committing changes, it is recommended to run the following tools to
ensure consistency in the codebase.
```bash
ruff format
ruff check
mypy .
pytest --cov catppuccin
```
These tools are all installed as part of the `dev` dependency group with
Poetry. You can use `poetry shell` to automatically put these tools in your
path.
## 💝 Thanks to
- [backwardspy](https://github.com/backwardspy)
Copyright © 2022-present Catppuccin Org
