Python
🐍 Soothing pastel library for Python & Matplotlib
Install / Use
/learn @catppuccin/PythonREADME
Installation
Install with pip or your preferred dependency management tool.
pip install catppuccin
Documentation
For an API reference and usage examples, see our online documentation.
IPython Theme
A minimal configuration:
c.TerminalInteractiveShell.true_color = True
c.TerminalInteractiveShell.highlighting_style = "catppuccin-mocha"
Putting this into your IPython configuration
and ensuring catppuccin[pygments] is installed in the same environment will
give you Catppuccin Mocha syntax highlighting in the REPL. See here
for an example of a more complete configuration.
Available IPython themes:
catppuccin-lattecatppuccin-frappecatppuccin-macchiatocatppuccin-mocha
Contribution
If you are looking to contribute, please read through our CONTRIBUTING.md first!
Development
This project is maintained with uv. If you don't have uv yet, you can install it using the installation instructions.
Install the project's dependencies including extras:
uv sync --all-extras
Codegen
catppuccin/palette.py is generated by a build script based on the contents of palette.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, see Code Standards below.
Code Standards
All of the tools listed in this section are automatically installed by uv as
part of the dev dependency group.
Unit Tests
Tests are run with pytest.
To run tests and display coverage:
pytest --cov catppuccin
Type Checking
Type checking is performed by mypy.
To run type checks:
mypy .
Lints and Formatting
Code linting and formatting is done by ruff.
To lint the code:
ruff check
To format the code:
ruff format
💝 Thanks to
<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 © 2022-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>
