wrenchroom 0.1.0__tar.gz

wrenchroom-0.1.0/.gitattributes

@@ -0,0 +1,4 @@
+# The three.js bundle the HTML view embeds is built by scripts/vendor_three.py, not
+# written by hand: collapsed in diffs and left out of the language count. Its bytes
+# are checked against a fresh build by `scripts/lanes.py vendor-check`.
+src/wrenchroom/view/vendor/three.min.js linguist-generated linguist-vendored

wrenchroom-0.1.0/.github/dependabot.yml

@@ -0,0 +1,20 @@
+# Keep the pinned GitHub Actions from going stale silently.
+#
+# Every third-party action in the workflows is pinned to a commit SHA, because a floating
+# tag is a mutable reference to somebody else's code. But a SHA cannot look outdated, so
+# Dependabot opens a pull request when an action moves and rewrites the SHA and the
+# trailing tag comment: the pin survives and the staleness becomes visible.
+#
+# Actions only. Python dependencies are resolved by `uv.lock`, whose updates go through
+# `uv lock --upgrade`; a second updater on the same file would fight it.
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    groups:
+      actions:
+        patterns: ["*"]
+    commit-message:
+      prefix: ci

wrenchroom-0.1.0/.github/rulesets/main.json

@@ -0,0 +1,89 @@
+{
+  "bypass_actors": [],
+  "conditions": {
+    "ref_name": {
+      "exclude": [],
+      "include": [
+        "~DEFAULT_BRANCH"
+      ]
+    }
+  },
+  "enforcement": "active",
+  "name": "main",
+  "rules": [
+    {
+      "type": "deletion"
+    },
+    {
+      "type": "non_fast_forward"
+    },
+    {
+      "type": "required_linear_history"
+    },
+    {
+      "parameters": {
+        "allowed_merge_methods": [
+          "rebase"
+        ],
+        "dismiss_stale_reviews_on_push": false,
+        "require_code_owner_review": false,
+        "require_extra_approval_for_unattributed_changes": true,
+        "require_last_push_approval": false,
+        "required_approving_review_count": 0,
+        "required_review_thread_resolution": false,
+        "required_reviewers": []
+      },
+      "type": "pull_request"
+    },
+    {
+      "parameters": {
+        "do_not_enforce_on_create": false,
+        "required_status_checks": [
+          {
+            "context": "gates",
+            "integration_id": 15368
+          },
+          {
+            "context": "fast (ubuntu-latest, 3.13)",
+            "integration_id": 15368
+          },
+          {
+            "context": "fast (ubuntu-latest, 3.14)",
+            "integration_id": 15368
+          },
+          {
+            "context": "fast (macos-latest, 3.13)",
+            "integration_id": 15368
+          },
+          {
+            "context": "fast (macos-latest, 3.14)",
+            "integration_id": 15368
+          },
+          {
+            "context": "perf (ubuntu-latest)",
+            "integration_id": 15368
+          },
+          {
+            "context": "perf (macos-latest)",
+            "integration_id": 15368
+          }
+        ],
+        "strict_required_status_checks_policy": false
+      },
+      "type": "required_status_checks"
+    },
+    {
+      "parameters": {
+        "code_scanning_tools": [
+          {
+            "alerts_threshold": "errors",
+            "security_alerts_threshold": "high_or_higher",
+            "tool": "CodeQL"
+          }
+        ]
+      },
+      "type": "code_scanning"
+    }
+  ],
+  "target": "branch"
+}

