kicad-netspec 0.5.1__tar.gz

kicad_netspec-0.5.1/.github/workflows/assumptions.yml

@@ -0,0 +1,34 @@
+name: kicad-assumptions
+
+# D6: every KiCad 11 fact netspec plans around is verified in master, weekly, so an
+# upstream revert arrives as a red build rather than a surprise when KiCad 11 ships.
+
+on:
+  schedule:
+    - cron: "17 6 * * 1"
+  workflow_dispatch:
+  push:
+    paths:
+      - "tests/test_kicad_assumptions.py"
+      - ".github/workflows/assumptions.yml"
+
+jobs:
+  verify:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Fetch KiCad master (blobless, api dirs only)
+        run: |
+          git clone --depth 1 --filter=blob:none --sparse \
+            https://gitlab.com/kicad/code/kicad.git kicad-src
+          cd kicad-src
+          git sparse-checkout set \
+            pcbnew/api pcbnew/python eeschema/api common/api kicad/cli
+          echo "KiCad master at $(git rev-parse --short HEAD)"
+
+      - uses: astral-sh/setup-uv@v5
+      - run: uv sync
+
+      - name: Verify planned API commands still exist
+        run: uv run pytest tests/test_kicad_assumptions.py -v --kicad-source=kicad-src

kicad_netspec-0.5.1/.github/workflows/check.yml

