fabgate 0.1.0__py3-none-any.whl

fabgate-0.1.0.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,39 @@
+kitty/__init__.py,sha256=uVMvpQyzTmqHheC7-s74JiSsg8NSqZ8d0MrVNibHk4U,81
+kitty/__main__.py,sha256=7z0PGCi9Z0i8jGG6AZHMMcsd-b-tqWab0omrHvh1DMc,36
+kitty/audit.py,sha256=R1qFueevHlnYZYw-jNuU6R5q7irG7ZWY1VTAunlgPxQ,3199
+kitty/autonomous.py,sha256=1q_Hblsx-ApzPH9mlXlhjGhAWX87Kvw4NGMciWikYjU,6687
+kitty/cli.py,sha256=Us889rflQFE7PESooMLyNh6CUtCZFLK9IMHGOCaj_So,23456
+kitty/design.py,sha256=PGyhkhEB-jqK2B2kDmF7sHw9n3AX-CsP4PTxUWSKkGI,10214
+kitty/emcopilot_client.py,sha256=AeH7FBFOz2zYXK5kvJhiIpvSRX9saJBnj2fl9NlOJIE,4927
+kitty/evaluate.py,sha256=sjHMZiORcKea9I9VwaAvjKOeGw16ClHJpx-Qeikw0Pg,8080
+kitty/export_bundle.py,sha256=D5M4BCkBja7ujmKFEJ303b9MkLV7W-xin890VBLb2Bw,1958
+kitty/findings_triage.py,sha256=AEisI8wAt8tDV_NesO5icnYQhJWL4YXK0lT-D602Mvk,3624
+kitty/ingest.py,sha256=tf70vdG6_q8lP0_YbMv2ZRtry2MOk0diBVrjoEdOvcU,4089
+kitty/kicad_paths.py,sha256=oqTddlLvQ07Ku0JhDfaf9HJbxzMLgvxsn2cZCiImNIU,4015
+kitty/kicad_project.py,sha256=uU2PlKtFWUVu-SjIzHvaZ-46HHqSRq9Thp5YeNML8xg,4576
+kitty/models.py,sha256=1XVV8nw3J9t4a87yNgLOheg2Kr-eXvxXBYX03L-CSXA,2912
+kitty/optimize.py,sha256=3W93pmnn-WBT9QzN1zatJubOSD2nz3xknMgM__Qr3e8,14169
+kitty/pipeline.py,sha256=bjas41LpTvEb5pYZ4eH1g8KkDCwvejoMYzDnzfj2bRs,3627
+kitty/pkg_paths.py,sha256=aPBE7e6et8BEHHhpxL8fPQxgiJPfPsupL-2a4CLQQRc,233
+kitty/product_config.py,sha256=e8RN0wpfSY50S86CWJgg9A79vVOSvXDC7Z_XMoSzcjQ,2142
+kitty/scoring.py,sha256=cEAda3s5J-w_dajqZyVQKP0epX23jkh4YlZzQhUC5nM,3624
+kitty/visualization.py,sha256=cKGkSnuu3EOxqjR5Cc8AwliJ3j0adbeV3Ca5b_EOxSY,3072
+kitty/workflow.py,sha256=QFXmBDwvZGQUPs1r7lvQfwH3Djj8Ax2XMsddzfxp1ug,3777
+kitty/analyzers/__init__.py,sha256=uexMfi7IxYAKX1lagI71RUOXiPibaI2spRBnzZJ6Zcs,906
+kitty/analyzers/base.py,sha256=mEvpb_W1DB8etZbMTePsH5VImvcUUS_49IS3b6l5wMY,494
+kitty/analyzers/drc_severity.py,sha256=1OfKXXLsCcVviaiiA7Fw4wjd1v_nNKmWiaTw9zG-1ZA,1391
+kitty/analyzers/emcopilot.py,sha256=h4JqP3M6Hgl-oyT55Yt8i9YSXgIfhyQ1bR5P9iKNG7k,3665
+kitty/analyzers/gerber_dfm.py,sha256=VXA0BFkz6Y9KpI_eCxuhk0qovILRFrKBgTkNZ87D528,4443
+kitty/analyzers/kicad_drc.py,sha256=YAvh3cQdBHNvAwH6jzY7TxyTFaUy9cTmb-jL5UWex8Y,9786
+kitty/analyzers/layout_rules.py,sha256=8hMb5QoTS-0JFyBo5bCmFv_SRPbhap3dYD25eDMU48s,9377
+kitty/analyzers/stub.py,sha256=JAvDuRsauXeN2Heo5hQ53s5-z71n_lVWAQrZvZWYXqE,1577
+kitty/auto_fixers/__init__.py,sha256=MsuJmfkF4_aeFgcEQaHVgvvs6OUWMmIC_4_oLhTUNww,166
+kitty/auto_fixers/pcb_mutations.py,sha256=pNhLc2ul0RwotobQ-gdmIkNnIDW9vXjoTB8Jam56--U,8278
+kitty/config/default_rules.yaml,sha256=pbCBTPNOLhlwd2lwPwq08x3W9Z7f6V149oh4ZqKgGdM,675
+kitty/config/design_spec.example.yaml,sha256=3XLz4H-K_HsJf0g9NhLEdr_BqvwDLJG-wDjdBnLY8kE,468
+kitty/config/product.yaml,sha256=vV01xwi03TP4G9YMa2u6_MKcLZ_iflnyu50YHkjAWAQ,358
+fabgate-0.1.0.dist-info/METADATA,sha256=TIG7RF5NDz1vb3mDlh8R_eUUA4pie0I40DMm8wDAEwo,3232
+fabgate-0.1.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+fabgate-0.1.0.dist-info/entry_points.txt,sha256=pnwRtThsYjEMZndvC0GtqGNOdI9-H_vbWElfyIdxPyg,42
+fabgate-0.1.0.dist-info/licenses/LICENSE,sha256=TyIag98QdFhuiq4hdeWDM6Ix52w91Pb4bO7eCRKk94I,1092
+fabgate-0.1.0.dist-info/RECORD,,

fabgate-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

fabgate-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+fabgate = kitty.cli:app

fabgate-0.1.0.dist-info/licenses/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.

kitty/__init__.py

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

kitty/__main__.py

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

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

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

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

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),
+        )

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),
+        )