feat!: change palette data structure to match json, add codegen (#29)

Co-authored-by: Raffaele Mancuso <[email protected]>

Author: backwardspy

.github/workflows/lint.yaml

@@ -3,9 +3,6 @@ on:
   push:
     paths:
       - "**.py"
-  pull_request:
-    paths:
-      - "**.py"
 jobs:
   lint:
     strategy:

.github/workflows/test.yaml

@@ -3,9 +3,6 @@ on:
   push:
     paths:
       - '**.py'
-  pull_request:
-    paths:
-      - "**.py"
 jobs:
   test:
     strategy:

README.md

@@ -21,35 +21,47 @@ pip install catppuccin
 
 ## Usage
 
+Get access to the palette with the `catppuccin.PALETTE` constant:
+
 ```python
->>> from catppuccin import Flavour
->>> Flavour.latte().mauve.hex
-'8839ef'
->>> Flavour.mocha().teal.rgb
-(148, 226, 213)
+from catppuccin import PALETTE
+
+PALETTE.latte.colors.mauve.hex
+# '#8839ef'
+PALETTE.mocha.colors.teal.rgb
+# RGB(r=148, g=226, b=213)
 ```
 
-`Flavour` is a [`dataclass`](https://docs.python.org/3/library/dataclasses.html),
-so you can inspect its fields to get access to the full set of colour names and values:
+The `Palette` data structure matches [the palette JSON](https://github.com/catppuccin/palette/blob/main/palette.json).
+
+### 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
->>> flavour = Flavour.frappe()
->>> for field in fields(flavour):
-        colour = getattr(flavour, field.name)
-        print(f"{field.name}: #{colour.hex}")
-rosewater: #f2d5cf
-flamingo: #eebebe
-pink: #f4b8e4
-...
-base: #303446
-mantle: #292c3c
-crust: #232634
+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 flavours.
+This package provides a Pygments style for each of the four Catppuccin flavors.
 
 Install Catppuccin with the `pygments` feature to include the relevant dependencies:
 
@@ -61,9 +73,10 @@ 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
+from pygments.styles import get_style_by_name
+
+get_style_by_name("catppuccin-frappe")
+# catppuccin.extras.pygments.FrappeStyle
 ```
 
 The following style names are available:
@@ -88,7 +101,10 @@ 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 a more complete example configuration.
+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
 
@@ -108,6 +124,18 @@ Install the project's dependencies including extras:
 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

build.py

@@ -0,0 +1,65 @@
+"""Code generation script for creating the global palette constant."""
+from __future__ import annotations
+
+import json
+from pathlib import Path
+from typing import Any, cast
+
+from catppuccin.models import HSL, RGB, Color, Flavor, FlavorColors, Palette
+
+HEADER = '''"""Catppuccin palette definition."""
+from catppuccin.models import HSL, RGB, Color, Flavor, FlavorColors, Palette'''
+
+
+def load_palette_json() -> dict[str, Any]:
+    """Load palette data from `./palette.json`."""
+    with Path("palette.json").open() as f:
+        return cast(dict[str, Any], json.load(f))
+
+
+def make_color(fields: dict[str, Any]) -> Color:
+    """Create a Color instance from a set of fields."""
+    return Color(
+        name=fields["name"],
+        order=fields["order"],
+        hex=fields["hex"],
+        rgb=RGB(**fields["rgb"]),
+        hsl=HSL(**fields["hsl"]),
+        accent=fields["accent"],
+    )
+
+
+def make_flavor(fields: dict[str, Any]) -> Flavor:
+    """Create a Flavor instance from a set of fields."""
+    return Flavor(
+        name=fields["name"],
+        order=fields["order"],
+        dark=fields["dark"],
+        colors=FlavorColors(
+            **{
+                color_name: make_color(color_data)
+                for color_name, color_data in fields["colors"].items()
+            }
+        ),
+    )
+
+
+def codegen() -> str:
+    """Generate contents of `catppuccin/palette.py`."""
+    palette_json = load_palette_json()
+    palette = Palette(
+        *[make_flavor(flavor_data) for flavor_data in palette_json.values()]
+    )
+
+    lines = [
+        HEADER,
+        f"PALETTE = {palette!r}",
+    ]
+
+    return "\n".join(lines)
+
+
+if __name__ == "__main__":
+    with Path("catppuccin/palette.py").open("w") as f:
+        source = codegen()
+        print(source, file=f)

catppuccin/__init__.py

@@ -1,5 +1,6 @@
 """🐍 Soothing pastel theme for Python."""
-from catppuccin.colour import Colour
-from catppuccin.flavour import Flavour
 
-__all__ = ["Colour", "Flavour"]
+
+from catppuccin.palette import PALETTE
+
+__all__ = ["PALETTE"]