kicad-bot 0.1.4__tar.gz

kicad_bot-0.1.4/.claude/settings.local.json

@@ -0,0 +1,51 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(git -C \"c:\\\\Users\\\\Gabriel\\\\Desktop\\\\kicad-bot-action\" status)",
+      "Read(//c/Users/Gabriel/Desktop/**)",
+      "Read(//c/Users/Gabriel/.claude/projects/c--Users-Gabriel-Desktop-kicad-bot-action/memory//**)",
+      "Bash(git init *)",
+      "Bash(git branch *)",
+      "Bash(py --version)",
+      "Bash(gh auth *)",
+      "Bash(gh repo *)",
+      "Bash(echo \"exit: $?\")",
+      "Bash(gh --version)",
+      "Bash(echo \"exit=$?\")",
+      "PowerShell(gh auth status 2>&1; \"exit=$LASTEXITCODE\")",
+      "PowerShell($o = gh auth status 2>&1 | Out-String; Write-Output $o; Write-Output \"EXIT=$LASTEXITCODE\")",
+      "Bash(rm -rf /c/Users/Gabriel/Desktop/_ref; echo cleaned)",
+      "Bash(curl -fsSL https://www.apache.org/licenses/LICENSE-2.0.txt -o LICENSE)",
+      "PowerShell(if \\(Test-Path LICENSE\\) { \\(Get-Item LICENSE\\).Length; Get-Content LICENSE -TotalCount 2 } else { \"no license file\" })",
+      "PowerShell(Write-Output \\(\"files: \" + \\(\\(Get-ChildItem -Force -Name\\) -join \", \"\\)\\))",
+      "PowerShell(\"hello-test-123\")",
+      "PowerShell([Console]::Out.WriteLine\\(\"DIRECT_CONSOLE_PROBE_99\"\\); Get-Location | Select-Object -ExpandProperty Path)",
+      "Bash(python -m venv .venv)",
+      "Bash(./.venv/Scripts/python.exe -m pip install -q --upgrade pip)",
+      "Bash(./.venv/Scripts/python.exe -m pip install -q -e \".[dev]\")",
+      "Bash(./.venv/Scripts/python.exe -m pytest)",
+      "Bash(python -c \"print\\('SIMPLE_STDOUT_TEST_OK'\\)\")",
+      "Read(//c/c/Users/Gabriel/Desktop/_ref/cortex-memory-budget/**)",
+      "Read(//c/c/Users/Gabriel/Desktop/_ref/cortex-memory-budget/src/cortex_memory_budget/**)",
+      "Bash(./.venv/Scripts/python.exe -m kicad_bot.verify --help)",
+      "Bash(echo \"HELP_RC=$?\")",
+      "Bash(./.venv/Scripts/python.exe -m ruff check .)",
+      "Bash(./.venv/Scripts/python.exe -m ruff format --check .)",
+      "Bash(./.venv/Scripts/python.exe -m mypy)",
+      "Bash(./.venv/Scripts/python.exe -m pytest -q)",
+      "Bash(rm -f tests/test_verify_parse.py tests/test_cli.py tests/test_metrics.py tests/test_report.py tests/test_pr_comment.py)",
+      "Bash(rm -rf tests/__pycache__)",
+      "Read(//c/c/Users/Gabriel/Desktop/kicad-bot-action/**)",
+      "Bash(./.venv/Scripts/python.exe -m pytest -v)",
+      "Bash(./.venv/Scripts/python.exe -m pytest tests/unit -q)",
+      "Bash(gh pr *)",
+      "WebFetch(domain:patch-diff.githubusercontent.com)",
+      "WebFetch(domain:raw.githubusercontent.com)",
+      "WebSearch",
+      "Bash(python -c \"import yaml,sys; [yaml.safe_load\\(open\\(f\\)\\) for f in ['.github/workflows/release.yml','.github/workflows/release-please.yml']]; print\\('YAML OK'\\)\")"
+    ],
+    "additionalDirectories": [
+      "C:\\Users\\Gabriel\\Desktop\\_ref"
+    ]
+  }
+}

kicad_bot-0.1.4/.github/dependabot.yml

@@ -0,0 +1,18 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 5
+    groups:
+      dev-tools:
+        patterns:
+          - "ruff"
+          - "mypy"
+          - "pytest*"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 5

kicad_bot-0.1.4/.github/workflows/ci.yml

