Metadata-Version: 2.4
Name: hw-codesign
Version: 0.1.4
Summary: Agentic hardware co-design from brief to KiCad, firmware, 3D review, and explicit fabrication blockers.
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/mrcha033/hw-codesign
Project-URL: Documentation, https://github.com/mrcha033/hw-codesign/tree/master/docs
Project-URL: Demo, https://mrcha033.github.io/hw-codesign/#assembly-title
Project-URL: Repository, https://github.com/mrcha033/hw-codesign
Project-URL: Issues, https://github.com/mrcha033/hw-codesign/issues
Keywords: agentic-ai,electronics,hardware-design,kicad,mcp,pcb,eda
Classifier: Development Status :: 3 - Alpha
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
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
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: PyYAML>=6.0.2
Requires-Dist: jsonschema>=4.23
Requires-Dist: kicad-sch-api==0.5.6
Requires-Dist: sexpdata==1.0.2
Provides-Extra: mcp
Requires-Dist: mcp>=1.0; extra == "mcp"
Provides-Extra: cad
Requires-Dist: cadquery-ocp==7.9.3.1.1; extra == "cad"
Provides-Extra: dev
Requires-Dist: pytest>=8.3; extra == "dev"
Requires-Dist: pytest-cov>=6.0; extra == "dev"
Requires-Dist: ruff>=0.9; extra == "dev"
Provides-Extra: zephyr
Requires-Dist: anytree; extra == "zephyr"
Requires-Dist: canopen; extra == "zephyr"
Requires-Dist: intelhex; extra == "zephyr"
Requires-Dist: packaging; extra == "zephyr"
Requires-Dist: patool>=2.0.0; extra == "zephyr"
Requires-Dist: progress; extra == "zephyr"
Requires-Dist: psutil>=5.6.6; extra == "zephyr"
Requires-Dist: pyelftools>=0.29; extra == "zephyr"
Requires-Dist: pykwalify; extra == "zephyr"
Requires-Dist: pylink-square; extra == "zephyr"
Requires-Dist: pyserial; extra == "zephyr"
Requires-Dist: requests>=2.32.0; extra == "zephyr"
Requires-Dist: reuse; extra == "zephyr"
Requires-Dist: semver; extra == "zephyr"
Requires-Dist: tqdm>=4.67.1; extra == "zephyr"
Requires-Dist: west>=0.14.0; extra == "zephyr"
Dynamic: license-file

# hw-codesign

**Agentic hardware co-design from brief to KiCad, firmware, 3D review, and
explicit fabrication blockers.**

Version 0.1.4 is available from PyPI and its tagged GitHub release. The package
provides candidate-level CAD and validation evidence; it does not claim that a
generated board is fabricated or physically qualified.

![20-second prompt-to-board demo](https://raw.githubusercontent.com/mrcha033/hw-codesign/v0.1.4/docs/demo/prompt-to-board-20s.gif)

`hw-codesign` provides the `hw` CLI, the `hw-mcp` MCP server, and a typed,
template-driven workflow for generating reviewable hardware candidates. Every
gate is reported as `pass`, `fail`, or `blocked`; software checks do not become
fabrication or physical-qualification claims.

## Install

Python 3.11 or newer is required.

```bash
python -m pip install "hw-codesign[mcp]==0.1.4"
hw --help
```

## Start a candidate

```bash
mkdir my-hardware-workspace
cd my-hardware-workspace
hw --root . create-project my_usb_board --template rp2040_usb_device
hw --root . update-requirements my_usb_board \
  "Design a 2-layer RP2040 USB HID and CDC board powered from USB-C. Use Zephyr."
hw --root . design-candidate my_usb_board --brief \
  "Design a 2-layer RP2040 USB HID and CDC board powered from USB-C. Use Zephyr."
hw --root . export-standalone-review my_usb_board
```

The generated HTML review is self-contained. The tool is not an
arbitrary-prompt PCB oracle, and generated artifacts remain candidates until
all configured release and physical-evidence gates pass.

- [Full v0.1.4 README](https://github.com/mrcha033/hw-codesign/blob/v0.1.4/README.md)
- [Demo evidence and hashes](https://github.com/mrcha033/hw-codesign/blob/v0.1.4/docs/demo/README.md)
- [Validation contract](https://github.com/mrcha033/hw-codesign/blob/v0.1.4/docs/validation-contract.md)
- [Apache-2.0 license and third-party boundary](https://github.com/mrcha033/hw-codesign/blob/v0.1.4/NOTICE)
