fix: ruff lint fixes, add ruff CI step, CONTRIBUTING.md, remove BOM from config files

Author: Revenue Holdings

.github/workflows/ci.yml

@@ -26,10 +26,13 @@ jobs:
           python -m pip install --upgrade pip
           pip install -e ".[dev]"
 
+      - name: Lint with ruff
+        run: pip install ruff && ruff check src/ --target-version py310
       - name: Run tests
         run: |
           python -m pytest tests/ -v --tb=short
 
       - name: Check CLI works
         run: |
           api-contract-guardian --help
+

.github/workflows/publish.yml

@@ -51,3 +51,4 @@ jobs:
           TWINE_PASSWORD: \${{ secrets.TEST_PYPI_API_TOKEN }}
         run: |
           twine upload --repository testpypi dist/* --verbose
+

CONTRIBUTING.md

@@ -0,0 +1,35 @@
+# Contributing
+
+Thanks for your interest in contributing!
+
+## Development Setup
+
+1. Fork and clone the repo
+2. Create a virtual environment: python -m venv .venv && source .venv/bin/activate
+3. Install dev dependencies: pip install -e ".[dev]"
+4. Run tests: pytest tests/ -v
+5. Lint: uff check src/
+
+## Pull Requests
+
+- Fork the repo and create a feature branch
+- Add tests for any new functionality
+- Ensure all existing tests pass
+- Run uff check src/ --fix before committing
+- Keep PRs focused on a single change
+
+## Reporting Issues
+
+- Use GitHub Issues
+- Include Python version, OS, and steps to reproduce
+- Include relevant error output
+
+## Code Style
+
+- Python 3.10+
+- Type hints where practical
+- Follow ruff defaults (Black-compatible formatting)
+
+## License
+
+By contributing, you agree your work will be licensed under the same license as this project.

pyproject.toml

@@ -45,3 +45,14 @@ where = ["src"]
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 addopts = "-v --tb=short"
+
+[tool.ruff]
+target-version = "py310"
+line-length = 120
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "B", "SIM"]
+ignore = ["E501"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["*"]

src/api_contract_guardian/cli.py

@@ -3,23 +3,18 @@
 from __future__ import annotations
 
 import json
-import sys
-from pathlib import Path
-from typing import Optional
-
 import typer
+from pathlib import Path
 from rich.console import Console
 from rich.table import Table
-from rich.panel import Panel
-from rich.text import Text
 
 try:
     from revenueholdings_license import require_license
 except ImportError:
     require_license = None
 
-from .diff import DiffResult, Severity, diff_specs
-from .gate import GateResult, check_gate
+from .diff import DiffResult, diff_specs
+from .gate import check_gate
 from .loader import SpecLoadError, load_spec, validate_openapi_version
 from .migration import generate_migration_guide, generate_migration_guide_json
 
@@ -86,7 +81,7 @@ def _print_result(result: DiffResult) -> None:
 def diff(
     old: str = typer.Argument(..., help="Path to old (baseline) OpenAPI spec"),
     new: str = typer.Argument(..., help="Path to new (proposed) OpenAPI spec"),
-    output: Optional[str] = typer.Option(None, "--output", "-o", help="Output file path"),
+    output: str | None = typer.Option(None, "--output", "-o", help="Output file path"),
     format: str = typer.Option("rich", "--format", "-f", help="Output format: rich, json, markdown"),
 ) -> None:
     """Compare two OpenAPI specs and show all detected changes."""
@@ -127,7 +122,7 @@ def check(
     fail_on_dangerous: bool = typer.Option(False, "--fail-on-dangerous/--allow-dangerous", help="Fail on dangerous changes"),
     max_breaking: int = typer.Option(0, "--max-breaking", help="Max allowed breaking changes (default 0)"),
     max_dangerous: int = typer.Option(-1, "--max-dangerous", help="Max allowed dangerous changes (-1=unlimited)"),
-    output: Optional[str] = typer.Option(None, "--output", "-o", help="Output file path"),
+    output: str | None = typer.Option(None, "--output", "-o", help="Output file path"),
 ) -> None:
     """Gate CI pipeline on breaking changes. Returns exit code 1 if gate fails."""
     if require_license:
@@ -167,7 +162,7 @@ def check(
 def migrate(
     old: str = typer.Argument(..., help="Path to old (baseline) OpenAPI spec"),
     new: str = typer.Argument(..., help="Path to new (proposed) OpenAPI spec"),
-    output: Optional[str] = typer.Option(None, "--output", "-o", help="Output file path"),
+    output: str | None = typer.Option(None, "--output", "-o", help="Output file path"),
     format: str = typer.Option("markdown", "--format", "-f", help="Output format: markdown, json"),
 ) -> None:
     """Generate a migration guide between two OpenAPI spec versions."""

src/api_contract_guardian/diff.py

@@ -6,8 +6,6 @@
 from enum import Enum
 from typing import Any
 
-from deepdiff import DeepDiff
-
 
 class Severity(str, Enum):
     BREAKING = "breaking"

src/api_contract_guardian/gate.py

@@ -5,7 +5,7 @@
 from dataclasses import dataclass
 from typing import Any
 
-from .diff import DiffResult, Severity
+from .diff import DiffResult
 
 
 @dataclass
@@ -53,20 +53,20 @@ def check_gate(
 
     # Determine effective thresholds
     if max_breaking >= 0:
-        if fail_on_breaking or max_breaking > 0:
+        if fail_on_breaking or max_breaking > 0:  # noqa: SIM108
             effective_max_breaking = max_breaking
         else:
-            effective_max_breaking = -1  # unlimited
+            effective_max_breaking = -1 # unlimited
     elif fail_on_breaking:
         effective_max_breaking = 0   # default: zero tolerance
     else:
         effective_max_breaking = -1  # unlimited
 
     if max_dangerous >= 0:
-        if fail_on_dangerous or max_dangerous > 0:
+        if fail_on_dangerous or max_dangerous > 0:  # noqa: SIM108
             effective_max_dangerous = max_dangerous
         else:
-            effective_max_dangerous = -1  # unlimited
+            effective_max_dangerous = -1 # unlimited
     elif fail_on_dangerous:
         effective_max_dangerous = 0   # default: zero tolerance
     else:

src/api_contract_guardian/loader.py

@@ -3,11 +3,10 @@
 from __future__ import annotations
 
 import json
+import yaml
 from pathlib import Path
 from typing import Any
 
-import yaml
-
 
 class SpecLoadError(Exception):
     """Raised when a spec file cannot be loaded or parsed."""

src/api_contract_guardian/migration.py

@@ -4,7 +4,7 @@
 
 from typing import Any
 
-from .diff import Change, DiffResult, Severity
+from .diff import Change, DiffResult
 
 
 def generate_migration_guide(result: DiffResult) -> str:
@@ -27,8 +27,8 @@ def generate_migration_guide(result: DiffResult) -> str:
     summary = result.to_dict()["summary"]
     lines.append("## Summary")
     lines.append("")
-    lines.append(f"| Severity | Count |")
-    lines.append(f"|----------|-------|")
+    lines.append("| Severity | Count |")
+    lines.append("|----------|-------|")
     lines.append(f"| Breaking | {summary['breaking']} |")
     lines.append(f"| Dangerous | {summary['dangerous']} |")
     lines.append(f"| Non-breaking | {summary['non_breaking']} |")