beacon-framework 1.2.0__tar.gz → 1.2.2__tar.gz

{beacon_framework-1.2.0 → beacon_framework-1.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: beacon-framework
-Version: 1.2.0
+Version: 1.2.2
 Summary: Light-touch, pragmatic, artifact-driven framework for AI-assisted software delivery
 Project-URL: Repository, https://github.com/darth-veitcher/beacon
 Author: darth-veitcher

{beacon_framework-1.2.0 → beacon_framework-1.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "beacon-framework"
-version = "1.2.0"
+version = "1.2.2"
 description = "Light-touch, pragmatic, artifact-driven framework for AI-assisted software delivery"
 readme = "README.md"
 license = "MIT"
@@ -74,6 +74,8 @@ Repository = "https://github.com/darth-veitcher/beacon"
 
 
 
+
+
 
 
 
@@ -181,6 +183,8 @@ exclude_commit_patterns = ["^chore\\(release\\):"]
 
 
 
+
+
 
 
 

{beacon_framework-1.2.0 → beacon_framework-1.2.2}/src/beacon/__init__.py

@@ -1,3 +1,3 @@
 """BEACON Framework: lifecycle and discipline for artifact-driven AI-assisted delivery."""
 
-__version__ = "1.2.0"
+__version__ = "1.2.2"

{beacon_framework-1.2.0 → beacon_framework-1.2.2}/src/beacon/cli.py

@@ -1281,9 +1281,10 @@ def roadmap_export(
     Markdown document. Safe to commit alongside beacon.md; regenerate on demand or
     wire into CI with ``beacon roadmap export``.
     """
-    from beacon import roadmap as _roadmap
     from datetime import date
 
+    from beacon import roadmap as _roadmap
+
     root = _resolve_root(here, path)
     if not (root / "project-management").is_dir():
         console.print(f"[red]✗[/red] Not a BEACON project at [cyan]{root}[/cyan].")
@@ -1300,14 +1301,21 @@ def roadmap_export(
         return
     dest = output or (root / "ROADMAP.md")
     dest.write_text(content, encoding="utf-8")
-    console.print(
-        f"[green]✓[/green] Roadmap exported → [cyan]{dest.relative_to(root)}[/cyan]"
-    )
+    console.print(f"[green]✓[/green] Roadmap exported → [cyan]{dest.relative_to(root)}[/cyan]")
     if not data.epics:
-        console.print(
-            f"[dim]  (project-management/Roadmap/epics/ has no epics yet"
-            f" — run [/dim][dim cyan]beacon epic new <slug>[/dim cyan][dim])[/dim]"
-        )
+        if data.archived_epics and not include_done:
+            n = len(data.archived_epics)
+            plural = "s" if n > 1 else ""
+            console.print(
+                f"[dim]  ({n} archived epic{plural}"
+                " — run [/dim][dim cyan]beacon roadmap export --include-done"
+                "[/dim cyan][dim] to include completed work)[/dim]"
+            )
+        elif not data.archived_epics:
+            console.print(
+                "[dim]  (project-management/Roadmap/epics/ has no epics yet"
+                " — run [/dim][dim cyan]beacon epic new <slug>[/dim cyan][dim])[/dim]"
+            )
 
 
 @roadmap_app.command("render")
@@ -1325,9 +1333,10 @@ def roadmap_render(
     design system (dark, blueprint-grid, engineering-whitepaper aesthetic). Open
     directly in a browser, screenshot into a slide deck, or host as a static page.
     """
-    from beacon import roadmap as _roadmap
     from datetime import date
 
+    from beacon import roadmap as _roadmap
+
     root = _resolve_root(here, path)
     if not (root / "project-management").is_dir():
         console.print(f"[red]✗[/red] Not a BEACON project at [cyan]{root}[/cyan].")
@@ -1341,9 +1350,7 @@ def roadmap_render(
     content = _roadmap.render_html(data, today)
     dest = output or (root / "ROADMAP.html")
     dest.write_text(content, encoding="utf-8")
-    console.print(
-        f"[green]✓[/green] Roadmap rendered → [cyan]{dest.relative_to(root)}[/cyan]"
-    )
+    console.print(f"[green]✓[/green] Roadmap rendered → [cyan]{dest.relative_to(root)}[/cyan]")
     console.print(
         "[dim]i[/dim]  Add [dim]ROADMAP.html[/dim] to [dim].gitignore[/dim] "
         "to keep it out of version control."

{beacon_framework-1.2.0 → beacon_framework-1.2.2}/src/beacon/epic.py

@@ -162,8 +162,8 @@ def _extract_list_under_header(content: str, header: str) -> list[str]:
         if in_section:
             m = _LIST_ITEM_RE.match(line)
             if m and not m.group("body").startswith("<!--"):
-                # Strip trailing "  — description" so we get just the path / file ref
-                body = m.group("body").split("  —", 1)[0].split("  --", 1)[0].strip()
+                # Strip trailing " — description" (em dash with any surrounding spaces)
+                body = m.group("body").split("—", 1)[0].split("  --", 1)[0].strip()
                 items.append(body.rstrip("/"))
     return items
 

{beacon_framework-1.2.0 → beacon_framework-1.2.2}/src/beacon/roadmap.py

@@ -72,6 +72,7 @@ class RoadmapData:
     fidelity: dict[str, EpicFidelity]
     adrs: list[AdrSummary]
     in_flight_bullets: list  # list[Bullet] — avoid circular import
+    archived_epics: list[Epic] = field(default_factory=list)
 
 
 # ---------------------------------------------------------------------------
@@ -168,10 +169,10 @@ def _task_pct(root: Path, epic: Epic) -> int | None:
 
 
 def _fidelity_badge(f: EpicFidelity) -> str:
-    """Return ASCII fidelity string like 'S+ A+ T:67%' or 'S? A? T:–'."""
+    """Return ASCII fidelity string like 'S+ A+ T:67%' or 'S? A? T:-'."""
     spec = "S+" if f.has_specs else "S?"
     adr = "A+" if f.has_adrs else "A?"
-    task = f"T:{f.task_pct}%" if f.task_pct is not None else "T:–"
+    task = f"T:{f.task_pct}%" if f.task_pct is not None else "T:-"
     return f"{spec} {adr} {task}"
 
 
@@ -257,9 +258,7 @@ def _mermaid_gantt_src(
             else:
                 tag = ""
             safe_title = e.title.replace(":", " -").replace(",", " ")
-            lines.append(
-                f"    {safe_title} :{tag}{e.slug}, {start}, {dur}d"
-            )
+            lines.append(f"    {safe_title} :{tag}{e.slug}, {start}, {dur}d")
         lines.append("")
 
     return "\n".join(lines)
@@ -273,7 +272,11 @@ def _markdown_status_table(
     """Render the epic status Markdown table."""
     rows = ["| Epic | Title | Status | Specs | Fidelity |", "|---|---|---|---|---|"]
     for e in epics:
-        link = f"[{e.slug}](project-management/Roadmap/epics/{e.slug}.md)"
+        if e.path.parent.name == "archive":
+            path_rel = f"project-management/Roadmap/epics/archive/{e.slug}.md"
+        else:
+            path_rel = f"project-management/Roadmap/epics/{e.slug}.md"
+        link = f"[{e.slug}]({path_rel})"
         roll = rollups.get(e.slug)
         if roll and roll.total > 0:
             specs_col = f"{len(roll.shipped)}/{roll.total} shipped"
@@ -289,33 +292,36 @@ def _markdown_status_table(
 
 def _to_json_data(data: RoadmapData, generated_at: str, *, include_done: bool = False) -> dict:
     """Serialise RoadmapData to the shape embedded in ROADMAP.html."""
+    all_epics = data.epics + (data.archived_epics if include_done else [])
     epics_list = []
-    for e in data.epics:
+    for e in all_epics:
         if not include_done and e.status == "Done":
             continue
         roll = data.rollups.get(e.slug)
         f = data.fidelity.get(e.slug)
         dur = max(7, (len(roll.in_flight) + len(roll.missing)) * 7) if roll else 7
-        epics_list.append({
-            "slug": e.slug,
-            "title": e.title,
-            "status": e.status,
-            "started": e.started or "",
-            "specs_total": roll.total if roll else 0,
-            "specs_shipped": len(roll.shipped) if roll else 0,
-            "specs_in_flight": len(roll.in_flight) if roll else 0,
-            "has_adrs": f.has_adrs if f else False,
-            "adr_count": f.adr_count if f else 0,
-            "task_pct": f.task_pct if f else None,
-            "fidelity_badge": _fidelity_badge(f) if f else "—",
-            "duration_days": dur,
-        })
+        epics_list.append(
+            {
+                "slug": e.slug,
+                "title": e.title,
+                "status": e.status,
+                "started": e.started or "",
+                "specs_total": roll.total if roll else 0,
+                "specs_shipped": len(roll.shipped) if roll else 0,
+                "specs_in_flight": len(roll.in_flight) if roll else 0,
+                "has_adrs": f.has_adrs if f else False,
+                "adr_count": f.adr_count if f else 0,
+                "task_pct": f.task_pct if f else None,
+                "fidelity_badge": _fidelity_badge(f) if f else "—",
+                "duration_days": dur,
+            }
+        )
 
     # Deduplicate ADRs and attach which epics reference each
     adr_epics: dict[str, list[str]] = {}
     for adr in data.adrs:
         adr_epics.setdefault(adr.token, [])
-    for e in data.epics:
+    for e in all_epics:
         for adr_path in e.adrs:
             m = _ADR_TOKEN_RE.search(adr_path)
             if m:
@@ -347,20 +353,22 @@ def _to_json_data(data: RoadmapData, generated_at: str, *, include_done: bool =
 
     # Build gantt_bars for D3
     gantt_bars = []
-    for e in data.epics:
+    for e in all_epics:
         if not include_done and e.status == "Done":
             continue
         if not e.started:
             continue
         roll = data.rollups.get(e.slug)
         dur = max(7, (len(roll.in_flight) + len(roll.missing)) * 7) if roll else 7
-        gantt_bars.append({
-            "slug": e.slug,
-            "title": e.title,
-            "status": e.status,
-            "started": e.started,
-            "duration_days": dur,
-        })
+        gantt_bars.append(
+            {
+                "slug": e.slug,
+                "title": e.title,
+                "status": e.status,
+                "started": e.started,
+                "duration_days": dur,
+            }
+        )
 
     return {
         "project_name": data.project_name,
@@ -384,13 +392,14 @@ def collect(root: Path) -> RoadmapData:
     from beacon import epic as _epic
 
     epics = _epic.list_active(root)
+    archived = _epic.list_archived(root)
     rollups: dict[str, Rollup] = {}
     fidelity_map: dict[str, EpicFidelity] = {}
 
-    # Collect ADRs deduplicating across all epics
+    # Collect ADRs deduplicating across all epics (active + archived)
     seen_adrs: dict[str, AdrSummary] = {}  # token → summary
 
-    for e in epics:
+    for e in epics + archived:
         try:
             roll = _epic.rollup(root, e)
         except Exception:
@@ -435,6 +444,7 @@ def collect(root: Path) -> RoadmapData:
         fidelity=fidelity_map,
         adrs=adrs,
         in_flight_bullets=bullets,
+        archived_epics=archived,
     )
 
 
@@ -455,27 +465,51 @@ def render_markdown(
         lines.append(f"> {data.vision_excerpt}")
         lines.append("")
 
-    if not data.epics:
-        lines.append(
-            "_No epics declared yet. Run `beacon epic new <slug> --title \"<title>\"` to start._"
-        )
+    visible_epics = data.epics + (data.archived_epics if include_done else [])
+
+    if not visible_epics:
+        if data.archived_epics:
+            n = len(data.archived_epics)
+            plural = "s" if n > 1 else ""
+            lines.append(
+                f"_No active epics — {n} epic{plural} archived. "
+                f"Run `beacon roadmap export --include-done` to include completed work._"
+            )
+        else:
+            lines.append(
+                '_No epics declared yet. Run `beacon epic new <slug> --title "<title>"` to start._'
+            )
+        # Still render ADR section if there are any (e.g. from archived epics)
+        if data.adrs:
+            lines.append("")
+            lines.append("## Architectural Decisions")
+            lines.append("")
+            lines.append("| ADR | Title | Status |")
+            lines.append("|---|---|---|")
+            for a in data.adrs:
+                link = f"[{a.token}]({a.path})"
+                lines.append(f"| {link} | {a.title} | {a.status} |")
+            lines.append("")
         return "\n".join(lines)
 
     # Mermaid Gantt
     lines.append("## Timeline")
     lines.append("")
     lines.append("```mermaid")
-    lines.append(_mermaid_gantt_src(data.epics, data.rollups, generated_at, include_done=include_done))
+    lines.append(
+        _mermaid_gantt_src(visible_epics, data.rollups, generated_at, include_done=include_done)
+    )
     lines.append("```")
     lines.append("")
 
     # Epic status table
     lines.append("## Epics")
     lines.append("")
-    lines.append(_markdown_status_table(data.epics, data.rollups, data.fidelity))
+    lines.append(_markdown_status_table(visible_epics, data.rollups, data.fidelity))
     lines.append("")
     lines.append(
-        "_Fidelity: `S+/S?` = has specs / none · `A+/A?` = has ADRs / none · `T:N%` = task completion_"
+        "_Fidelity: `S+/S?` = has specs / none"
+        " · `A+/A?` = has ADRs / none · `T:N%` = task completion_"
     )
     lines.append("")
 
@@ -516,10 +550,7 @@ def render_html(data: RoadmapData, generated_at: str) -> str:
     from importlib import resources as _res
 
     template_bytes = (
-        _res.files("beacon")
-        .joinpath("resources")
-        .joinpath("roadmap_template.html")
-        .read_bytes()
+        _res.files("beacon").joinpath("resources").joinpath("roadmap_template.html").read_bytes()
     )
     template = template_bytes.decode("utf-8")