@@ -0,0 +1,74 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Lint & type-check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+        with:
+          python-version: "3.12"
+          cache: "pip"
+          cache-dependency-path: pyproject.toml
+      - name: Install
+        run: python -m pip install -e ".[dev]"
+      - name: Ruff lint
+        run: python -m ruff check .
+      - name: Ruff format check
+        run: python -m ruff format --check .
+      - name: Mypy (strict)
+        run: python -m mypy
+
+  unit:
+    name: Unit tests (py${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: "pip"
+          cache-dependency-path: pyproject.toml
+      - name: Install
+        run: python -m pip install -e ".[dev]"
+      - name: Unit tests
+        run: python -m pytest tests/unit --cov=kicad_bot --cov-report=term-missing
+
+  integration:
+    name: Integration tests (real kicad-cli)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+        with:
+          python-version: "3.12"
+          cache: "pip"
+          cache-dependency-path: pyproject.toml
+      - name: Install kicad-cli
+        run: |
+          set -euo pipefail
+          sudo add-apt-repository --yes ppa:kicad/kicad-9.0-releases
+          sudo apt-get update
+          sudo apt-get install --yes --no-install-recommends kicad-cli || sudo apt-get install --yes --no-install-recommends kicad
+          kicad-cli version
+      - name: Install package
+        run: python -m pip install -e ".[dev]"
+      - name: Integration tests
+        run: python -m pytest tests/integration -v

kicad_bot-0.1.4/.github/workflows/codeql.yml

@@ -0,0 +1,32 @@
+name: CodeQL
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  schedule:
+    - cron: "27 4 * * 1"
+
+permissions:
+  contents: read
+
+jobs:
+  analyze:
+    name: Analyze (Python)
+    runs-on: ubuntu-latest
+    permissions:
+      security-events: write
+      packages: read
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@8aad20d150bbac5944a9f9d289da16a4b0d87c1e # v4.36.2
+        with:
+          languages: python
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@8aad20d150bbac5944a9f9d289da16a4b0d87c1e # v4.36.2
+      - name: Analyze
+        uses: github/codeql-action/analyze@8aad20d150bbac5944a9f9d289da16a4b0d87c1e # v4.36.2
+        with:
+          category: "/language:python"

kicad_bot-0.1.4/.github/workflows/release-please.yml

@@ -0,0 +1,68 @@
+name: release-please
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [main]
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  release-please:
+    name: Release Please
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    outputs:
+      pr: ${{ steps.release.outputs.pr }}
+      release_created: ${{ steps.release.outputs.release_created }}
+      tag_name: ${{ steps.release.outputs.tag_name }}
+    steps:
+      - uses: googleapis/release-please-action@45996ed1f6d02564a971a2fa1b5860e934307cf7 # v5.0.0
+        id: release
+        with:
+          # A PAT (or GitHub App token) is required so that the release PR and
+          # its branch trigger other workflows. Events created with the default
+          # GITHUB_TOKEN do not start new workflow runs, which is why CI does not
+          # run on the release-please branch. Falls back to GITHUB_TOKEN when the
+          # secret is absent so the workflow still opens the PR.
+          token: ${{ secrets.RELEASE_PLEASE_TOKEN || secrets.GITHUB_TOKEN }}
+          config-file: release-please-config.json
+          manifest-file: .release-please-manifest.json
+
+  release:
+    name: Release
+    needs: release-please
+    if: ${{ needs.release-please.outputs.release_created }}
+    permissions:
+      contents: write
+    uses: ./.github/workflows/release.yml
+    with:
+      tag_name: ${{ needs.release-please.outputs.tag_name }}
+
+  # PyPI trusted publishing must run from this non-reusable (top-level) workflow
+  # so the OIDC claims match the configured trusted publisher. It consumes the
+  # `dist` artifact built by the reusable release.yml (shared within the run).
+  publish:
+    name: Publish to PyPI
+    needs: release
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/kicad-bot
+    permissions:
+      id-token: write # OIDC trusted publishing
+      contents: read
+    steps:
+      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: dist
+          path: dist/
+      - name: Publish via OIDC
+        uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.13.0

kicad_bot-0.1.4/.github/workflows/release.yml

@@ -0,0 +1,60 @@
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag_name:
+        description: Tag to publish artifacts for (for example, v0.1.1)
+        required: true
+        type: string
+  workflow_call:
+    inputs:
+      tag_name:
+        description: Tag to publish artifacts for (for example, v0.1.1)
+        required: true
+        type: string
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build sdist + wheel
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+        with:
+          python-version: "3.12"
+      - name: Install build
+        run: python -m pip install build
+      - name: Build
+        run: python -m build
+      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+
+  # NOTE: PyPI trusted publishing (OIDC) cannot run from inside a reusable
+  # workflow — the OIDC job_workflow_ref points at this callee, which PyPI
+  # cannot match against the configured trusted publisher. The publish job
+  # therefore lives in the top-level release-please.yml caller, which downloads
+  # the `dist` artifact built above. See pypi/warehouse#11096.
+
+  github-release:
+    name: Upload GitHub Release Assets
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: dist
+          path: dist/
+      - name: Upload release assets
+        uses: softprops/action-gh-release@b4309332981a82ec1c5618f44dd2e27cc8bfbfda # v3.0.0
+        with:
+          tag_name: ${{ inputs.tag_name }}
+          files: dist/*

kicad_bot-0.1.4/.github/workflows/self-test.yml

@@ -0,0 +1,52 @@
+name: self-test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pull-requests: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  minimal-verify:
+    name: Verify (examples/minimal)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+
+      - name: Run kicad-bot (verify only)
+        id: kb
+        uses: ./
+        with:
+          run-verify: "true"
+          project-dir: examples/minimal
+          fail-on-drc: "true"
+          fail-on-erc: "true"
+          artifact-name: self-test-minimal
+
+      - name: Assert outputs exist
+        shell: bash
+        run: |
+          set -euo pipefail
+          test -f kicad-bot-output/report.md
+          test -f kicad-bot-output/kicad_bot_metrics.json
+          test -f kicad-bot-output/erc.json
+          test -f kicad-bot-output/drc.json
+          echo "report-path: ${{ steps.kb.outputs.report-path }}"
+          echo "erc-violations: ${{ steps.kb.outputs.erc-violations }}"
+          echo "drc-violations: ${{ steps.kb.outputs.drc-violations }}"
+          echo "passed: ${{ steps.kb.outputs.passed }}"
+
+      - name: Assert clean project passed
+        shell: bash
+        run: |
+          set -euo pipefail
+          test "${{ steps.kb.outputs.passed }}" = "true"
+          grep -q "kicad-bot:report" kicad-bot-output/pr_comment.md

kicad_bot-0.1.4/.gitignore

@@ -0,0 +1,35 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+venv/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.coverage
+htmlcov/
+coverage.xml
+
+# kicad-bot runtime output
+kicad-bot-output/
+*_metrics.json
+report.md
+pr_comment.md
+
+# KiCad / KiBot transients
+*-backups/
+fp-info-cache
+*.kicad_sch-bak
+*.kicad_pcb-bak
+_autosave-*
+
+# OS / editor
+.DS_Store
+Thumbs.db
+desktop.ini
+.idea/
+.vscode/

kicad_bot-0.1.4/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.4"
+}

kicad_bot-0.1.4/CHANGELOG.md

@@ -0,0 +1,44 @@
+# Changelog
+
+## [0.1.4](https://github.com/embedded-pro/kicad-bot/compare/v0.1.3...v0.1.4) (2026-06-21)
+
+
+### Miscellaneous Chores
+
+* **deps:** bump actions/checkout from 6.0.2 to 6.0.3 ([#12](https://github.com/embedded-pro/kicad-bot/issues/12)) ([2c15b12](https://github.com/embedded-pro/kicad-bot/commit/2c15b12298fca889751e5ad6d936be591d315e91))
+* **deps:** bump github/codeql-action from 4.36.0 to 4.36.2 ([#13](https://github.com/embedded-pro/kicad-bot/issues/13)) ([3a8399f](https://github.com/embedded-pro/kicad-bot/commit/3a8399f452bef1707f97fa2fa1ba3e79da4e166c))
+
+## [0.1.3](https://github.com/embedded-pro/kicad-bot/compare/v0.1.2...v0.1.3) (2026-06-04)
+
+
+### Miscellaneous Chores
+
+* fix wxPython source-build failure in KiBot stack install ([#10](https://github.com/embedded-pro/kicad-bot/issues/10)) ([84599e1](https://github.com/embedded-pro/kicad-bot/commit/84599e18e3bff02670e23bea886716f90d101132))
+
+## [0.1.2](https://github.com/embedded-pro/kicad-bot/compare/v0.1.1...v0.1.2) (2026-06-04)
+
+
+### Bug Fixes
+
+* include all conventional commit types in release-please changelog sections ([#8](https://github.com/embedded-pro/kicad-bot/issues/8)) ([b0144e7](https://github.com/embedded-pro/kicad-bot/commit/b0144e77db67e4d3690fae5f972f30de3698c366))
+
+
+### Miscellaneous Chores
+
+* chain publishing from release-please by making release.yml reusable ([#7](https://github.com/embedded-pro/kicad-bot/issues/7)) ([b68a80d](https://github.com/embedded-pro/kicad-bot/commit/b68a80dc043154b99ee3545c3f02c1f3d8b0e7f9))
+
+## [0.1.1](https://github.com/embedded-pro/kicad-bot/compare/v0.1.0...v0.1.1) (2026-06-04)
+
+
+### Bug Fixes
+
+* unit test CI failure and add PyPI publishing docs ([#4](https://github.com/embedded-pro/kicad-bot/issues/4)) ([4501c71](https://github.com/embedded-pro/kicad-bot/commit/4501c714799238baaab52cf33bebbb13622187fd))
+
+## Changelog
+
+All notable changes to this project are documented here. This file is maintained
+automatically by [release-please](https://github.com/googleapis/release-please)
+from [Conventional Commits](https://www.conventionalcommits.org/).
+
+<!-- release-please-start -->
+<!-- release-please-end -->

kicad_bot-0.1.4/CONTRIBUTING.md

@@ -0,0 +1,72 @@
+# Contributing to kicad-bot
+
+Thanks for your interest in improving kicad-bot! This project is part of the
+[embedded-pro](https://github.com/embedded-pro) family of CI actions and follows
+the same conventions as its sibling repos.
+
+## Development setup
+
+```bash
+python -m venv .venv
+. .venv/bin/activate        # Windows: .venv\Scripts\activate
+pip install -e ".[dev]"
+```
+
+Running the KiCad-backed capabilities locally also requires a KiCad 8+ install
+(for `kicad-cli`) and, for BOM/diff/fab, the KiBot stack. See
+[docs/troubleshooting.md](docs/troubleshooting.md) for the headless setup.
+
+## Checks
+
+Every change must pass the same gates CI runs:
+
+```bash
+ruff check .            # lint
+ruff format --check .   # formatting
+mypy                    # type-check
+pytest tests/unit       # hermetic unit tests (no KiCad needed)
+pytest tests/integration # end-to-end tests (require kicad-cli; auto-skip if absent)
+```
+
+### Test layout
+
+| Layer | Location | What it covers | Needs |
+| ----- | -------- | -------------- | ----- |
+| Unit | `tests/unit/` | Parsers, gates, metrics, report/PR-comment rendering — pure Python | nothing |
+| Integration | `tests/integration/` | Full `kicad-bot-verify` pipeline against the `examples/` projects | real `kicad-cli` |
+| Self-test | `.github/workflows/self-test.yml` | The composite action end-to-end on `examples/minimal` | the action |
+
+Integration tests are skipped automatically when `kicad-cli` is not on PATH, so
+the unit suite stays hermetic on machines without KiCad. In CI the `integration`
+job installs KiCad and runs them for real — it is a good required status check
+alongside `lint` and `unit`.
+
+## Commit messages
+
+This repo releases via **release-please**, which derives version bumps and the
+changelog from [Conventional Commits](https://www.conventionalcommits.org/).
+Use prefixes such as:
+
+- `feat:` — a new capability or input (minor bump)
+- `fix:` — a bug fix (patch bump)
+- `docs:`, `test:`, `chore:`, `refactor:`, `ci:` — no release on their own
+- `feat!:` / `fix!:` or a `BREAKING CHANGE:` footer — major bump
+
+## Architecture
+
+See [docs/architecture.md](docs/architecture.md) for the module layout and data
+flow. In short: each capability is a self-contained module under
+`src/kicad_bot/` exposing a `main()` console-script entry point, sharing argparse
+plumbing from `cli.py` and output helpers from `report.py`, `pr_comment.py`, and
+`metrics.py`.
+
+## Adding a capability
+
+1. Add `src/kicad_bot/<capability>.py` with a `main()` entry point.
+2. Register the console script in `pyproject.toml` (`kicad-bot-<capability>`).
+3. Add the `run-<capability>` toggle and any gates to `action.yml`.
+4. Add a runnable project under `examples/` and wire it into `self-test.yml`.
+5. Document it in `docs/capabilities.md` and `docs/usage.md`.
+
+By contributing you agree your contributions are licensed under the project's
+[Apache-2.0](LICENSE) license.