fabgate 0.1.0__tar.gz

fabgate-0.1.0/.gitignore

@@ -0,0 +1,13 @@
+.venv/
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+*.html
+reports/
+.kitty/
+.env

fabgate-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 coderlifevyn12
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fabgate-0.1.0/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: fabgate
+Version: 0.1.0
+Summary: Pre-fab PCB design review and release gate for KiCad boards
+Project-URL: Homepage, https://pypi.org/project/fabgate/
+Project-URL: Repository, https://github.com/coderlifevyn12/fabgate
+Author: coderlifevyn12
+License-Expression: MIT
+License-File: LICENSE
+Keywords: dfm,drc,emc,hardware,kicad,pcb,release-gate
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
+Requires-Python: >=3.11
+Requires-Dist: pydantic-settings>=2.3.0
+Requires-Dist: pydantic>=2.7.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.7.0
+Requires-Dist: typer>=0.12.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Provides-Extra: emcopilot
+Requires-Dist: matplotlib>=3.10.8; extra == 'emcopilot'
+Requires-Dist: mcp>=1.0.0; extra == 'emcopilot'
+Description-Content-Type: text/markdown
+
+# FabGate
+
+Pre-fab PCB design review and release gate for KiCad boards.
+
+**v0.1** — evaluate your board, get a scored pass/hold/fail report, and a fix checklist before fabrication.
+
+## Prerequisites
+
+- [Python 3.11+](https://www.python.org/downloads/)
+- [KiCad 9+](https://www.kicad.org/download/) with `kicad-cli` available
+
+## Install
+
+```powershell
+pip install fabgate
+```
+
+Optional deep physics review (EMC / power / signal integrity):
+
+```powershell
+pip install "fabgate[emcopilot]"
+```
+
+## Quick start
+
+```powershell
+# Check toolchain
+fabgate doctor
+
+# Review an existing KiCad project
+fabgate evaluate "C:\path\to\your-kicad-project"
+
+# CI / release gate (exit 0=pass, 1=hold, 2=fail)
+fabgate gate "C:\path\to\your-kicad-project"
+
+# Open board in KiCad
+fabgate open "C:\path\to\your-kicad-project"
+```
+
+Reports are written to `reports/` as HTML + JSON.
+
+## What it checks
+
+| Check | Engine |
+|-------|--------|
+| DRC violations | KiCad `kicad-cli` |
+| Schematic parity | KiCad |
+| EMC / power / SI physics | emcopilot (optional) |
+| Scoring + pass/hold/fail | FabGate rules |
+
+FabGate does **not** call an LLM. It uses deterministic KiCad and physics-based analyzers.
+
+## Commands
+
+| Command | Purpose |
+|---------|---------|
+| `fabgate doctor` | Check KiCad CLI + optional emcopilot |
+| `fabgate evaluate` | Full evaluation + HTML report |
+| `fabgate review` | Basic review |
+| `fabgate gate` | CI exit code |
+| `fabgate optimize run` | Optimization plan + safe auto-fixes |
+| `fabgate auto run` | Autonomous optimize loop (with rollback guardrail) |
+| `fabgate design create` | Scaffold new KiCad project |
+| `fabgate workflow` | Design → evaluate → optimize |
+| `fabgate open` | Open in KiCad GUI |
+
+## Development install
+
+```powershell
+git clone <repo-url>
+cd fabgate
+python -m venv .venv
+.\.venv\Scripts\Activate.ps1
+pip install -e ".[dev,emcopilot]"
+fabgate doctor
+```
+
+## License
+
+MIT

fabgate-0.1.0/README.md

@@ -0,0 +1,80 @@
+# FabGate
+
+Pre-fab PCB design review and release gate for KiCad boards.
+
+**v0.1** — evaluate your board, get a scored pass/hold/fail report, and a fix checklist before fabrication.
+
+## Prerequisites
+
+- [Python 3.11+](https://www.python.org/downloads/)
+- [KiCad 9+](https://www.kicad.org/download/) with `kicad-cli` available
+
+## Install
+
+```powershell
+pip install fabgate
+```
+
+Optional deep physics review (EMC / power / signal integrity):
+
+```powershell
+pip install "fabgate[emcopilot]"
+```
+
+## Quick start
+
+```powershell
+# Check toolchain
+fabgate doctor
+
+# Review an existing KiCad project
+fabgate evaluate "C:\path\to\your-kicad-project"
+
+# CI / release gate (exit 0=pass, 1=hold, 2=fail)
+fabgate gate "C:\path\to\your-kicad-project"
+
+# Open board in KiCad
+fabgate open "C:\path\to\your-kicad-project"
+```
+
+Reports are written to `reports/` as HTML + JSON.
+
+## What it checks
+
+| Check | Engine |
+|-------|--------|
+| DRC violations | KiCad `kicad-cli` |
+| Schematic parity | KiCad |
+| EMC / power / SI physics | emcopilot (optional) |
+| Scoring + pass/hold/fail | FabGate rules |
+
+FabGate does **not** call an LLM. It uses deterministic KiCad and physics-based analyzers.
+
+## Commands
+
+| Command | Purpose |
+|---------|---------|
+| `fabgate doctor` | Check KiCad CLI + optional emcopilot |
+| `fabgate evaluate` | Full evaluation + HTML report |
+| `fabgate review` | Basic review |
+| `fabgate gate` | CI exit code |
+| `fabgate optimize run` | Optimization plan + safe auto-fixes |
+| `fabgate auto run` | Autonomous optimize loop (with rollback guardrail) |
+| `fabgate design create` | Scaffold new KiCad project |
+| `fabgate workflow` | Design → evaluate → optimize |
+| `fabgate open` | Open in KiCad GUI |
+
+## Development install
+
+```powershell
+git clone <repo-url>
+cd fabgate
+python -m venv .venv
+.\.venv\Scripts\Activate.ps1
+pip install -e ".[dev,emcopilot]"
+fabgate doctor
+```
+
+## License
+
+MIT

fabgate-0.1.0/config/default_rules.yaml

@@ -0,0 +1,36 @@
+# Kitty Release Gate — default scoring rules (v1)
+# Severity: blocking | warning | info
+
+version: "1.0"
+
+thresholds:
+  pass_score: 80
+  hold_score: 60
+
+weights:
+  blocking: 12
+  warning: 3
+  info: 1
+
+# Prevent large boards with many cosmetic DRC items from scoring 0/100.
+penalty_caps:
+  blocking: 48
+  warning: 36
+  info: 12
+
+categories:
+  - id: drc
+    label: Design Rule Check
+    enabled: true
+  - id: emc
+    label: EMC Pre-Compliance
+    enabled: true
+  - id: si
+    label: Signal Integrity
+    enabled: true
+  - id: pi
+    label: Power Integrity
+    enabled: true
+  - id: dfm
+    label: Design for Manufacturing
+    enabled: true

fabgate-0.1.0/config/design_spec.example.yaml

@@ -0,0 +1,24 @@
+# Kitty design spec — used by: kitty design create --spec design_spec.yaml
+
+name: my-carrier-board
+company: Acme Corp
+
+# Board outline (mm)
+width_mm: 80
+height_mm: 60
+layers: 4          # 2 or 4
+thickness_mm: 1.6
+
+# Design intent (drives stackup / review recommendations)
+interfaces:
+  - usb
+  - ethernet
+  - gpio
+
+power_rails:
+  - "+3V3"
+  - "+5V"
+  - GND
+
+notes: |
+  Carrier board for module X. Target 4-layer stackup with solid GND plane.

fabgate-0.1.0/config/product.yaml

@@ -0,0 +1,13 @@
+# Kitty Release Gate — product configuration
+product:
+  name: "Kitty Release Gate"
+  version: "0.3.0"
+  tagline: "Autonomous PCB design, evaluation, and optimization release gate"
+
+report:
+  company_name: ""          # set via kitty init or edit here
+  footer: "Advisory report — engineering sign-off required before fabrication."
+
+audit:
+  enabled: true
+  directory: ".kitty/audit"

fabgate-0.1.0/pyproject.toml

@@ -0,0 +1,64 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "fabgate"
+version = "0.1.0"
+description = "Pre-fab PCB design review and release gate for KiCad boards"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.11"
+authors = [
+    { name = "coderlifevyn12" },
+]
+keywords = ["pcb", "kicad", "drc", "emc", "dfm", "release-gate", "hardware"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)",
+]
+dependencies = [
+    "pydantic>=2.7.0",
+    "pydantic-settings>=2.3.0",
+    "pyyaml>=6.0",
+    "rich>=13.7.0",
+    "typer>=0.12.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "ruff>=0.4.0",
+]
+emcopilot = [
+    "matplotlib>=3.10.8",
+    "mcp>=1.0.0",
+]
+
+[project.urls]
+Homepage = "https://pypi.org/project/fabgate/"
+Repository = "https://github.com/coderlifevyn12/fabgate"
+
+[project.scripts]
+fabgate = "kitty.cli:app"
+
+[tool.hatch.build.targets.wheel]
+packages = ["kitty"]
+
+[tool.hatch.build.targets.wheel.force-include]
+"src/kitty" = "kitty"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"

fabgate-0.1.0/src/kitty/__init__.py

@@ -0,0 +1,3 @@
+"""FabGate — pre-fab PCB review and release gate."""
+
+__version__ = "0.1.0"

fabgate-0.1.0/src/kitty/__main__.py

@@ -0,0 +1,3 @@
+from kitty.cli import app
+
+app()

fabgate-0.1.0/src/kitty/analyzers/__init__.py

@@ -0,0 +1,29 @@
+from kitty.analyzers.base import Analyzer
+from kitty.analyzers.emcopilot import EmcopilotAnalyzer
+from kitty.analyzers.gerber_dfm import GerberDfmAnalyzer
+from kitty.analyzers.kicad_drc import KiCadDrcAnalyzer
+from kitty.analyzers.layout_rules import LayoutRulesAnalyzer
+from kitty.analyzers.stub import StubAnalyzer
+from kitty.emcopilot_client import emcopilot_available
+
+__all__ = [
+    "Analyzer",
+    "EmcopilotAnalyzer",
+    "GerberDfmAnalyzer",
+    "KiCadDrcAnalyzer",
+    "LayoutRulesAnalyzer",
+    "StubAnalyzer",
+    "default_analyzers",
+]
+
+
+def default_analyzers() -> list[Analyzer]:
+    analyzers: list[Analyzer] = [
+        KiCadDrcAnalyzer(),
+        LayoutRulesAnalyzer(),
+        GerberDfmAnalyzer(),
+        EmcopilotAnalyzer(),
+    ]
+    if not emcopilot_available():
+        analyzers.append(StubAnalyzer("si", "Signal Integrity", "si"))
+    return analyzers

fabgate-0.1.0/src/kitty/analyzers/base.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from pathlib import Path
+
+from kitty.models import AnalyzerResult, LayoutFormat
+
+
+class Analyzer(ABC):
+    analyzer_id: str
+    analyzer_name: str
+
+    @abstractmethod
+    def supports(self, layout_format: LayoutFormat) -> bool:
+        raise NotImplementedError
+
+    @abstractmethod
+    def run(self, layout_path: Path, layout_format: LayoutFormat) -> AnalyzerResult:
+        raise NotImplementedError

fabgate-0.1.0/src/kitty/analyzers/drc_severity.py

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+from kitty.models import Severity
+
+# KiCad DRC types that are fab-critical — always treat as blocking when KiCad says error.
+DRC_CRITICAL_TYPES = {
+    "copper_edge_clearance",
+    "clearance",
+    "shorting_items",
+    "unconnected_items",
+    "unconnected",
+    "zones_intersect",
+    "zone_has_empty_net",
+    "invalid_outline",
+    "malformed_courtyard",
+    "duplicate_footprints",
+    "lib_footprint_mismatch",
+    "lib_footprint_issues",
+    "track_dangling",
+    "via_dangling",
+}
+
+# Cosmetic / documentation checks — downgrade KiCad warnings to info for release scoring.
+DRC_COSMETIC_TYPES = {
+    "solder_mask_bridge",
+    "silk_overlap",
+    "silk_edge_clearance",
+    "silk_over_copper",
+    "text_thickness",
+    "text_height",
+    "gr_text",
+    "duplicate_silkscreen",
+    "silkscreen_over_copper",
+}
+
+
+def map_kicad_drc_severity(*, kicad_severity: str, violation_type: str) -> Severity:
+    normalized = (kicad_severity or "error").lower()
+    vtype = (violation_type or "").lower()
+
+    if normalized == "error":
+        if vtype in DRC_COSMETIC_TYPES:
+            return Severity.WARNING
+        return Severity.BLOCKING
+
+    if vtype in DRC_CRITICAL_TYPES:
+        return Severity.WARNING
+    if vtype in DRC_COSMETIC_TYPES:
+        return Severity.INFO
+    return Severity.WARNING

fabgate-0.1.0/src/kitty/analyzers/emcopilot.py

@@ -0,0 +1,92 @@
+from __future__ import annotations
+
+import time
+from pathlib import Path
+
+from kitty.analyzers.base import Analyzer
+from kitty.emcopilot_client import (
+    EMCOPILOT_INSTALL,
+    emcopilot_available,
+    emcopilot_finding_to_kitty,
+    run_emcopilot_review,
+)
+from kitty.models import AnalyzerResult, Finding, LayoutFormat, Severity
+
+
+class EmcopilotAnalyzer(Analyzer):
+    """Physics-based EMC / SI / PI review via mcp-pcb-emcopilot."""
+
+    analyzer_id = "emcopilot"
+    analyzer_name = "EMC / SI / PI Physics Review"
+
+    def supports(self, layout_format: LayoutFormat) -> bool:
+        return layout_format in {LayoutFormat.KICAD, LayoutFormat.GERBER}
+
+    def run(self, layout_path: Path, layout_format: LayoutFormat) -> AnalyzerResult:
+        started = time.perf_counter()
+
+        if not emcopilot_available():
+            return AnalyzerResult(
+                analyzer_id=self.analyzer_id,
+                analyzer_name=self.analyzer_name,
+                status="not_installed",
+                findings=[
+                    Finding(
+                        id="emcopilot-not-installed",
+                        category="emc",
+                        severity=Severity.INFO,
+                        title="Deep physics review not enabled",
+                        message="mcp-pcb-emcopilot is not installed in this environment.",
+                        recommendation=EMCOPILOT_INSTALL,
+                    )
+                ],
+                duration_ms=int((time.perf_counter() - started) * 1000),
+            )
+
+        session_id = f"kitty-{int(time.time())}"
+        try:
+            review = run_emcopilot_review(layout_path, layout_format, session_id)
+        except Exception as exc:
+            return AnalyzerResult(
+                analyzer_id=self.analyzer_id,
+                analyzer_name=self.analyzer_name,
+                status="error",
+                error=str(exc),
+                findings=[
+                    Finding(
+                        id="emcopilot-error",
+                        category="emc",
+                        severity=Severity.WARNING,
+                        title="Emcopilot review failed",
+                        message=str(exc),
+                        recommendation="Verify the layout file is a valid KiCad PCB or Gerber copper layer.",
+                    )
+                ],
+                duration_ms=int((time.perf_counter() - started) * 1000),
+            )
+
+        findings: list[Finding] = []
+        index = 0
+        for domain in review.domain_results:
+            for finding in domain.findings:
+                index += 1
+                findings.append(emcopilot_finding_to_kitty(finding, index))
+
+        status = "issues_found" if findings else "clean"
+        return AnalyzerResult(
+            analyzer_id=self.analyzer_id,
+            analyzer_name=self.analyzer_name,
+            status=status,
+            findings=findings,
+            metadata={
+                "executive_summary": review.executive_summary,
+                "detected_interfaces": review.detected_interfaces,
+                "design_classification": review.design_classification,
+                "recommendations": review.recommendations,
+                "domain_count": len(review.domain_results),
+                "finding_count": len(findings),
+                "schematic_sheets_loaded": getattr(review, "schematic_sheets_loaded", 0),
+                "schematic_warnings": getattr(review, "schematic_warnings", []),
+            },
+            duration_ms=int((time.perf_counter() - started) * 1000),
+        )

fabgate-0.1.0/src/kitty/analyzers/gerber_dfm.py

@@ -0,0 +1,112 @@
+from __future__ import annotations
+
+import time
+from pathlib import Path
+
+from kitty.analyzers.base import Analyzer
+from kitty.ingest import classify_gerber_files
+from kitty.models import AnalyzerResult, Finding, LayoutFormat, Severity
+
+
+class GerberDfmAnalyzer(Analyzer):
+    analyzer_id = "gerber_dfm"
+    analyzer_name = "Gerber Fab Readiness"
+
+    def supports(self, layout_format: LayoutFormat) -> bool:
+        return layout_format == LayoutFormat.GERBER
+
+    def run(self, layout_path: Path, layout_format: LayoutFormat) -> AnalyzerResult:
+        started = time.perf_counter()
+        gerber_dir = layout_path if layout_path.is_dir() else layout_path.parent
+        layers = classify_gerber_files(gerber_dir)
+        findings: list[Finding] = []
+
+        if not layers["all_files"]:
+            return AnalyzerResult(
+                analyzer_id=self.analyzer_id,
+                analyzer_name=self.analyzer_name,
+                status="error",
+                error=f"No Gerber files found in {gerber_dir}",
+                duration_ms=int((time.perf_counter() - started) * 1000),
+            )
+
+        if not layers["copper_top"] and not layers["copper_bottom"]:
+            findings.append(
+                Finding(
+                    id="gerber-no-copper",
+                    category="dfm",
+                    severity=Severity.BLOCKING,
+                    title="No copper layers in Gerber package",
+                    message="Could not find top or bottom copper files.",
+                    recommendation="Include F_Cu/GTL and/or B_Cu/GBL in the fab upload.",
+                )
+            )
+
+        if not layers["outline"]:
+            findings.append(
+                Finding(
+                    id="gerber-no-outline",
+                    category="dfm",
+                    severity=Severity.BLOCKING,
+                    title="No board outline in Gerber package",
+                    message="Could not find Edge_Cuts/GKO/GM1 outline layer.",
+                    recommendation="Export the board outline layer for CAM processing.",
+                )
+            )
+
+        if not layers["drill"]:
+            findings.append(
+                Finding(
+                    id="gerber-no-drill",
+                    category="dfm",
+                    severity=Severity.WARNING,
+                    title="No drill files detected",
+                    message="No Excellon/NC drill files found.",
+                    recommendation="Include drill files if the board has plated holes.",
+                )
+            )
+
+        if not layers["mask_top"] and not layers["mask_bottom"]:
+            findings.append(
+                Finding(
+                    id="gerber-no-mask",
+                    category="dfm",
+                    severity=Severity.WARNING,
+                    title="No solder mask layers",
+                    message="Soldermask layers were not found.",
+                    recommendation="Export F/B soldermask for standard fab flows.",
+                )
+            )
+
+        if not layers["silk_top"] and not layers["silk_bottom"]:
+            findings.append(
+                Finding(
+                    id="gerber-no-silk",
+                    category="dfm",
+                    severity=Severity.INFO,
+                    title="No silkscreen layers",
+                    message="Silkscreen layers were not found.",
+                    recommendation="Add silkscreen if component reference designators are needed.",
+                )
+            )
+
+        if len(layers["all_files"]) < 4:
+            findings.append(
+                Finding(
+                    id="gerber-thin-package",
+                    category="dfm",
+                    severity=Severity.INFO,
+                    title="Minimal Gerber package",
+                    message=f"Only {len(layers['all_files'])} Gerber/drill file(s) detected.",
+                    recommendation="Verify the full fab package (copper, mask, silk, outline, drill).",
+                )
+            )
+
+        status = "issues_found" if findings else "clean"
+        return AnalyzerResult(
+            analyzer_id=self.analyzer_id,
+            analyzer_name=self.analyzer_name,
+            status=status,
+            findings=findings,
+            duration_ms=int((time.perf_counter() - started) * 1000),
+        )