Skip to main content

Data-driven KiCad schematic generator

Project description

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 PyPI Python 3.12+ KiCad 10 License: MIT


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.

# 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

pip install schemaseed

Or from source:

git clone https://github.com/PalBotics/schemaseed.git
cd schemaseed
pip install -e ".[dev]"

Quick start

Generate a schematic from YAML

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

schemaseed generate my_project.net -o out/my_project.kicad_sch

Validate without generating

schemaseed check examples/power_protection.yaml
schemaseed check examples/power_protection.yaml --strict --report-file out/report.txt

Search available symbols

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:

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:

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

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 for contribution guidelines.


License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

schemaseed-1.0.1.tar.gz (61.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

schemaseed-1.0.1-py3-none-any.whl (52.5 kB view details)

Uploaded Python 3

File details

Details for the file schemaseed-1.0.1.tar.gz.

File metadata

  • Download URL: schemaseed-1.0.1.tar.gz
  • Upload date:
  • Size: 61.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for schemaseed-1.0.1.tar.gz
Algorithm Hash digest
SHA256 8a3323677a94986223e3c4dcd23d2c2de8ead0df179e2d8915e77e1015cf82b2
MD5 7f4ccb01ff0545c0922e5379c4ea5d86
BLAKE2b-256 b352ef537fc71dcd5eed752718ed767b7086decb329aea338c91d3e5c5362793

See more details on using hashes here.

File details

Details for the file schemaseed-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: schemaseed-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 52.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for schemaseed-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3ae4ebb50fe0afb837f40f3901c94cfdbf339030624e63b575a05e6167cd35a9
MD5 1f14100cfd72fc2190e94e9dacc103c4
BLAKE2b-256 0d25986402ba73b62aad8de7e159bde758160cb12fa35d2605466c36d44dfbb2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page