sw2robot 0.4.1__tar.gz

sw2robot-0.4.1/.gitignore

@@ -0,0 +1,37 @@
+# Python
+.venv/
+__pycache__/
+*.pyc
+*.egg-info/
+build/
+dist/
+# uv lockfile: CI / release resolve deps with pip, not uv, so the lock is only
+# a local `uv run` convenience -- untracked to avoid version churn / drift
+uv.lock
+
+# regenerated mesh caches (3DXML -> GLB, done on first view) -- keep the .3dxml
+*.3dxml.glb
+
+# build artifacts sw2urdf.build regenerates from graph.json
+output/
+examples/*/urdf/
+examples/*/package.xml
+examples/*/CMakeLists.txt
+
+# test / tooling
+tests/e2e/node_modules/
+tests/e2e/package-lock.json
+# runtime artifacts the editor writes into a served URDF package (keep the
+# e2e fixtures pristine -- the overlay sidecar + live copy are regenerated)
+tests/e2e/fixtures/**/*.sw2robot.json
+tests/e2e/fixtures/**/.*.live.urdf
+tests/e2e/fixtures/**/.*.expanded-preview-source.urdf
+tests/e2e/fixtures/**/.*.collapsed-preview.urdf
+_server*.txt
+_client_report.json
+_sldasm_index.json
+_sw_spawned_pids.txt
+
+# A global core.excludesFile ignores dotpaths via ".*"; keep repo meta tracked.
+!.github/
+!.github/**

sw2robot-0.4.1/CONTRIBUTING.md

@@ -0,0 +1,134 @@
+# Contributing to sw2robot
+
+Thanks for your interest in improving sw2robot. This document explains how to
+propose changes so that they are reviewable by a small maintainer team.
+
+Please read the two short sections below before opening an issue or a pull
+request. They exist to keep review load sustainable — not to gatekeep.
+
+## TL;DR
+
+- **Discuss first, code second.** Open an issue and get a maintainer to agree on
+  the approach before sending an implementation PR.
+- **One PR = one reviewable change.** Small and focused beats large and stacked.
+- **Disclose AI usage.** Say which tool you used and for what. See below.
+- **Verify before you send.** If you didn't run it, it isn't ready.
+
+## Issues
+
+- **Keep it short and specific.** State the problem, what you expected, and (for
+  bugs) exact steps to reproduce. A few focused sentences are worth more than a
+  long essay.
+- **One topic per issue.** Don't batch several unrelated discussions into one
+  thread, and don't open many broad "discussion" issues at once — maintainers
+  cannot review them in parallel. Land one before opening the next.
+- **Human-in-the-loop for AI.** You may use AI to help draft an issue, but a
+  human must read, edit, and stand behind every word before you post it.
+  Unedited, machine-generated walls of text will be closed with a request to
+  condense.
+
+### Attach a reproducible sample
+
+This is an open-source project, so anything a maintainer cannot reproduce is
+very hard to act on. If your issue involves a specific SolidWorks assembly or
+part — a bug during extract/build, a wrong result, a shape the tool mishandles —
+please attach the relevant `.sldasm` / `.sldprt` files (and any references they
+need) as a **`.zip`** so we can open and inspect them here.
+
+Two rules keep this practical and safe:
+
+- **Make it minimal.** Include only what is needed to reproduce the behavior —
+  the smallest assembly/parts that still show the problem, not your whole
+  production model.
+- **Never upload confidential CAD.** If the real parts are proprietary, replace
+  them with **dummy stand-ins** — simple placeholder geometry that reproduces
+  the same behavior (the mate structure, subassembly nesting, coordinate frame,
+  or shape characteristic that matters). Share the reproduction, not your
+  secrets.
+
+If you genuinely cannot share a reproducible sample, say so and describe the
+structure precisely instead — but expect that undiagnosable reports may be
+closed.
+
+## Pull requests
+
+### Issue-first
+
+Implementation PRs must reference an **accepted** issue — an issue a maintainer
+has labelled [`accepted`](https://github.com/jsk-ros-pkg/solidworks_urdf_exporter2/issues?q=is%3Aissue+label%3Aaccepted),
+meaning the direction has been agreed. Open an issue, discuss it, and wait for
+that label before writing the implementation. Drive-by PRs that do not reference
+an `accepted` issue may be closed without a full review, regardless of how much
+code they contain. This is the single most important rule here: it prevents
+wasted work on both sides.
+
+**Maintainers are exempt.** Maintainers may open PRs directly without a
+pre-filed `accepted` issue — they own the roadmap and are trusted to apply good
+judgment. The keep-it-small, verify-it, and demo-for-UI rules below still apply
+to everyone, maintainers included. For a non-trivial or contentious change, a
+maintainer is still encouraged to open an issue first so others can weigh in.
+
+### Keep PRs small and independent
+
+- Aim for one logical change per PR. If you find yourself writing "Part 3 of 7"
+  or stacking many branches, that is a signal to stop and talk to a maintainer
+  about scope first.
+- Large stacked PRs (thousands of lines across many dependent branches) will be
+  sent back for splitting. Reviewers review the **diff**, not the description —
+  a change that cannot be understood from its diff is not ready.
+- Write the PR description for a human reviewer: a few lines on *what* changed
+  and *why*. Skip auto-generated multi-section essays.
+
+### Verify your change
+
+Before requesting review, make sure:
+
+- The code builds and the test suite passes locally.
+- You have **actually run** the change and confirmed it does what the PR claims,
+  on the platforms it affects (note that `extract` is Windows + SolidWorks only).
+- New behavior has a test where practical.
+
+### Show your work for UI changes
+
+If your PR changes the browser editor UI or any user-visible behavior, include
+**proof that you ran it**:
+
+- A **short screen recording** (a few seconds is enough) of the new behavior in
+  action is required for interactive changes — a new control, a changed flow, a
+  fixed visual bug. GitHub lets you drag a video straight into the PR
+  description.
+- A **before/after screenshot** is acceptable for a purely static visual change
+  (layout, color, label).
+
+This is not busywork: a working demo is the clearest evidence that the change
+does what the description says. PRs that alter the UI without a demo will be sent
+back with a request for one before review.
+
+## AI usage policy
+
+sw2robot is not anti-AI. Maintainers use AI tooling too. We care about the
+**quality** of a contribution, not how it was produced. The rules exist because
+low-effort, unverified AI output shifts the entire cost of a contribution onto
+the people reviewing it.
+
+1. **Disclose all AI usage.** In the PR/issue, state the tool(s) used and the
+   extent of assistance (e.g. "drafted with an LLM, reviewed and edited by
+   hand", or "wrote the tests myself, used AI for the docstrings").
+2. **AI-assisted implementation PRs are for `accepted` issues only.** See
+   Issue-first above.
+3. **You are responsible for everything you submit.** "The AI wrote it" is not
+   an explanation for a bug or a design choice. You must understand and be able
+   to defend every line.
+4. **No AI-generated media** (images, video, audio) in issues, PRs, or the repo.
+5. **Repeatedly submitting unverified AI slop** — fabricated bug reports, code
+   the author clearly doesn't understand, or floods of stacked PRs/issues — may
+   result in being blocked from further contributions.
+
+If you follow these rules, AI assistance is welcome. If you use it to generate
+volume you haven't reviewed, expect it to be closed.
+
+## Questions
+
+If you're unsure whether something is in scope or how big a change should be,
+open an issue and ask before writing code. That conversation is always cheaper
+than a rejected PR.

sw2robot-0.4.1/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 2026 Iori Yanokura
+
+   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.