@@ -0,0 +1,96 @@
+# Calls the `just` recipes so CI and local share one gate definition.
+#
+# Path-aware: docs-only changes skip the heavy check/test jobs via
+# dorny/paths-filter, while the always-running `ok` aggregator still reports a
+# green required status — so a docs PR merges without running the full matrix.
+#
+# Branch protection: require ONLY the `ok` context (not `check`/`test`). Skipped
+# jobs don't block; only failures and cancellations do.
+
+name: Check
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: check-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  changes:
+    name: Detect changes
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    outputs:
+      code: ${{ steps.filter.outputs.code }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          filters: |
+            code:
+              - '**'
+              - '!**/*.md'
+              - '!docs/**'
+
+  check:
+    name: Check
+    needs: [changes]
+    if: needs.changes.outputs.code == 'true'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install just
+        uses: extractions/setup-just@v2
+
+      - uses: astral-sh/setup-uv@v6
+
+      - name: Setup
+        run: just setup
+
+      - name: Check (fmt + lint + typecheck)
+        run: just check
+
+  test:
+    name: Test
+    needs: [changes]
+    if: needs.changes.outputs.code == 'true'
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install just
+        uses: extractions/setup-just@v2
+
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Setup
+        run: just setup
+
+      - name: Test
+        run: just test
+
+  # ─── Unified gate ─────────────────────────────────────────────────────
+  # The ONLY job required by branch protection. Add every job to `needs:`.
+  ok:
+    name: ok
+    if: always()
+    needs: [changes, check, test]
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - name: Fail if any upstream job failed or was cancelled
+        if: contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')
+        run: exit 1
+      - name: Pass
+        run: echo 'All checks passed or were skipped'

kicad_netspec-0.5.1/.github/workflows/release.yml

@@ -0,0 +1,156 @@
+# Release: push a v* tag -> build -> verify the artifact -> publish to PyPI.
+#
+# Publishing uses PyPI Trusted Publishing (OIDC) — no token lives in this repo.
+# The publisher registered on PyPI names this exact workflow file and the `pypi`
+# environment; renaming either silently breaks the binding.
+#
+# This workflow verifies the *artifact* — it builds, its metadata is valid, the wheel
+# installs cold and answers `--version`. Correctness of the code is the `Check` gate's
+# job, which every commit on main has already run.
+#
+# That argument has a gap worth knowing about: it holds fully only when main is
+# protected to require `Check`. netspec's main is not protected yet (D17), so the
+# ancestry gate below stops a stray tag but cannot prove the gate passed. Every action
+# here is pinned to an exact ref rather than a floating major, and a test enforces that.
+
+name: Release
+
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: read
+
+# One release at a time across ALL tags, not per-tag: `release-${{ github.ref }}` would
+# put two versions in separate groups and run them concurrently, which is the race this
+# exists to prevent.
+concurrency:
+  group: release
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: Build and verify
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v4.2.2
+        with:
+          # Full history: the ancestry check needs to see main.
+          fetch-depth: 0
+
+      - uses: astral-sh/setup-uv@v5.4.2
+
+      # The gate the safety argument rests on. Nothing below runs the test suite, so a
+      # tag pointing off main would publish code the Check gate never saw. In a script
+      # so it can be tested — an inline gate is only ever grepped, and dropping one `!`
+      # would leave it green and inert.
+      - name: Assert the tag is on main
+        run: scripts/assert_tag_on_main.sh "$GITHUB_SHA" origin/main
+
+      # A tag that disagrees with pyproject would publish a version whose name lies
+      # about its content. Fail before anything is built.
+      - name: Assert the tag matches the package version
+        run: |
+          declared=$(python3 -c "import tomllib; print(tomllib.load(open('pyproject.toml','rb'))['project']['version'])")
+          tagged="${GITHUB_REF_NAME#v}"
+          echo "pyproject: $declared, tag: $tagged"
+          [ "$declared" = "$tagged" ] || { echo "::error::tag $GITHUB_REF_NAME does not match version $declared"; exit 1; }
+
+      - name: Build sdist and wheel
+        run: uv build
+
+      - name: Check metadata
+        run: uvx twine check --strict dist/*
+
+      # A cold install into an empty venv — the environment every `pip install
+      # kicad-netspec` user starts from, which no other job reproduces. No extras: the
+      # core claims zero runtime dependencies, and this is where that claim meets the
+      # built wheel rather than the source tree.
+      #
+      # `--no-config` because `uv pip` reads `[tool.uv]` by walking up from the CWD, and
+      # this step runs inside the checkout. netspec has nothing there that would change
+      # resolution today; the step's whole claim is that it reproduces a consumer's
+      # environment, and a consumer is not standing in this directory.
+      - name: Smoke-test the wheel
+        run: |
+          uv venv /tmp/smoke
+          VIRTUAL_ENV=/tmp/smoke uv pip install --no-config dist/*.whl
+          version=$(/tmp/smoke/bin/netspec --version)
+          echo "$version"
+          [ "$version" = "netspec ${GITHUB_REF_NAME#v}" ] || { echo "::error::--version says '$version'"; exit 1; }
+
+      - name: Assert the core has no runtime dependencies
+        run: |
+          VIRTUAL_ENV=/tmp/smoke uv pip list --format=json --no-config \
+            | python3 -c "
+          import json, sys
+          installed = {p['name'].lower() for p in json.load(sys.stdin)}
+          extra = installed - {'kicad-netspec'}
+          print('installed alongside:', sorted(extra) or 'nothing')
+          sys.exit(1 if extra else 0)"
+
+      - uses: actions/upload-artifact@v4.6.2
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: [build]
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    # Named in the Trusted Publisher registration. Renaming breaks the binding.
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4.3.0
+        with:
+          name: dist
+          path: dist/
+
+      # SHA-pinned, not `@release/v1`. This is the one action holding the OIDC identity
+      # for PyPI, and a branch ref is mutable — its contents can change between one
+      # release and the next. Pin below is v1.14.2; bump it deliberately, with the
+      # version in the comment.
+      #
+      # Keep it CURRENT, not merely pinned. This action bundles its own twine, and an
+      # old one rejects new metadata: v1.12.4 failed the first 0.5.0 attempt with
+      # `InvalidDistribution: '2.5' is not a valid metadata version`, because hatchling
+      # emits Metadata-Version 2.5 for a PEP 639 SPDX license. The `twine check` in the
+      # build job did NOT catch it — uvx fetches a current twine, so the build verified
+      # against a newer parser than the one that actually gates the upload.
+      - uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
+
+  major-tag:
+    # Consumers write `uses: CameronBrooks11/netspec@v0`, which is the convention for
+    # actions and needs a major tag that moves with each release. Only after a
+    # successful publish, so the moving tag never points at a version nobody can install.
+    #
+    # Note the asymmetry with everything above: this is deliberately a *mutable* ref,
+    # because that is what the consumer contract asks for. It is ours to move; the
+    # third-party pins are not.
+    name: Move the major tag
+    needs: [publish]
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4.2.2
+        with:
+          fetch-depth: 0
+
+      - name: Point v<major> at this release
+        run: |
+          version="${GITHUB_REF_NAME#v}"
+          major="v${version%%.*}"
+          # A pre-1.0 prerelease should not move the tag people pin to.
+          case "$version" in *[!0-9.]*) echo "prerelease $version; leaving $major alone"; exit 0;; esac
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git tag -f -a "$major" -m "netspec $GITHUB_REF_NAME"
+          git push -f origin "$major"
+          echo "$major -> $GITHUB_REF_NAME"

kicad_netspec-0.5.1/.github/workflows/self-connectivity.yml

@@ -0,0 +1,34 @@
+name: Self-connectivity
+
+# netspec runs its own Action against its own fixtures, so the Action is exercised on
+# every pull request that touches them. It is also the honest way to demonstrate the
+# tool: dogfooding on a repo we own, rather than on someone's real board.
+
+on:
+  pull_request:
+    paths:
+      - "tests/fixtures/**"
+      - "src/kicad_netspec/**"
+      - "action.yml"
+      - ".github/workflows/self-connectivity.yml"
+
+jobs:
+  connectivity:
+    runs-on: ubuntu-latest
+    container: ghcr.io/inti-cmnb/kicad10_auto:latest
+    permissions:
+      contents: read
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      # netspec-version below points the action's own installer at this checkout, so
+      # the code under test is what runs -- not a release.
+      - uses: ./
+        with:
+          schematic: |
+            tests/fixtures/good_ldo.kicad_sch
+            tests/fixtures/polcap_rail_correct.kicad_sch
+          netspec-version: "-e ."

kicad_netspec-0.5.1/.gitignore

@@ -0,0 +1,43 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+*.egg
+.eggs/
+dist/
+build/
+.venv/
+venv/
+env/
+
+# Type checking / linting
+.mypy_cache/
+.ruff_cache/
+.pyright/
+.pytype/
+
+# Testing
+.pytest_cache/
+.coverage
+coverage.xml
+htmlcov/
+*.cover
+
+# Jupyter
+.ipynb_checkpoints/
+*.ipynb_checkpoints
+
+# uv
+.python-version
+uv.lock
+
+# Environment
+.env
+.env.local
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Personal scratch (never committed)
+working/

kicad_netspec-0.5.1/.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.12
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-merge-conflict

kicad_netspec-0.5.1/AGENTS.md

@@ -0,0 +1,34 @@
+# AGENTS.md — netspec
+
+Verify PCB connectivity against declared engineering intent, using KiCad as the oracle.
+
+## The rules that are not negotiable
+
+Read `docs/DECISIONS.md` before changing anything structural. Four decisions are enforced
+by tests, and a change that trips one is a design change, not a bug fix:
+
+1. **netspec never writes to a design file** (D2). Not schematics, boards, or libraries.
+   If a feature needs to mutate a design, it belongs in a different project.
+2. **Never `import pcbnew`** (D3). It is already deleted in KiCad master.
+3. **KiCad only leaks in through `oracle/`** (D4). No `kicad-cli` string and no
+   `subprocess` import anywhere else — that boundary is the whole KiCad 11 migration plan.
+4. **No tolerances** (D9). Connectivity is exact. The words *tolerance*, *approximate* and
+   *interval* are banned from the model; they are partspec's epistemics, not ours.
+
+## KiCad facts
+
+Never plan against KiCad's roadmap wiki — it is stale (D6). Verify against `master` by
+counting `registerHandler<>` calls, and pin what you rely on in
+`tests/test_kicad_assumptions.py`.
+
+`just assumptions <path-to-kicad-checkout>` re-verifies on demand; CI does it weekly.
+
+## Workflow
+
+`just check && just test` before every commit. Conventional Commits. Never `--no-verify`.
+
+## Related
+
+Sibling projects, deliberately non-overlapping: `partspec` (mechanical CAD parts),
+`gerberdiff` (fabrication output). Design review belongs to `kicad-happy`; authoring
+belongs to Konnect / SKiDL / atopile.

kicad_netspec-0.5.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.