wrenchroom-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,98 @@
+# Continuous integration for wrenchroom.
+#
+# Every lane is invoked through `scripts/lanes.py`, never by spelling out a tool's
+# command here. Two spellings of "how this project runs its checks" is how a flag
+# exists locally and not in CI, or the other way round.
+#
+# Third-party actions are pinned to a commit SHA with the tag in a trailing comment.
+# A floating tag is a mutable reference to somebody else's code with a token in scope.
+# Dependabot keeps the pins from going stale silently; re-pin deliberately, reading the
+# diff, rather than by moving the tag.
+#
+# Both Pythons the project claims (3.13 the floor, 3.14 current) and both platforms the
+# CAD stack has wheels for in CI (Linux x86_64, macOS arm64). The OCP wheel is the
+# headless `cadquery-ocp-novtk`, which is what lets this run on a runner at all.
+
+name: ci
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ci-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  # Static gates: ruff lint, ruff format, ty. Linux only; nothing these tools check is
+  # platform-dependent.
+  gates:
+    timeout-minutes: 15
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          enable-cache: true
+      - run: uv python install
+      - run: uv sync --frozen
+      - run: uv run --frozen python scripts/lanes.py gates
+
+  # The unit suite on every platform and Python the project claims. The HTML view's
+  # tests use the Node and Chrome the runner images come with; under CI a missing
+  # one fails the run instead of skipping (tests/golden/test_view_browser.py).
+  fast:
+    timeout-minutes: 20
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python: ["3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          enable-cache: true
+      - run: uv python install ${{ matrix.python }}
+      - run: uv sync --frozen --python ${{ matrix.python }}
+      - run: uv run --frozen python scripts/lanes.py fast
+        env:
+          WRENCHROOM_ARTIFACTS: ${{ runner.temp }}/view
+      # The golden bench's HTML report and what headless Chrome drew of it, to open
+      # or look at; one copy per platform.
+      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        if: always() && matrix.python == '3.13'
+        with:
+          name: bench-view-${{ matrix.os }}
+          path: ${{ runner.temp }}/view
+          if-no-files-found: warn
+          retention-days: 14
+
+  # The speed target: the golden bench scaled to 500 fasteners, read and checked
+  # inside 10 s. The timing REPORTS for now (the perf-report lane writes it to
+  # the run summary and doesn't gate on it): hosted runners are slower and
+  # noisier than the laptop the target is set for. The verdict counts DO gate,
+  # so this is also a 500-fastener correctness run on every push. Once a few
+  # weeks of numbers show where the runners sit, switch to the gating perf lane
+  # with the budget those numbers support.
+  perf:
+    timeout-minutes: 20
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          enable-cache: true
+      - run: uv python install 3.13
+      - run: uv sync --frozen --python 3.13
+      - run: uv run --frozen python scripts/lanes.py perf-report

wrenchroom-0.1.0/.github/workflows/nightly.yml

@@ -0,0 +1,52 @@
+# The golden bench against tomorrow's dependencies.
+#
+# The per-push lanes run `uv sync --frozen`: they prove this code against the lock.
+# This one syncs with `--upgrade` first, so a new OCP or build123d that moves a
+# bench verdict shows up here before a Dependabot PR lands it. It opens nothing and
+# pushes nothing; a failure is just a red run for a person to read.
+#
+# Same SHA-pinning rule as ci.yml.
+
+name: nightly
+
+on:
+  schedule:
+    - cron: "41 3 * * *"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  golden-upgraded:
+    timeout-minutes: 30
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          enable-cache: true
+      - run: uv python install ${{ matrix.python }}
+      - run: uv lock --upgrade
+      - run: uv sync --python ${{ matrix.python }}
+      - run: uv run python scripts/lanes.py golden
+
+  # The three.js the HTML view embeds, rebuilt from its pinned npm tarball (checked
+  # against the registry's sha512) by its pinned esbuild, and compared byte for byte
+  # with the committed bundle. Node comes with the runner image. A red run means the
+  # committed file is not what it claims to be, or a pinned source changed under it.
+  three-bundle:
+    timeout-minutes: 15
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          enable-cache: true
+      - run: uv python install 3.13
+      - run: uv sync --frozen --python 3.13
+      - run: uv run --frozen python scripts/lanes.py vendor-check

wrenchroom-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,94 @@
+# Release: build, prove and publish wrenchroom when a version tag is pushed.
+#
+# Publishing is PyPI's Trusted Publishing. PyPI trusts this workflow, by its file
+# name (release.yml), in this repository, running in the `pypi` environment, through
+# a short-lived OIDC token: no API token is stored anywhere. Renaming this file or
+# the environment breaks publishing until the publisher on PyPI is changed to match.
+#
+# The `pypi` environment deploys only from `v*` tags and waits for a maintainer's
+# approval. That approval is the one step that can't be undone: PyPI never takes the
+# same version twice, so a bad release is yanked and followed, never replaced.
+#
+# Run by hand (workflow_dispatch), only the build job runs: a dry run of everything
+# but the upload. docs/releasing.md has the steps.
+#
+# Actions are pinned to a commit SHA with the tag in a trailing comment, as in ci.yml.
+
+name: release
+
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch:
+
+permissions: {}
+
+concurrency:
+  group: release-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  # The tag names the version; the sdist and wheel are built, checked, and the wheel
+  # run on the README's example in a clean environment (scripts/release.py).
+  build:
+    timeout-minutes: 20
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+      - run: uv python install
+      - run: uv sync --frozen
+      - run: uv run --frozen python scripts/lanes.py release-check
+      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+          retention-days: 30
+
+  # The upload, after a maintainer approves the `pypi` deployment. The token PyPI
+  # trusts exists only in this job, and the action attaches the files' provenance
+  # (PEP 740 attestations) as it uploads.
+  publish:
+    if: github.ref_type == 'tag'
+    needs: build
+    timeout-minutes: 15
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/wrenchroom/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
+
+  # The GitHub release for the tag, once PyPI has the files: the same files, and
+  # notes made from the pull requests merged since the last release.
+  github-release:
+    if: github.ref_type == 'tag'
+    needs: publish
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
+        with:
+          name: dist
+          path: dist/
+      - env:
+          GH_TOKEN: ${{ github.token }}
+          TAG: ${{ github.ref_name }}
+        run: |
+          pre=""
+          if [[ "$TAG" =~ (a|b|rc)[0-9]+$ ]]; then pre="--prerelease"; fi
+          gh release create "$TAG" dist/* --repo "$GITHUB_REPOSITORY" --verify-tag \
+            --title "wrenchroom ${TAG#v}" --generate-notes $pre

wrenchroom-0.1.0/.gitignore

@@ -0,0 +1,52 @@
+# Plans, scratch, reviews — never committed
+_plans/
+_tmp/
+_reviews/
+_reports/
+# examples/ ships with the package (it's part of the docs) — deliberately NOT ignored.
+
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+*.so
+
+# Envs & tooling caches
+.venv/
+venv/
+env/
+.uv-cache/
+.pytest_cache/
+.ruff_cache/
+.ty_cache/
+.mypy_cache/
+.hypothesis/
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+# mutation lane (mutmut 3.x): the mutants/ working copy + the per-run generated config
+mutants/
+setup.cfg
+.mutmut-cache
+.benchmarks/
+
+# OS / editor
+.DS_Store
+*.swp
+.idea/
+.vscode/
+
+# AI Files
+CLAUDE.md
+GEMINI.md
+.claude/
+
+# What examples/ writes when run: generated, never committed
+examples/*.step
+examples/*.html
+examples/*.json
+examples/*.md

wrenchroom-0.1.0/.python-version

@@ -0,0 +1 @@
+3.13

wrenchroom-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.