ObjPalette API

Method	Signature	Description
read	`read(palette_name: str = '') -> dict`
get_color	`get_color(color_name: str, default_value: str = '') -> str`
get_palette	`get_palette(name: str = '', colour: str = '')`	Load the palette for the active package.
get_print_palette	`get_print_palette() -> dict`	Load the PRINT palette for PDF/print output.
get_mermaid_theme	`get_mermaid_theme() -> str`	Return the mermaid theme matching the palette.
hex_to_rgb	`hex_to_rgb(hex_code: str) -> tuple[int, int, int]`	Convert a hex colour string to an (R, G, B) tuple.
wcag_ratio	`wcag_ratio(hex_col: str, background: str = '#ffffff') -> float`	WCAG 2.1 contrast ratio between two colours.
pick_readable	`pick_readable(min_ratio: float, background: str, fallback: str, *candidates) -> str`	Pick the first colour with sufficient
hex_to_name	`hex_to_name(hex_code: str) -> str`	Return the nearest CSS3 colour name for a hex code.
get_piper_theme	`get_piper_theme(palette: dict \| None = None) -> str`	Match a palette to the closest piper theme.
populate_colour_names	`populate_colour_names(palette_name: str = '') -> dict`	Resolve colour names for all hex values in a palette and
populate_all_colour_names	`populate_all_colour_names() -> int`	Resolve colour names for every palette in the database.
save	`save(palette_name: str) -> None`
get_default	`get_default() -> dict`	Return the default palette row for the current package, or {} if none set.
set_default	`set_default(palette_name: str) -> None`	Mark palette_name as the default for the current package.
extract_from_image	`extract_from_image(image_path: str, palette_name: str, num_colors: int = 6) -> list`
are_complementary	`are_complementary(color1_hex: str, color2_hex: str) -> bool`
load_json_to_db	`load_json_to_db() -> None`
normalize_palettes	`normalize_palettes() -> None`
swatches	`swatches(palette_name: str \| None = None, combine: bool = True) -> None`
combine_swatches	`combine_swatches() -> None`
display_cli_palette	`display_cli_palette(palette: dict) -> None`
seed_from_yaml	`seed_from_yaml() -> None`	Insert palette seed data from ObjPalette.yaml for the current package.
export_to_yaml	`export_to_yaml() -> int`	Write current DB palettes to the palettes: section of ObjPalette.yaml.
validate	`validate(palette_name: str, delta_e_threshold: float = 20.0, wcag_level: str = 'AA') -> list[dict]`	Check a palette's semantic colours for clashing and WCAG contrast failures.
fix	`fix(palette_name: str, issues: list[dict]) -> dict[str, str]`	Return suggested hex replacements for colours that have issues.

¶ ObjPalette (API Reference)

¶ class ObjPalette(ObjImage.ObjImage)

¶ current() -> None

¶ list_palettes() -> None

¶ show(palette_name: str) -> None

¶ load() -> None

¶ normalize() -> None

¶ swatches(palette_name: str = typer.Option(None, '--name', help='Name of the palette to generate a swatch for.'), no_combine: bool = typer.Option(False, '--no-combine', help='Skip generating a combined swatch image.')) -> None

¶ extract(image_path: str, palette_name: str, num_colors: int = 6) -> None

¶ validate(palette_name: str, delta_e: float = typer.Option(20.0, '--delta-e', help='Minimum Delta E (CIEDE2000) between any two colours.'), wcag: str = typer.Option('AA', '--wcag', help='WCAG contrast level to enforce: AA (4.5:1) or AAA (7:1).')) -> None

¶ fix_all(delta_e: float = typer.Option(20.0, '--delta-e', help='Minimum Delta E (CIEDE2000) between any two colours.'), wcag: str = typer.Option('AA', '--wcag', help='WCAG contrast level to enforce: AA (4.5:1) or AAA (7:1).')) -> None

¶ default(palette_name: str = typer.Argument(None, help='Palette name to set as default. Omit to show the current default.')) -> None

¶ export() -> None