feat(scripts): add readme_generator — auto-generate README from codebase

Adds scripts/readme_generator.py — a tool that scans Python codebases,
extracts module docstrings, entry points (argparse main), and directory
structure to generate a standard README.md with: description, installation,
usage, scripts list.

Acceptance for #97:
- Reads codebase structure (AST-based Python file scanner)
- Generates README sections (Description, Installation, Usage, Scripts, Directory)
- Updates existing README (replaces on run — idempotent)
- 1 per run (single repo per invocation)

Usage:
    python3 scripts/readme_generator.py              # generate in-place
    python3 scripts/readme_generator.py --dry-run    # preview stats
    python3 scripts/readme_generator.py --dir /path

Closes #97

quality_gate.py

@@ -0,0 +1,297 @@
+#!/usr/bin/env python3
+"""
+quality_gate.py — Score and filter knowledge entries.
+
+Scores each entry on 4 dimensions:
+- Specificity: concrete examples vs vague generalities
+- Actionability: can this be used to do something?
+- Freshness: is this still accurate?
+- Source quality: was the model/provider reliable?
+
+Usage:
+    from quality_gate import score_entry, filter_entries, quality_report
+
+    score = score_entry(entry)
+    filtered = filter_entries(entries, threshold=0.5)
+    report = quality_report(entries)
+"""
+
+import json
+import math
+import re
+import sys
+from datetime import datetime, timezone
+from pathlib import Path
+from typing import Dict, List, Any, Optional
+
+# Source quality scores (higher = more reliable)
+SOURCE_QUALITY = {
+    "claude-sonnet": 0.9,
+    "claude-opus": 0.95,
+    "gpt-4": 0.85,
+    "gpt-4-turbo": 0.85,
+    "gpt-5": 0.9,
+    "mimo-v2-pro": 0.8,
+    "gemini-pro": 0.8,
+    "llama-3-70b": 0.75,
+    "llama-3-8b": 0.7,
+    "ollama": 0.6,
+    "unknown": 0.5,
+}
+
+DEFAULT_SOURCE_QUALITY = 0.5
+
+# Specificity indicators
+SPECIFIC_INDICATORS = [
+    r"\b\d+\.\d+",  # decimal numbers
+    r"\b\d{4}-\d{2}-\d{2}",  # dates
+    r"\b[A-Z][a-z]+\s[A-Z][a-z]+",  # proper nouns
+    r"`[^`]+`",  # code/commands
+    r"https?://",  # URLs
+    r"\b(example|instance|specifically|concretely)\b",
+    r"\b(step \d|first|second|third)\b",
+    r"\b(exactly|precisely|measured|counted)\b",
+]
+
+# Vagueness indicators (penalty)
+VAGUE_INDICATORS = [
+    r"\b(generally|usually|often|sometimes|might|could|perhaps)\b",
+    r"\b(various|several|many|some|few)\b",
+    r"\b(it depends|varies|differs)\b",
+    r"\b(basically|essentially|fundamentally)\b",
+    r"\b(everyone knows|it's obvious|clearly)\b",
+]
+
+# Actionability indicators
+ACTIONABLE_INDICATORS = [
+    r"\b(run|execute|install|deploy|configure|set up)\b",
+    r"\b(use|apply|implement|create|build)\b",
+    r"\b(check|verify|test|validate|confirm)\b",
+    r"\b(fix|resolve|solve|debug|troubleshoot)\b",
+    r"\b(if .+ then|when .+ do|to .+ use)\b",
+    r"```[a-z]*\n",  # code blocks
+    r"\$\s",  # shell commands
+    r"\b\d+\.\s",  # numbered steps
+]
+
+
+def score_specificity(content: str) -> float:
+    """Score specificity: 0=vague, 1=very specific."""
+    content_lower = content.lower()
+    score = 0.5  # baseline
+
+    # Check for specific indicators
+    specific_count = sum(
+        len(re.findall(p, content, re.IGNORECASE))
+        for p in SPECIFIC_INDICATORS
+    )
+
+    # Check for vague indicators
+    vague_count = sum(
+        len(re.findall(p, content_lower))
+        for p in VAGUE_INDICATORS
+    )
+
+    # Adjust score
+    score += min(specific_count * 0.05, 0.4)
+    score -= min(vague_count * 0.08, 0.3)
+
+    # Length bonus (longer = more detail, up to a point)
+    word_count = len(content.split())
+    if word_count > 50:
+        score += min((word_count - 50) * 0.001, 0.1)
+
+    return max(0.0, min(1.0, score))
+
+
+def score_actionability(content: str) -> float:
+    """Score actionability: 0=abstract, 1=highly actionable."""
+    content_lower = content.lower()
+    score = 0.3  # baseline (most knowledge is informational)
+
+    # Check for actionable indicators
+    actionable_count = sum(
+        len(re.findall(p, content_lower))
+        for p in ACTIONABLE_INDICATORS
+    )
+
+    score += min(actionable_count * 0.1, 0.6)
+
+    # Code blocks are highly actionable
+    if "```" in content:
+        score += 0.2
+
+    # Numbered steps are actionable
+    if re.search(r"\d+\.\s+\w", content):
+        score += 0.1
+
+    return max(0.0, min(1.0, score))
+
+
+def score_freshness(timestamp: Optional[str]) -> float:
+    """Score freshness: 1=new, decays over time."""
+    if not timestamp:
+        return 0.5
+
+    try:
+        if isinstance(timestamp, str):
+            ts = datetime.fromisoformat(timestamp.replace("Z", "+00:00"))
+        else:
+            ts = timestamp
+
+        now = datetime.now(timezone.utc)
+        age_days = (now - ts).days
+
+        # Exponential decay: 1.0 at day 0, 0.5 at ~180 days, 0.1 at ~365 days
+        score = math.exp(-age_days / 180)
+        return max(0.1, min(1.0, score))
+    except (ValueError, TypeError):
+        return 0.5
+
+
+def score_source_quality(model: Optional[str]) -> float:
+    """Score source quality based on model/provider."""
+    if not model:
+        return DEFAULT_SOURCE_QUALITY
+
+    # Normalize model name
+    model_lower = model.lower()
+    for key, score in SOURCE_QUALITY.items():
+        if key in model_lower:
+            return score
+
+    return DEFAULT_SOURCE_QUALITY
+
+
+def score_entry(entry: dict) -> float:
+    """
+    Score a knowledge entry on quality (0.0-1.0).
+
+    Weights:
+    - specificity: 0.3
+    - actionability: 0.3
+    - freshness: 0.2
+    - source_quality: 0.2
+    """
+    content = entry.get("content", entry.get("text", entry.get("response", "")))
+    model = entry.get("model", entry.get("provenance", {}).get("model"))
+    timestamp = entry.get("timestamp", entry.get("provenance", {}).get("timestamp"))
+
+    specificity = score_specificity(content)
+    actionability = score_actionability(content)
+    freshness = score_freshness(timestamp)
+    source = score_source_quality(model)
+
+    return round(
+        0.3 * specificity +
+        0.3 * actionability +
+        0.2 * freshness +
+        0.2 * source,
+        4
+    )
+
+
+def score_entry_detailed(entry: dict) -> dict:
+    """Score with breakdown."""
+    content = entry.get("content", entry.get("text", entry.get("response", "")))
+    model = entry.get("model", entry.get("provenance", {}).get("model"))
+    timestamp = entry.get("timestamp", entry.get("provenance", {}).get("timestamp"))
+
+    specificity = score_specificity(content)
+    actionability = score_actionability(content)
+    freshness = score_freshness(timestamp)
+    source = score_source_quality(model)
+
+    return {
+        "score": round(0.3 * specificity + 0.3 * actionability + 0.2 * freshness + 0.2 * source, 4),
+        "specificity": round(specificity, 4),
+        "actionability": round(actionability, 4),
+        "freshness": round(freshness, 4),
+        "source_quality": round(source, 4),
+    }
+
+
+def filter_entries(entries: List[dict], threshold: float = 0.5) -> List[dict]:
+    """Filter entries below quality threshold."""
+    filtered = []
+    for entry in entries:
+        if score_entry(entry) >= threshold:
+            filtered.append(entry)
+    return filtered
+
+
+def quality_report(entries: List[dict]) -> str:
+    """Generate quality distribution report."""
+    if not entries:
+        return "No entries to analyze."
+
+    scores = [score_entry(e) for e in entries]
+
+    avg = sum(scores) / len(scores)
+    min_score = min(scores)
+    max_score = max(scores)
+
+    # Distribution buckets
+    buckets = {"high": 0, "medium": 0, "low": 0, "rejected": 0}
+    for s in scores:
+        if s >= 0.7:
+            buckets["high"] += 1
+        elif s >= 0.5:
+            buckets["medium"] += 1
+        elif s >= 0.3:
+            buckets["low"] += 1
+        else:
+            buckets["rejected"] += 1
+
+    lines = [
+        "=" * 50,
+        "  QUALITY GATE REPORT",
+        "=" * 50,
+        f"  Total entries:  {len(entries)}",
+        f"  Average score:  {avg:.3f}",
+        f"  Min:            {min_score:.3f}",
+        f"  Max:            {max_score:.3f}",
+        "",
+        "  Distribution:",
+    ]
+
+    for bucket, count in buckets.items():
+        pct = count / len(entries) * 100
+        bar = "█" * int(pct / 5)
+        lines.append(f"    {bucket:<12} {count:>5} ({pct:>5.1f}%) {bar}")
+
+    passed = buckets["high"] + buckets["medium"]
+    lines.append(f"\n  Pass rate (>= 0.5): {passed}/{len(entries)} ({passed/len(entries)*100:.1f}%)")
+    lines.append("=" * 50)
+
+    return "\n".join(lines)
+
+
+def main():
+    import argparse
+    parser = argparse.ArgumentParser(description="Knowledge quality gate")
+    parser.add_argument("files", nargs="+", help="JSONL files to score")
+    parser.add_argument("--threshold", type=float, default=0.5, help="Quality threshold")
+    parser.add_argument("--json", action="store_true", help="JSON output")
+    parser.add_argument("--filter", action="store_true", help="Filter and write back")
+    args = parser.parse_args()
+
+    all_entries = []
+    for filepath in args.files:
+        with open(filepath) as f:
+            for line in f:
+                if line.strip():
+                    all_entries.append(json.loads(line))
+
+    if args.json:
+        results = [{"entry": e, **score_entry_detailed(e)} for e in all_entries]
+        print(json.dumps(results, indent=2))
+    elif args.filter:
+        filtered = filter_entries(all_entries, args.threshold)
+        print(f"Kept {len(filtered)}/{len(all_entries)} entries (threshold: {args.threshold})")
+    else:
+        print(quality_report(all_entries))
+
+
+if __name__ == "__main__":
+    main()

