"""Report writer: JSON + self-contained HTML dashboard, with run-over-run diffs."""
from __future__ import annotations
import json
import re
import datetime
from pathlib import Path
from . import remediate
def overall_score(report: dict, weights: dict) -> float:
parts = {
"technical": report.get("technical", {}).get("avg_score", 0),
"ai_readiness": report.get("geo", {}).get("avg_score", 0),
"content": report.get("content", {}).get("avg_score", 0),
"lead_gen": report.get("lead_gen", {}).get("avg_score", 0),
}
return round(sum(parts[k] * weights.get(k, 0) for k in parts), 1)
def save_reports(report: dict, out_dir: str, formats: list[str], keep: int = 30) -> list[str]:
out = Path(out_dir)
out.mkdir(parents=True, exist_ok=True)
stamp = datetime.datetime.now().strftime("%Y%m%d_%H%M%S")
site_slug = report["site"]["name"].lower().replace(" ", "-")
written = []
if "json" in formats:
p = out / f"{site_slug}_{stamp}.json"
p.write_text(json.dumps(report, indent=2, default=str), encoding="utf-8")
written.append(str(p))
if "html" in formats:
p = out / f"{site_slug}_{stamp}.html"
p.write_text(render_html(report), encoding="utf-8")
written.append(str(p))
# prune history
history = sorted(out.glob(f"{site_slug}_*.json"))
for old in history[:-keep]:
old.unlink(missing_ok=True)
return written
def load_previous(out_dir: str, site_name: str) -> dict | None:
out = Path(out_dir)
slug = site_name.lower().replace(" ", "-")
history = sorted(out.glob(f"{slug}_*.json"))
if len(history) >= 2:
return json.loads(history[-2].read_text(encoding="utf-8"))
return None
def diff_reports(prev: dict, curr: dict) -> dict:
d = {}
for section in ("technical", "geo", "content", "lead_gen"):
p = prev.get(section, {}).get("avg_score", 0)
c = curr.get(section, {}).get("avg_score", 0)
d[section] = {"previous": p, "current": c, "delta": round(c - p, 1)}
d["overall"] = {"previous": prev.get("overall_score", 0),
"current": curr.get("overall_score", 0),
"delta": round(curr.get("overall_score", 0)
- prev.get("overall_score", 0), 1)}
return d
def render_html(r: dict) -> str:
def bar(label, val, color):
return (f"
{label}"
f"
{val}
")
def badge(tag: str) -> str:
is_auto = tag.startswith("auto-fixable") or tag.startswith("partly auto-fixable")
is_broken = tag.startswith("your call")
color = "#9c7830" if is_auto else "#b23b32" if is_broken else "#6b6f78"
bg = "#f6ecd8" if is_auto else "#fbe9e7" if is_broken else "#eee"
return (f"{tag}")
def split_tag(text: str) -> tuple[str, str | None]:
m = re.match(r"^(.*?)\s*\[(.*?)\]\s*$", text)
return (m.group(1), m.group(2)) if m else (text, None)
recs = []
for sec in ("geo", "lead_gen"):
for page in r.get(sec, {}).get("pages", []):
recs.extend(page.get("recommendations", []))
recs = list(dict.fromkeys(recs))[:12]
recs_html = "".join(
f"
{txt}{badge(tag) if tag else ''}
"
for txt, tag in (split_tag(x) for x in recs)
) or "
All good!
"
issues = []
for page in r.get("technical", {}).get("pages", []):
for i in page.get("issues", []):
issues.append((page["url"], i, remediate.classify_issue(i)))
issues_html = "".join(
f"
{url} \u2014 {issue}{badge(tag)}
"
for url, issue, tag in issues[:20]
) or "
None \U0001F389
"
diff_html = ""
if r.get("diff"):
rows = "".join(
f"
{k}
{v['previous']}
{v['current']}
"
f"
=0 else '#c62828'}'>"
f"{'+' if v['delta']>=0 else ''}{v['delta']}
Gold badge = the tool can apply this automatically once you approve it.
Gray badge = needs a real content/design decision only you can make. Red badge = a broken
link needing your call on whether to restore or remove it.