Repository files navigation

Install withpip or your preferred dependency management tool.

pip install catppuccin

For an API reference and usage examples,see our online documentation.

A minimal configuration:

c.TerminalInteractiveShell.true_color=Truec.TerminalInteractiveShell.highlighting_style="catppuccin-mocha"

Putting this into yourIPython configurationand ensuringcatppuccin[pygments] is installed in the same environment willgive you Catppuccin Mocha syntax highlighting in the REPL. Seeherefor an example of a more complete configuration.

Available IPython themes:

• catppuccin-latte
• catppuccin-frappe
• catppuccin-macchiato
• catppuccin-mocha

If you are looking to contribute, please read through ourCONTRIBUTING.mdfirst!

This project is maintained withuv. If youdon't have uv yet, you can install it using theinstallationinstructions.

Install the project's dependencies including extras:

uv sync --all-extras

catppuccin/palette.py is generated by abuild script based on the contents ofpalette.json.

To update after downloading a new palette JSON file:

uv run build.py

Formatting this file is done manually as with any other file, seeCode Standards below.

All of the tools listed in this section are automatically installed by uv aspart of thedev dependency group.

Tests are run withpytest.

To run tests and display coverage:

pytest --cov catppuccin

Type checking is performed bymypy.

To run type checks:

mypy .

Code linting and formatting is done byruff.

To lint the code:

ruff check

To format the code:

ruff format

• backwardspy
• Bram de Wilde
• miloth

Copyright © 2022-presentCatppuccin Org