scripts/dependency_graph.py

@@ -149,8 +149,8 @@ def to_dot(graph: dict) -> str:
     """Generate DOT format output."""
     lines = ["digraph dependencies {"]
     lines.append("  rankdir=LR;")
-    lines.append('  node [shape=box, style=filled, fillcolor="#1a1a2e", fontcolor="#e6edf3"];')
-    lines.append('  edge [color="#4a4a6a"];')
+    lines.append("  node [shape=box, style=filled, fillcolor="#1a1a2e", fontcolor="#e6edf3"];")
+    lines.append("  edge [color="#4a4a6a"];")
     lines.append("")
 
     for repo, data in sorted(graph.items()):

scripts/readme_generator.py

@@ -0,0 +1,152 @@
+#!/usr/bin/env python3
+"""
+README Generator — Scan codebase and generate/update README.md.
+
+Reads codebase structure, extracts module docstrings and main entry points,
+produces a README with: description, installation, usage, API/scripts list.
+
+Usage:
+    python3 scripts/readme_generator.py
+    python3 scripts/readme_generator.py --dir /path/to/repo
+    python3 scripts/readme_generator.py --dry-run  # preview without writing
+"""
+import argparse
+import ast
+import json
+import sys
+from pathlib import Path
+from typing import List, Dict, Optional
+
+def read_file(path: Path) -> str:
+    try:
+        return path.read_text()
+    except Exception:
+        return ""
+
+def extract_module_docstring(path: Path) -> str:
+    try:
+        tree = ast.parse(read_file(path))
+        return ast.get_docstring(tree) or ""
+    except Exception:
+        return ""
+
+def extract_parser_description(path: Path) -> str:
+    """Extract the first ArgumentParser description found in the file."""
+    try:
+        content = read_file(path)
+        for line in content.split('\n'):
+            if 'ArgumentParser' in content[max(0,content.index(line)-100):content.index(line)+200] and 'description=' in line:
+                desc_part = line.split('description=')[1]
+                desc = desc_part.strip().rstrip(',').strip('"\'')
+                return desc
+        return ""
+    except Exception:
+        return ""
+
+def scan_python_files(root: Path) -> List[Dict]:
+    """Collect Python files (exclude tests) with basic metadata."""
+    files = []
+    for path in root.rglob('*.py'):
+        rel = path.relative_to(root)
+        parts = rel.parts
+        if any(p.startswith('test_') or p in ('__pycache__', '.git', 'venv', '.venv', '.pytest_cache') for p in parts):
+            continue
+        files.append({
+            'path': str(rel),
+            'docstring': extract_module_docstring(path),
+            'parser_desc': extract_parser_description(path),
+            'name': path.name,
+        })
+    return sorted(files, key=lambda x: x['path'])
+
+def detect_entry_point(file_info: Dict) -> bool:
+    """A file is an entry point if it has a main block or argparse."""
+    path = Path(file_info['path'])
+    name = path.name
+    return name in ('__main__.py', 'main.py') or bool(file_info['parser_desc']) or path.parts[0] == 'bin'
+
+def generate_readme(root_dir: str, output_path: Optional[str] = None, dry_run: bool = False) -> str:
+    root = Path(root_dir).resolve()
+    py_files = scan_python_files(root)
+    
+    sections = []
+    repo_name = root.name
+    
+    sections.append(f"# {repo_name}\n")
+    
+    if py_files:
+        main_doc = py_files[0]['docstring'].strip()
+        if main_doc:
+            sections.append(main_doc + "\n")
+        else:
+            sections.append("A Python project.\n")
+    else:
+        sections.append("A Python project.\n")
+    
+    sections.append("## Installation\n")
+    if (root / "requirements.txt").exists():
+        sections.append("```bash\ncp .env.example .env  # if present\npip install -r requirements.txt\n```\n")
+    elif (root / "pyproject.toml").exists():
+        sections.append("```bash\npip install -e .\n```\n")
+    else:
+        sections.append("```bash\npip install -e .\n```\n")
+    
+    sections.append("## Usage\n")
+    entry_scripts = [f for f in py_files if detect_entry_point(f)]
+    if entry_scripts:
+        for f in entry_scripts[:8]:
+            name = f['name']
+            if f['parser_desc']:
+                sections.append(f"### {name}\n{f['parser_desc']}\n")
+            else:
+                sections.append(f"### {name}\n```bash\npython3 {f['path']}\n```\n")
+    else:
+        sections.append("See `scripts/` directory for available tools.\n")
+    
+    sections.append("## Scripts\n")
+    if entry_scripts:
+        for f in entry_scripts[:15]:
+            desc = f['docstring'].strip().split('\n')[0] if f['docstring'].strip() else "Utility script."
+            sections.append(f"- **{f['name']}**: {desc}")
+    else:
+        sections.append("- No entry-point scripts detected.\n")
+    
+    sections.append("\n## Directory Structure\n")
+    top_dirs = sorted([
+        d.name for d in root.iterdir()
+        if d.is_dir() and not d.name.startswith('.') and d.name not in ('__pycache__', 'venv', '.venv', 'node_modules')
+    ])
+    sections.append("```\n")
+    for d in top_dirs[:12]:
+        sections.append(f"{d}/")
+    sections.append("```\n")
+    
+    readme_content = "\n".join(sections)
+    
+    if dry_run:
+        print(json.dumps({
+            "repo": repo_name,
+            "sections": len(sections),
+            "chars": len(readme_content),
+            "python_files": len(py_files),
+            "entry_scripts": sum(1 for f in py_files if detect_entry_point(f)),
+        }, indent=2))
+        return ""
+    
+    if output_path is None:
+        output_path = root / "README.md"
+    else:
+        output_path = Path(output_path)
+    
+    output_path.write_text(readme_content)
+    print(f"README {'updated' if output_path.exists() else 'created'}: {output_path} ({len(readme_content)} bytes)")
+    return str(output_path)
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Generate or update README.md from codebase structure.")
+    parser.add_argument("--dir", default=".", help="Directory to scan (default: current)")
+    parser.add_argument("--output", help="Output README path (default: README.md in scanned dir)")
+    parser.add_argument("--dry-run", action="store_true", help="Preview without writing")
+    args = parser.parse_args()
+    
+    generate_readme(args.dir, args.output, args.dry_run)

tests/test_quality_gate.py

@@ -0,0 +1,108 @@
+"""
+Tests for quality_gate.py — Knowledge entry quality scoring.
+"""
+
+import unittest
+from datetime import datetime, timezone, timedelta
+
+import sys
+from pathlib import Path
+sys.path.insert(0, str(Path(__file__).parent.parent))
+
+from quality_gate import (
+    score_specificity,
+    score_actionability,
+    score_freshness,
+    score_source_quality,
+    score_entry,
+    filter_entries,
+)
+
+
+class TestScoreSpecificity(unittest.TestCase):
+    def test_specific_content_scores_high(self):
+        content = "Run `python3 deploy.py --env prod` on 2026-04-15. Example: step 1 configure nginx."
+        score = score_specificity(content)
+        self.assertGreater(score, 0.6)
+
+    def test_vague_content_scores_low(self):
+        content = "It generally depends. Various factors might affect this. Basically, it varies."
+        score = score_specificity(content)
+        self.assertLess(score, 0.5)
+
+    def test_empty_scores_baseline(self):
+        score = score_specificity("")
+        self.assertAlmostEqual(score, 0.5, delta=0.1)
+
+
+class TestScoreActionability(unittest.TestCase):
+    def test_actionable_content_scores_high(self):
+        content = "1. Run `pip install -r requirements.txt`\n2. Execute `python3 train.py`\n3. Verify with `pytest`"
+        score = score_actionability(content)
+        self.assertGreater(score, 0.6)
+
+    def test_abstract_content_scores_low(self):
+        content = "The concept of intelligence is fascinating and multifaceted."
+        score = score_actionability(content)
+        self.assertLess(score, 0.5)
+
+
+class TestScoreFreshness(unittest.TestCase):
+    def test_recent_timestamp_scores_high(self):
+        recent = datetime.now(timezone.utc).isoformat()
+        score = score_freshness(recent)
+        self.assertGreater(score, 0.9)
+
+    def test_old_timestamp_scores_low(self):
+        old = (datetime.now(timezone.utc) - timedelta(days=365)).isoformat()
+        score = score_freshness(old)
+        self.assertLess(score, 0.2)
+
+    def test_none_returns_baseline(self):
+        score = score_freshness(None)
+        self.assertEqual(score, 0.5)
+
+
+class TestScoreSourceQuality(unittest.TestCase):
+    def test_claude_scores_high(self):
+        self.assertGreater(score_source_quality("claude-sonnet"), 0.85)
+
+    def test_ollama_scores_lower(self):
+        self.assertLess(score_source_quality("ollama"), 0.7)
+
+    def test_unknown_returns_default(self):
+        self.assertEqual(score_source_quality("unknown"), 0.5)
+
+
+class TestScoreEntry(unittest.TestCase):
+    def test_good_entry_scores_high(self):
+        entry = {
+            "content": "To deploy: run `kubectl apply -f deployment.yaml`. Verify with `kubectl get pods`.",
+            "model": "claude-sonnet",
+            "timestamp": datetime.now(timezone.utc).isoformat(),
+        }
+        score = score_entry(entry)
+        self.assertGreater(score, 0.6)
+
+    def test_poor_entry_scores_low(self):
+        entry = {
+            "content": "It depends. Various things might happen.",
+            "model": "unknown",
+        }
+        score = score_entry(entry)
+        self.assertLess(score, 0.5)
+
+
+class TestFilterEntries(unittest.TestCase):
+    def test_filters_low_quality(self):
+        entries = [
+            {"content": "Run `deploy.py` to fix the issue.", "model": "claude"},
+            {"content": "It might work sometimes.", "model": "unknown"},
+            {"content": "Configure nginx: step 1 edit nginx.conf", "model": "gpt-4"},
+        ]
+        filtered = filter_entries(entries, threshold=0.5)
+        self.assertGreaterEqual(len(filtered), 2)
+
+
+if __name__ == "__main__":
+    unittest.main()