Files
make-cad/docs/skill/references/SDK_OVERVIEW.md
T
Ni Jingzhe afb63fc375 release: 2.3.0 (includes the never-published 2.2.9)
DECISION: release the one-solid Part, the Windows build fix and the three issue fixes (#87, #88, #89) as 2.3.0. Not 2.2.10:
the owner chose 2.3.0. 2.2.9 is skipped; it was prepared on dev but never tagged or published (no v2.2.9 tag, nothing on PyPI,
the dry run of its workflow published nothing), so there is nothing to withdraw.

WHY A MINOR VERSION
- It removes interface of the withdrawn 2.2.8 (`bodies=`, `Part.multi_body`, profile 3), adds keywords (`clean=` on three
  booleans), and widens the exporters' input.
- It changes a default: `cut_rsolid`, `cut_rsolid_list` and `intersect_rsolid` unify their result, so the topology and the
  fingerprint of a body that used to keep a split face change.
- It breaks a recorded format on purpose: `clean` is a required parameter of the three recorded operations, a graph recorded
  before 2.3.0 is rejected on replay and has to be recorded again (the owner's rule: no branches for old formats).

WHAT CHANGES
- pyproject.toml, uv.lock (the simplecadapi package entry), docs/skill/SKILL.md and docs/skill/references/SDK_OVERVIEW.md:
  2.2.9 -> 2.3.0.
- CHANGELOG.md: the 2.2.9 entry becomes 2.3.0 (2026-11-12) and gains the four changes; "Fixed" gains the blend validity check.
- docs/updates/2.3.0.md and 2.3.0.zh-CN.md replace the 2.2.9 notes (deleted): everything the 2.2.9 notes said, then the booleans,
  the exporters and read-only runs, the fingerprints, and the Windows build. The release workflow turns them into the release
  page.

Checked: test_skill_lint and test_auto_docs_gen pass; the release workflow checks that the tag equals the pyproject version
(v2.3.0). test_skill_build::test_files_without_directives_copied_verbatim fails on the base commit as well (a Windows encoding
problem of this machine). The code of dev was green in CI at 8c482366 before this commit; this commit changes no code.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-11-12 14:47:57 +08:00

1.8 KiB

SDK Overview

  • Project: simplecadapi
  • Version: 2.3.0
  • Package distribution: simplecadapi==2.3.0

What this skill bundles

  • Task router (SKILL.md) with seven workflows (including unattended mode)
  • Capability domains (references/domains/)
  • Modeling discipline (references/discipline/)
  • Generated API/stdlib/core references (references/docs/)

What this skill does not bundle

  • SDK source code (src/simplecadapi) is intentionally excluded.
  • Environment/bootstrap workflows are intentionally not the focus here.
  • Self-evolving or skill-local case packaging is intentionally excluded.

Main SDK surfaces

  • Geometry and modeling operations in references/docs/api/.
  • Standard parts library in references/docs/stdlib/, including scad.std.gear gear, ring gear, rack, and cycloidal disc factories plus scad.std.bearing bearing assembly factories.
  • Core shape/type semantics in references/docs/core/.
  • Graph/model serialization and replay APIs.
  • Expression, parameter, and semantic reference types.
  • Functional tagging with apply_tag(shape=..., tag=...), list_tags(shape=...), and QL tag predicates.

Preferred replayable workflow

  • Record modeling steps inside GraphSession when you need replayable outputs.
  • Export session/model payloads with export_session_json() and export_model_json().
  • Re-import or replay with import_model_json() and replay_model_json().

Example SDK usage

import simplecadapi as scad
from simplecadapi import GraphSession, export_model_json, replay_model_json

with GraphSession(graph_id="box") as session:
    shape = scad.make_box_rsolid(width=10.0, height=20.0, depth=30.0)
    session.capture_result(value=shape)
    payload = export_model_json(session=session)

rebuilt = replay_model_json(json_str=payload)
print(len(rebuilt))