draftwright 0.1.12__tar.gz → 0.2.0__tar.gz

{draftwright-0.1.12 → draftwright-0.2.0}/CHANGELOG.md

@@ -2,6 +2,102 @@
 
 ## Unreleased
 
+## v0.2.0 — 2026-06-30
+
+A major release. draftwright took ownership of feature recognition and linting
+(ADR 0007) and was re-architected onto a feature-IR + dimensioning-planner
+"compiler" (ADR 0008), gaining a Typer CLI and a portable, pure-Python PDF path
+along the way. **Generated drawings change** versus v0.1.13: the new pipeline
+dimensions parts more completely and consistently, so placement and the set of
+dimensions can differ — output is not byte-compatible with prior releases.
+
+### Changed
+
+- **Re-architected onto a feature-IR + dimensioning planner** (ADR 0008). The
+  engine is now a compiler: detectors build one feature inventory → a typed IR /
+  `PartModel` → a dimensioning planner emits render-intents → shared
+  layout/projection/export. Orientation and feature-kind are *data in the IR*,
+  not code branches, and every feature class (holes, patterns, counterbores,
+  slots, turned diameters/steps, centre marks, location dims, envelope/OD,
+  section A–A, PMI/GD&T) was migrated onto this one path; the old parallel
+  recognisers and placement passes were deleted as each was replaced. Net effect
+  for users: more complete, more consistent drawings — but output differs from
+  v0.1.13.
+- **draftwright owns feature recognition and linting** (ADR 0007). The hole/
+  boss/cylinder/pattern recognisers, the slot/turned-step recognisers, and the
+  feature-coverage lint engine are vendored into `recognition/` and `linting.py`;
+  `build123d-drafting-helpers` is now purely the rendering library.
+- **The CLI writes a PDF by default** and takes a `--format` selector (#288).
+  Previously `draftwright part.step` emitted SVG + DXF; it now emits a single PDF.
+  Choose outputs with `--format` (a comma-list, with an `all` alias) —
+  `--format pdf,dxf`, `--format svg`, `--format all`. The library API is
+  unchanged: `make_drawing(...)` / `Drawing.export()` still write SVG + DXF.
+- **PDF export is now pure-Python and a core capability** (#288). The renderer
+  moved from `cairosvg` (which `dlopen`s the native `libcairo` system library —
+  absent on stock macOS/Windows, so PDF-by-default would have crashed there) to
+  `svglib` + `reportlab`, both pip-installable wheels with no system dependency.
+  PDF therefore works out of the box on every platform; output is visually
+  identical to the cairo renderer.
+
+### Added
+
+- **A Typer command-line interface** (#289/#291): shell completion
+  (`--install-completion` / `--show-completion`), rich `--help`, and `--version`
+  (reports the installed distribution version). All existing flags are preserved.
+- **`--format` output selector** (#288) — `pdf` (default), `svg`, `dxf`, or `all`,
+  as a comma-list.
+- **Turned-part dimensioning**: axial step-length recognition and chains
+  (#188/#189/#231), step-diameter callouts, collapse of a uniform step
+  staircase to an "N× length" note (#290), and OD of a horizontal (X/Y) round
+  body dimensioned on the profile view (#292).
+- **Slot recognition and dimensioning** converged onto the IR as `SlotFeature`
+  (#242), and **section A–A** is now triggered by the planner (#271).
+- **A Contributor License Agreement** (#183).
+
+### Removed
+
+- **The `--pdf` flag** (use `--format pdf`, the new default), the **`[pdf]`
+  install extra**, and the **`cairosvg` dependency** (#288).
+- The byte-exact golden-output test harness (#190) — regression coverage rests on
+  the geometry-level and standards suites (ADR 0005 §3 / ADR 0007).
+
+### Fixed
+
+- Locate **every** side-drilled (off-axis) hole, not just the first (#225/#286).
+- Don't mis-detect a prismatic part with incidental cylinders as a turned part
+  (#293/#294); drop phantom zero-diameter turned steps (#279/#284); skip an
+  illegibly-dense step-length chain rather than cram it (#293/#296).
+- Degraded hole-pattern callout consistency (#262/#274).
+- Windows `python -m draftwright.make_drawing` CLI smoke / entrypoint (#181/#182).
+
+## v0.1.13 — 2026-06-27
+
+### Changed
+
+- **Requires `build123d-drafting-helpers>=0.13.0`; text pinned to bundled fonts**
+  (#149, ADR 0006). draftwright now vendors IBM Plex (OFL-1.1) and renders and
+  measures all text via `font_path` — IBM Plex Mono for dimensions/callouts/notes,
+  IBM Plex Sans Condensed for the title block — instead of resolving the system
+  font name `"Arial"`. Resolving a name substitutes a different font on Linux,
+  which shifted the whole sheet ~1 mm; pinning a bundled font file makes generated
+  layout **deterministic across Linux/macOS/Windows** and gives a consistent
+  typeface. **Drawing output changes**: positions shift slightly from prior
+  releases and labels render in IBM Plex (helpers #172).
+
+### Internal
+
+- **Compiler-pipeline module split** (#138, ADR 0005). The two large modules
+  `make_drawing.py` (3,907 lines) and `annotate.py` (2,587) were decomposed into a
+  DAG of focused stage modules — `projection`, `sheet`, `analysis`, `drawing`,
+  `builder`, the `annotations/` subpackage (sections/turned/pmi/holes/orchestrator),
+  alongside the existing `registry`/`linting`/`repair`/`export`/`fonts`. Annotation
+  identity, the lint coverage signal, and the deterministic repair loop each gained a
+  single owner; `make_drawing.py` / `annotate.py` are now thin compat facades, so all
+  existing imports and the `draftwright` CLI entry point keep working. A golden-output
+  regression gate verified every step is behaviour-preserving (output byte-identical),
+  and mypy was tightened on the settled contracts. No public API or drawing-output
+  change. (Phases #160–#166.)
+
 ## v0.1.12 — 2026-06-21
 
 ### Changed

{draftwright-0.1.12 → draftwright-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: draftwright
-Version: 0.1.12
+Version: 0.2.0
 Summary: Automated technical-drawing generation for build123d
 Project-URL: Homepage, https://github.com/pzfreo/draftwright
 Project-URL: Repository, https://github.com/pzfreo/draftwright
@@ -680,12 +680,13 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Scientific/Engineering
 Requires-Python: <3.15,>=3.10
-Requires-Dist: build123d-drafting-helpers>=0.12.0
+Requires-Dist: build123d-drafting-helpers>=0.13.0
 Requires-Dist: build123d>=0.9.0
 Requires-Dist: kiwisolver<2,>=1.4
 Requires-Dist: numpy>=1.24
-Provides-Extra: pdf
-Requires-Dist: cairosvg>=2.7; extra == 'pdf'
+Requires-Dist: reportlab>=4.0
+Requires-Dist: svglib>=1.5
+Requires-Dist: typer>=0.12
 Description-Content-Type: text/markdown
 
 # draftwright
@@ -714,6 +715,9 @@ Or from the command line:
 
 ```
 draftwright my_part.step --title "Mounting Block" --number DWG-001
+# writes my_part.pdf (the default); add --format to choose:
+draftwright my_part.step --format pdf,dxf    # PDF + DXF
+draftwright my_part.step --format all        # PDF + SVG + DXF
 ```
 
 ## What it produces
@@ -756,8 +760,7 @@ make_drawing(part, out="drawing", title="My Part", number="DWG-001")
 # Composable: get a Drawing object to inspect or extend
 dwg = build_drawing(part, title="My Part")
 issues = dwg.lint()          # list[LintIssue]
-dwg.export_svg("drawing.svg")
-dwg.export_dxf("drawing.dxf")
+svg_path, dxf_path = dwg.export("drawing")
 ```
 
 ### From a STEP file
@@ -809,7 +812,10 @@ generation, the lint→repair loop, and the constraint-based layout engine).
 
 ## Architecture
 
-draftwright is a single module (`make_drawing.py`) on top of two libraries:
+draftwright is structured as a **part-drawing compiler** (ADR 0008): feature
+detectors → a `PartModel` IR (`Feature`s exposing `DimParameter`s) → a dimensioning
+planner → renderers, feeding a shared layout/projection/export stack. It builds on
+two libraries:
 
 ```
 draftwright
@@ -817,7 +823,13 @@ draftwright
     └── build123d                   — CAD kernel
 ```
 
-The engine handles view layout (strip/zone model), scale selection, feature recognition
-(holes, bosses, bolt circles), annotation placement, and section view generation.
-Annotation primitives (`Dimension`, `Leader`, `lint_drawing`, etc.) live in
-`build123d-drafting-helpers` and can be used independently.
+It owns feature recognition (`recognition/`) and linting (`linting/`); annotation
+primitives (`Dimension`, `Leader`, etc.) live in `build123d-drafting-helpers` and can
+be used independently. The compiler is largely converged in production — turned
+dims/lengths, centre marks, envelope, slots, holes (callouts/locations/grouping),
+the section A–A trigger, the prismatic step-ladder + rotational furniture, and PMI/GD&T
+are all on the IR — the migration is complete (one path; the orchestrator is
+build → plan → render). See
+[`docs/target-architecture.md`](docs/target-architecture.md) and
+[`docs/adr/`](docs/adr/). The engine handles view layout (strip/zone model), scale
+selection, annotation placement, and section rendering.

{draftwright-0.1.12 → draftwright-0.2.0}/README.md

@@ -24,6 +24,9 @@ Or from the command line:
 
 ```
 draftwright my_part.step --title "Mounting Block" --number DWG-001
+# writes my_part.pdf (the default); add --format to choose:
+draftwright my_part.step --format pdf,dxf    # PDF + DXF
+draftwright my_part.step --format all        # PDF + SVG + DXF
 ```
 
 ## What it produces
@@ -66,8 +69,7 @@ make_drawing(part, out="drawing", title="My Part", number="DWG-001")
 # Composable: get a Drawing object to inspect or extend
 dwg = build_drawing(part, title="My Part")
 issues = dwg.lint()          # list[LintIssue]
-dwg.export_svg("drawing.svg")
-dwg.export_dxf("drawing.dxf")
+svg_path, dxf_path = dwg.export("drawing")
 ```
 
 ### From a STEP file
@@ -119,7 +121,10 @@ generation, the lint→repair loop, and the constraint-based layout engine).
 
 ## Architecture
 
-draftwright is a single module (`make_drawing.py`) on top of two libraries:
+draftwright is structured as a **part-drawing compiler** (ADR 0008): feature
+detectors → a `PartModel` IR (`Feature`s exposing `DimParameter`s) → a dimensioning
+planner → renderers, feeding a shared layout/projection/export stack. It builds on
+two libraries:
 
 ```
 draftwright
@@ -127,7 +132,13 @@ draftwright
     └── build123d                   — CAD kernel
 ```
 
-The engine handles view layout (strip/zone model), scale selection, feature recognition
-(holes, bosses, bolt circles), annotation placement, and section view generation.
-Annotation primitives (`Dimension`, `Leader`, `lint_drawing`, etc.) live in
-`build123d-drafting-helpers` and can be used independently.
+It owns feature recognition (`recognition/`) and linting (`linting/`); annotation
+primitives (`Dimension`, `Leader`, etc.) live in `build123d-drafting-helpers` and can
+be used independently. The compiler is largely converged in production — turned
+dims/lengths, centre marks, envelope, slots, holes (callouts/locations/grouping),
+the section A–A trigger, the prismatic step-ladder + rotational furniture, and PMI/GD&T
+are all on the IR — the migration is complete (one path; the orchestrator is
+build → plan → render). See
+[`docs/target-architecture.md`](docs/target-architecture.md) and
+[`docs/adr/`](docs/adr/). The engine handles view layout (strip/zone model), scale
+selection, annotation placement, and section rendering.

{draftwright-0.1.12 → draftwright-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "draftwright"
-version = "0.1.12"
+version = "0.2.0"
 description = "Automated technical-drawing generation for build123d"
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -12,9 +12,12 @@ authors = [{ name = "Paul Fremantle", email = "pzfreo@gmail.com" }]
 requires-python = ">=3.10,<3.15"
 dependencies = [
     "build123d>=0.9.0",
-    "build123d-drafting-helpers>=0.12.0",
+    "build123d-drafting-helpers>=0.13.0",
     "kiwisolver>=1.4,<2",
     "numpy>=1.24",
+    "reportlab>=4.0",
+    "svglib>=1.5",
+    "typer>=0.12",
 ]
 keywords = ["build123d", "cad", "drafting", "engineering-drawing", "technical-drawing", "automation"]
 classifiers = [
@@ -29,11 +32,8 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
 ]
 
-[project.optional-dependencies]
-pdf = ["cairosvg>=2.7"]
-
 [project.scripts]
-draftwright = "draftwright.make_drawing:_cli"
+draftwright = "draftwright.cli:app"
 
 [project.urls]
 Homepage = "https://github.com/pzfreo/draftwright"
@@ -59,10 +59,17 @@ include = [
 testpaths = ["tests"]
 timeout = 300
 # `slow` covers the heavy end-to-end builds over the large NIST CTC fixtures
-# (minutes each). They are deselected by default for a fast normal run; run the
-# full suite with `-m ""` or just the slow tier with `-m slow` (CI runs both).
-markers = ["slow: heavy end-to-end CTC fixture builds (deselected by default)"]
-addopts = "--tb=short --cov=src/draftwright --cov-report=term-missing --cov-report=xml -m 'not slow'"
+# (minutes each), deselected by default. `smoke` is a curated, build-light subset
+# (~30 s) for a quick local "did I break something obvious" check — run it with
+# `uv run pytest -m smoke`. The default run is the full fast tier (`-m 'not slow'`,
+# ~8 min); CI owns that plus the slow tier across the OS/Python matrix.
+markers = [
+    "slow: heavy end-to-end CTC fixture builds (deselected by default)",
+    "smoke: curated build-light subset for a fast local check (~30 s)",
+]
+# Coverage is a CI concern (it adds ~13% locally and instruments every line); the
+# CI workflow passes the --cov flags explicitly. Keep the local default lean.
+addopts = "--tb=short -m 'not slow'"
 
 [tool.coverage.run]
 source = ["src/draftwright"]
@@ -79,6 +86,14 @@ python_version = "3.10"
 ignore_missing_imports = true
 check_untyped_defs = true
 warn_unused_ignores = true
+# Tightened on the settled module contracts (#138 / ADR 0005 P7). disallow_untyped_defs
+# stays off (geometry helpers lean on untyped build123d returns); these flags catch
+# real gaps without demanding annotations everywhere.
+no_implicit_optional = true
+warn_redundant_casts = true
+strict_equality = true
+warn_return_any = true
+extra_checks = true
 
 [tool.ruff]
 line-length = 99
@@ -94,5 +109,6 @@ dev = [
     "pytest>=8",
     "pytest-cov>=5",
     "pytest-timeout>=2",
+    "pytest-xdist>=3",
     "ruff>=0.4",
 ]

draftwright-0.2.0/src/draftwright/__init__.py

@@ -0,0 +1,62 @@
+"""draftwright — automated technical-drawing generation for build123d.
+
+Takes a build123d solid and produces a fully-annotated multi-view technical
+drawing (orthographic views, dimensions, section A–A, title block) ready for
+DXF/SVG export::
+
+    from draftwright import make_drawing
+    make_drawing(my_part, out="drawing")
+
+Requires build123d-drafting-helpers for annotation primitives.
+Licensed under the GNU Affero General Public License v3 (AGPL-3.0).
+"""
+
+import sys as _sys
+import types as _types
+
+from draftwright.analysis import analyse_face_levels, dedup_diams
+from draftwright.builder import (
+    build_drawing,
+    generate_script,
+    make_drawing,
+)
+from draftwright.drawing import Drawing, FeatureInfo
+from draftwright.export import fix_svg_page_size
+from draftwright.linting import lint_feature_coverage
+from draftwright.pmi import PmiRecord, extract_pmi
+from draftwright.sheet import choose_scale
+
+_make_drawing_function = make_drawing
+
+
+class _DraftwrightModule(_types.ModuleType):
+    def __getattribute__(self, name):
+        if name == "make_drawing":
+            namespace = _types.ModuleType.__getattribute__(self, "__dict__")
+            value = namespace.get(name)
+            if (
+                isinstance(value, _types.ModuleType)
+                and value.__name__ == "draftwright.make_drawing"
+            ):
+                public = namespace["_make_drawing_function"]
+                _types.ModuleType.__setattr__(self, name, public)
+                return public
+        return _types.ModuleType.__getattribute__(self, name)
+
+
+_sys.modules[__name__].__class__ = _DraftwrightModule
+
+__all__ = [
+    "Drawing",
+    "FeatureInfo",
+    "PmiRecord",
+    "analyse_face_levels",
+    "build_drawing",
+    "choose_scale",
+    "dedup_diams",
+    "extract_pmi",
+    "fix_svg_page_size",
+    "generate_script",
+    "lint_feature_coverage",
+    "make_drawing",
+]