sarvam shri krishna sankalpam

Author: lalithaar

.color_pairs.yml

@@ -0,0 +1,6 @@
+min_contrast: AA
+pairs:
+- background: '#ffffff'
+  foreground: '#000000'
+- background: '#000000'
+  foreground: '#ffffff'

.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+        
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install .
+        
+    - name: Run Lint
+      run: |
+        # Create a sample config for testing
+        cc-lint init
+        # Run lint
+        cc-lint lint

README.md

@@ -0,0 +1,57 @@
+# Color Contrast Linter
+
+A CLI tool to lint color pairs for contrast compliance using `cm-colors`.
+
+## Installation
+
+```bash
+pip install color-contrast-linter
+```
+
+## Usage
+
+### Initialize Configuration
+
+Run the `init` command to create a `.color_pairs.yml` file:
+
+```bash
+cc-lint init
+```
+
+This creates a configuration file where you can define your color pairs and the minimum contrast standard (AA or AAA).
+
+```yaml
+min_contrast: AA
+pairs:
+  - foreground: "#000000"
+    background: "#ffffff"
+  - foreground: "#ffffff"
+    background: "#000000"
+```
+
+### Lint Colors
+
+Run the `lint` command to check your color pairs:
+
+```bash
+cc-lint lint
+```
+
+The tool supports Hex, RGB, and RGBA color formats.
+
+## CI/CD Integration
+
+You can use this tool in your CI/CD pipelines to ensure accessibility compliance.
+
+```yaml
+steps:
+  - uses: actions/checkout@v3
+  - name: Set up Python
+    uses: actions/setup-python@v4
+    with:
+      python-version: '3.x'
+  - name: Install dependencies
+    run: pip install color-contrast-linter
+  - name: Lint colors
+    run: cc-lint lint
+```

pyproject.toml

@@ -0,0 +1,19 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "color-contrast-linter"
+version = "0.1.0"
+description = "A CLI tool to lint color pairs for contrast compliance using cm-colors."
+readme = "README.md"
+requires-python = ">=3.8"
+dependencies = [
+    "cm-colors>=0.5.0",
+    "click",
+    "rich",
+    "pyyaml",
+]
+
+[project.scripts]
+cc-lint = "color_contrast_linter.cli:main"

src/color_contrast_linter/__init__.py

@@ -0,0 +1,83 @@
+import click
+from rich.console import Console
+from rich.table import Table
+from pathlib import Path
+import sys
+
+from cm_colors import Color, ColorPair
+from .config import load_config, create_default_config, CONFIG_FILE_NAME
+
+console = Console()
+
+@click.group()
+def main():
+    """A CLI tool to lint color pairs for contrast compliance."""
+    pass
+
+@main.command()
+def init():
+    """Initialize the .color_pairs.yml configuration file."""
+    config_path = Path(CONFIG_FILE_NAME)
+    if config_path.exists():
+        console.print(f"[yellow]Warning:[/yellow] {CONFIG_FILE_NAME} already exists.")
+        if not click.confirm("Do you want to overwrite it?"):
+            return
+
+    create_default_config(config_path)
+    console.print(f"[green]Success:[/green] Created {CONFIG_FILE_NAME} with sample data.")
+    console.print("You can now edit this file to add your own color pairs.")
+
+@main.command()
+def lint():
+    """Lint color pairs defined in .color_pairs.yml."""
+    config = load_config()
+    if not config:
+        console.print(f"[red]Error:[/red] Could not find or parse {CONFIG_FILE_NAME}.")
+        console.print(f"Run [bold]cc-lint init[/bold] to create one.")
+        sys.exit(1)
+
+    table = Table(title="Color Contrast Lint Results")
+    table.add_column("Foreground", style="cyan")
+    table.add_column("Background", style="magenta")
+    table.add_column("Status", justify="center")
+
+    failed_count = 0
+    standard = config.min_contrast.upper()
+    console.print(f"Checking against standard: [bold]{standard}[/bold]")
+
+    for pair_config in config.pairs:
+        try:
+            pair = ColorPair(pair_config.foreground, pair_config.background)
+            
+            readability = pair.is_readable
+            
+            passed = False
+            if standard == "AAA":
+                passed = readability == "Very Readable"
+            else: # Default to AA
+                passed = readability in ["Readable", "Very Readable"]
+
+            status = "[green]PASS[/green]" if passed else "[red]FAIL[/red]"
+            if not passed:
+                failed_count += 1
+
+            table.add_row(
+                pair_config.foreground,
+                pair_config.background,
+                status
+            )
+
+        except Exception as e:
+            console.print(f"[red]Error processing pair {pair_config.foreground} on {pair_config.background}: {e}[/red]")
+            failed_count += 1
+
+    console.print(table)
+
+    if failed_count > 0:
+        console.print(f"\n[red]Lint failed with {failed_count} errors.[/red]")
+        sys.exit(1)
+    else:
+        console.print("\n[green]All color pairs passed contrast checks![/green]")
+
+if __name__ == "__main__":
+    main()

src/color_contrast_linter/__pycache__/__init__.cpython-311.pyc

@@ -0,0 +1,56 @@
+import yaml
+from pathlib import Path
+from typing import List, Dict, Optional
+from dataclasses import dataclass
+
+CONFIG_FILE_NAME = ".color_pairs.yml"
+
+@dataclass
+class ColorPairConfig:
+    foreground: str
+    background: str
+
+@dataclass
+class Config:
+    min_contrast: str
+    pairs: List[ColorPairConfig]
+
+def load_config(path: Path = Path(CONFIG_FILE_NAME)) -> Optional[Config]:
+    if not path.exists():
+        return None
+    
+    with open(path, "r") as f:
+        try:
+            data = yaml.safe_load(f)
+        except yaml.YAMLError:
+            return None
+            
+    if not data:
+        return None
+
+    min_contrast = data.get("min_contrast", "AA")
+    pairs = []
+    for item in data.get("pairs", []):
+        pairs.append(ColorPairConfig(
+            foreground=item.get("foreground", ""),
+            background=item.get("background", "")
+        ))
+    
+    return Config(min_contrast=min_contrast, pairs=pairs)
+
+def create_default_config(path: Path = Path(CONFIG_FILE_NAME)):
+    default_data = {
+        "min_contrast": "AA",
+        "pairs": [
+            {
+                "foreground": "#000000",
+                "background": "#ffffff"
+            },
+            {
+                "foreground": "#ffffff",
+                "background": "#000000"
+            }
+        ]
+    }
+    with open(path, "w") as f:
+        yaml.dump(default_data, f, default_flow_style=False)