schemaseed 1.0.0__tar.gz

schemaseed-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 PalBotics
+
+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.

schemaseed-1.0.0/PKG-INFO

@@ -0,0 +1,232 @@
+Metadata-Version: 2.4
+Name: schemaseed
+Version: 1.0.0
+Summary: Data-driven KiCad schematic generator
+Author-email: PalBotics <p.lydick@draftekdesign.com>
+License: MIT
+Project-URL: Homepage, https://github.com/PalBotics/schemaseed
+Project-URL: Repository, https://github.com/PalBotics/schemaseed
+Project-URL: Issues, https://github.com/PalBotics/schemaseed/issues
+Keywords: kicad,schematic,eda,hardware,pcb
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: kiutils>=1.4.8
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: typer>=0.12
+Requires-Dist: sexpdata>=1.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+Dynamic: license-file
+
+# SchemaSeed
+
+**Data-driven KiCad schematic generator.** Describe your circuit as a structured YAML or netlist file — SchemaSeed emits a `.kicad_sch` with symbols placed and connected, verified by two built-in correctness oracles.
+
+[![CI](https://github.com/PalBotics/schemaseed/actions/workflows/ci.yml/badge.svg)](https://github.com/PalBotics/schemaseed/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/schemaseed)](https://pypi.org/project/schemaseed/)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![KiCad 10](https://img.shields.io/badge/KiCad-10.x-brightgreen)](https://www.kicad.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+---
+
+## What it does
+
+SchemaSeed closes a gap in hardware workflows where the schematic is typically assembled by hand and used as the source of truth. SchemaSeed inverts this: you write a concise circuit description, and the tool generates a schematic you can open directly in KiCad, run ERC on, and push to PCB layout — without placing a single symbol by hand.
+
+```yaml
+# power_protection.yaml
+meta:
+  title: power_protection
+
+parts:
+  - ref: Q1
+    symbol: Transistor_FET:Q_PMOS_GSD
+    value: DMG2305UX
+    footprint: Package_TO_SOT_SMD:SOT-23
+  - ref: R1
+    symbol: Device:R
+    value: 100k
+    footprint: Resistor_SMD:R_0402_1005Metric
+  # ...
+
+nets:
+  GATE:    [Q1.1, R1.1]
+  GND:     [R1.2]
+```
+
+```
+schemaseed generate examples/power_protection.yaml
+  parts: 9   nets: 7   labels: 14   power symbols: 6
+  oracles: geometric PASS, round-trip PASS
+```
+
+---
+
+## Requirements
+
+- Python 3.12+
+- KiCad 10.x installed (for symbol library resolution)
+
+---
+
+## Installation
+
+```bash
+pip install schemaseed
+```
+
+Or from source:
+
+```bash
+git clone https://github.com/PalBotics/schemaseed.git
+cd schemaseed
+pip install -e ".[dev]"
+```
+
+---
+
+## Quick start
+
+### Generate a schematic from YAML
+
+```bash
+schemaseed generate examples/power_protection.yaml
+schemaseed generate examples/power_protection.yaml -o out/my_circuit.kicad_sch
+schemaseed generate examples/power_protection.yaml --grid-pitch 25.4
+```
+
+### Generate from a KiCad netlist
+
+```bash
+schemaseed generate my_project.net -o out/my_project.kicad_sch
+```
+
+### Validate without generating
+
+```bash
+schemaseed check examples/power_protection.yaml
+schemaseed check examples/power_protection.yaml --strict --report-file out/report.txt
+```
+
+### Search available symbols
+
+```bash
+schemaseed symbols search R
+schemaseed symbols search LM358 --lib-path /path/to/custom/libs
+```
+
+---
+
+## Input format
+
+SchemaSeed accepts two input formats:
+
+**Native YAML/JSON** (recommended) — write your circuit description directly:
+
+```yaml
+meta:
+  title: my_circuit
+
+parts:
+  - ref: R1
+    symbol: Device:R        # KiCad library:symbol
+    value: 10k
+    footprint: Resistor_SMD:R_0402_1005Metric
+
+nets:
+  VIN:  [R1.1]             # terse form: ref.pin
+  GND:  [R1.2]
+  # Verbose form with explicit pin discriminator:
+  SIG:
+    - {ref: R1, pin: "1", by: number}
+```
+
+**KiCad netlist** (`.net`, `kicadsexpr` format) — export from KiCad and feed directly:
+
+```bash
+kicad-cli sch export netlist --format kicadsexpr my_project.kicad_sch -o my_project.net
+schemaseed generate my_project.net
+```
+
+---
+
+## Correctness oracles
+
+SchemaSeed runs two oracles on every generated schematic:
+
+**Geometric oracle** (pre-write): Every net label coordinate is verified against the known pin endpoint before the file is written. Catches arithmetic bugs before they reach disk.
+
+**Round-trip oracle** (post-write): The emitted schematic is parsed back via kiutils, labels are matched to pin endpoints, and the reconstructed netlist is compared against the input. Catches kiutils serialization surprises.
+
+Both oracles must pass for the generate command to succeed. Oracle failures exit with code 4 (generator bug) — not a user error.
+
+---
+
+## CLI reference
+
+```
+schemaseed generate INPUT [-o OUTPUT] [--lib-path PATH]
+                          [--grid-pitch MM] [--no-power-symbols]
+                          [--power-nets NET=power:SYMBOL]
+                          [--strict] [--verify-erc]
+
+schemaseed check INPUT [--strict] [--format yaml|json]
+                       [--lib-path PATH] [--report-file PATH]
+
+schemaseed symbols search QUERY [--lib-path PATH] [--project-dir PATH]
+
+schemaseed version
+```
+
+---
+
+## Exit codes
+
+| Code | Meaning |
+|------|---------|
+| 0 | Success |
+| 1 | Validation or data error (malformed input, ambiguous pin reference) |
+| 2 | Symbol resolution failure (library not found, symbol not in library) |
+| 4 | Generator bug — oracle assertion failed |
+
+---
+
+## Known limitations (v1.0)
+
+- **Grid placement only** — parts are placed in a single row with fixed spacing. Manual rearrangement in KiCad is expected for production schematics.
+- **No rotation** — all symbols placed at angle 0.
+- **Single-sheet schematics** — hierarchical sheets not yet supported.
+- **KiCad 10 only** — earlier KiCad versions are not tested.
+
+---
+
+## Development
+
+```bash
+git clone https://github.com/PalBotics/schemaseed.git
+cd schemaseed
+pip install -e ".[dev]"
+python -m pytest tests/ -v
+```
+
+Tests requiring a real KiCad install skip automatically on machines without one. The portable suite (non-KiCad tests) runs anywhere.
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.
+
+---
+
+## License
+
+MIT — see [LICENSE](LICENSE).

schemaseed-1.0.0/README.md

@@ -0,0 +1,201 @@
+# SchemaSeed
+
+**Data-driven KiCad schematic generator.** Describe your circuit as a structured YAML or netlist file — SchemaSeed emits a `.kicad_sch` with symbols placed and connected, verified by two built-in correctness oracles.
+
+[![CI](https://github.com/PalBotics/schemaseed/actions/workflows/ci.yml/badge.svg)](https://github.com/PalBotics/schemaseed/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/schemaseed)](https://pypi.org/project/schemaseed/)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![KiCad 10](https://img.shields.io/badge/KiCad-10.x-brightgreen)](https://www.kicad.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+---
+
+## What it does
+
+SchemaSeed closes a gap in hardware workflows where the schematic is typically assembled by hand and used as the source of truth. SchemaSeed inverts this: you write a concise circuit description, and the tool generates a schematic you can open directly in KiCad, run ERC on, and push to PCB layout — without placing a single symbol by hand.
+
+```yaml
+# power_protection.yaml
+meta:
+  title: power_protection
+
+parts:
+  - ref: Q1
+    symbol: Transistor_FET:Q_PMOS_GSD
+    value: DMG2305UX
+    footprint: Package_TO_SOT_SMD:SOT-23
+  - ref: R1
+    symbol: Device:R
+    value: 100k
+    footprint: Resistor_SMD:R_0402_1005Metric
+  # ...
+
+nets:
+  GATE:    [Q1.1, R1.1]
+  GND:     [R1.2]
+```
+
+```
+schemaseed generate examples/power_protection.yaml
+  parts: 9   nets: 7   labels: 14   power symbols: 6
+  oracles: geometric PASS, round-trip PASS
+```
+
+---
+
+## Requirements
+
+- Python 3.12+
+- KiCad 10.x installed (for symbol library resolution)
+
+---
+
+## Installation
+
+```bash
+pip install schemaseed
+```
+
+Or from source:
+
+```bash
+git clone https://github.com/PalBotics/schemaseed.git
+cd schemaseed
+pip install -e ".[dev]"
+```
+
+---
+
+## Quick start
+
+### Generate a schematic from YAML
+
+```bash
+schemaseed generate examples/power_protection.yaml
+schemaseed generate examples/power_protection.yaml -o out/my_circuit.kicad_sch
+schemaseed generate examples/power_protection.yaml --grid-pitch 25.4
+```
+
+### Generate from a KiCad netlist
+
+```bash
+schemaseed generate my_project.net -o out/my_project.kicad_sch
+```
+
+### Validate without generating
+
+```bash
+schemaseed check examples/power_protection.yaml
+schemaseed check examples/power_protection.yaml --strict --report-file out/report.txt
+```
+
+### Search available symbols
+
+```bash
+schemaseed symbols search R
+schemaseed symbols search LM358 --lib-path /path/to/custom/libs
+```
+
+---
+
+## Input format
+
+SchemaSeed accepts two input formats:
+
+**Native YAML/JSON** (recommended) — write your circuit description directly:
+
+```yaml
+meta:
+  title: my_circuit
+
+parts:
+  - ref: R1
+    symbol: Device:R        # KiCad library:symbol
+    value: 10k
+    footprint: Resistor_SMD:R_0402_1005Metric
+
+nets:
+  VIN:  [R1.1]             # terse form: ref.pin
+  GND:  [R1.2]
+  # Verbose form with explicit pin discriminator:
+  SIG:
+    - {ref: R1, pin: "1", by: number}
+```
+
+**KiCad netlist** (`.net`, `kicadsexpr` format) — export from KiCad and feed directly:
+
+```bash
+kicad-cli sch export netlist --format kicadsexpr my_project.kicad_sch -o my_project.net
+schemaseed generate my_project.net
+```
+
+---
+
+## Correctness oracles
+
+SchemaSeed runs two oracles on every generated schematic:
+
+**Geometric oracle** (pre-write): Every net label coordinate is verified against the known pin endpoint before the file is written. Catches arithmetic bugs before they reach disk.
+
+**Round-trip oracle** (post-write): The emitted schematic is parsed back via kiutils, labels are matched to pin endpoints, and the reconstructed netlist is compared against the input. Catches kiutils serialization surprises.
+
+Both oracles must pass for the generate command to succeed. Oracle failures exit with code 4 (generator bug) — not a user error.
+
+---
+
+## CLI reference
+
+```
+schemaseed generate INPUT [-o OUTPUT] [--lib-path PATH]
+                          [--grid-pitch MM] [--no-power-symbols]
+                          [--power-nets NET=power:SYMBOL]
+                          [--strict] [--verify-erc]
+
+schemaseed check INPUT [--strict] [--format yaml|json]
+                       [--lib-path PATH] [--report-file PATH]
+
+schemaseed symbols search QUERY [--lib-path PATH] [--project-dir PATH]
+
+schemaseed version
+```
+
+---
+
+## Exit codes
+
+| Code | Meaning |
+|------|---------|
+| 0 | Success |
+| 1 | Validation or data error (malformed input, ambiguous pin reference) |
+| 2 | Symbol resolution failure (library not found, symbol not in library) |
+| 4 | Generator bug — oracle assertion failed |
+
+---
+
+## Known limitations (v1.0)
+
+- **Grid placement only** — parts are placed in a single row with fixed spacing. Manual rearrangement in KiCad is expected for production schematics.
+- **No rotation** — all symbols placed at angle 0.
+- **Single-sheet schematics** — hierarchical sheets not yet supported.
+- **KiCad 10 only** — earlier KiCad versions are not tested.
+
+---
+
+## Development
+
+```bash
+git clone https://github.com/PalBotics/schemaseed.git
+cd schemaseed
+pip install -e ".[dev]"
+python -m pytest tests/ -v
+```
+
+Tests requiring a real KiCad install skip automatically on machines without one. The portable suite (non-KiCad tests) runs anywhere.
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.
+
+---
+
+## License
+
+MIT — see [LICENSE](LICENSE).

schemaseed-1.0.0/pyproject.toml

@@ -0,0 +1,58 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "schemaseed"
+version = "1.0.0"
+description = "Data-driven KiCad schematic generator"
+readme = "README.md"
+requires-python = ">=3.12"
+license = {text = "MIT"}
+authors = [
+    {name = "PalBotics", email = "p.lydick@draftekdesign.com"}
+]
+keywords = ["kicad", "schematic", "eda", "hardware", "pcb"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "kiutils>=1.4.8",
+    "pyyaml>=6.0",
+    "typer>=0.12",
+    "sexpdata>=1.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/PalBotics/schemaseed"
+Repository = "https://github.com/PalBotics/schemaseed"
+Issues = "https://github.com/PalBotics/schemaseed/issues"
+
+[project.scripts]
+schemaseed = "schemaseed.cli:app"
+
+[project.optional-dependencies]
+dev = ["pytest>=8", "ruff>=0.4"]
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["schemaseed*"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "F", "I"]
+ignore = ["E501"]

schemaseed-1.0.0/schemaseed/__init__.py

@@ -0,0 +1,3 @@
+"""SchemaSeed — data-driven KiCad schematic generator."""
+
+__version__ = "0.1.0.dev0"

schemaseed-1.0.0/schemaseed/__main__.py

@@ -0,0 +1,56 @@
+"""
+__main__.py — SchemaSeed M1 walking-skeleton entry point (unchanged behavior).
+
+Run with:
+    python -m schemaseed
+
+Emits: out/skeleton.kicad_sch (relative to the project root)
+
+NOTE (M2): this still uses the M1 demo shapes (SkeletonCircuit/SkeletonPart
+from _skeleton_demo.py), NOT the real Circuit/Part model in model.py. That
+real model is now used by `schemaseed check` (see cli.py) instead. This demo
+entry point will be retired once `generate` (M4/M5) supersedes it.
+"""
+
+from __future__ import annotations
+
+import os
+
+from schemaseed._skeleton_demo import SkeletonCircuit, SkeletonPart
+from schemaseed.emit.kicad10_writer import write
+
+_PKG_DIR = os.path.dirname(os.path.abspath(__file__))
+_PROJECT_ROOT = os.path.normpath(os.path.join(_PKG_DIR, ".."))
+
+_TORTURE_LIB = os.path.normpath(
+    os.path.join(_PROJECT_ROOT, "spike", "fixtures", "torture.kicad_sym")
+)
+_OUT_PATH = os.path.normpath(
+    os.path.join(_PROJECT_ROOT, "out", "skeleton.kicad_sch")
+)
+
+
+def main() -> None:
+    if not os.path.exists(_TORTURE_LIB):
+        raise FileNotFoundError(
+            f"Torture fixture not found at: {_TORTURE_LIB}\n"
+            "Make sure the M0 spike fixtures are present at spike/fixtures/."
+        )
+
+    circuit = SkeletonCircuit(
+        name="skeleton",
+        parts=[
+            SkeletonPart(
+                ref="J1",
+                lib_path=_TORTURE_LIB,
+                symbol_name="MYPART",
+                value="MYPART",
+            )
+        ],
+    )
+
+    write(circuit, _OUT_PATH)
+
+
+if __name__ == "__main__":
+    main()

schemaseed-1.0.0/schemaseed/_skeleton_demo.py

@@ -0,0 +1,31 @@
+"""
+_skeleton_demo.py — M1's original throwaway data shapes, relocated.
+
+These are NOT the spec's real Circuit/Part model (see model.py for that). They
+were a deliberate M1 shortcut — lib_path/symbol_name point directly at a known
+fixture so the emit pipeline could be proven end-to-end before symbol
+resolution (M3) existed.
+
+This module exists solely so `python -m schemaseed` keeps working unchanged
+while model.py is free to hold the real, spec-true types. Nothing outside
+__main__.py and its smoke test should import from here.
+"""
+
+from __future__ import annotations
+from dataclasses import dataclass, field
+
+
+@dataclass
+class SkeletonPart:
+    """A single component to be placed on the schematic (M1 demo shape)."""
+    ref: str
+    lib_path: str
+    symbol_name: str
+    value: str = ""
+
+
+@dataclass
+class SkeletonCircuit:
+    """The complete set of parts to be emitted into one schematic (M1 demo shape)."""
+    name: str
+    parts: list[SkeletonPart] = field(default_factory=list)

schemaseed-1.0.0/schemaseed/canonicalize/__init__.py

@@ -0,0 +1 @@
+# canonicalize package — the net-name identity contract (Vector F1)