Skip to main content

Automated technical-drawing generation for build123d

Project description

draftwright

CI PyPI Python License: AGPL v3 Ruff

Automated technical-drawing generation for build123d. Point it at a solid (or a STEP file) and get a fully-annotated multi-view engineering drawing — orthographic views, dimensions, section A–A, ISO hatching, title block — ready to export as PDF, SVG, and DXF.

Example engineering drawing generated by draftwright

A mounting plate, generated automatically: three dimensioned orthographic views, a counterbored bore callout (⌀18 THRU ⊔ ⌀30 ↓14), a 4× ⌀8 THRU hole-pattern callout, Section A–A with ISO hatching, an isometric, and an ISO 7200 title block — every annotation placed by the engine.

Quick start

pip install draftwright

Command line

Point it at a STEP file — that's the whole workflow:

draftwright my_part.step --title "Mounting Plate" --number DWG-001
# writes my_part.pdf (the default)

Choose formats, scale, and page; or emit an editable drawing script:

draftwright my_part.step --format pdf,dxf     # also: svg, all
draftwright my_part.step --scale 2 --page A3  # override the auto scale / page
draftwright my_part.step --script             # write an editable declarative Sheet script

draftwright --help lists every flag; --version prints the version.

Python

One call turns a build123d solid (or a STEP file) into a drawing. This is the exact part in the image above:

from build123d import Box, Cylinder, Pos
from draftwright import make_drawing

part = (
    Box(100, 70, 24)
    - Pos(0, 0, 0) * Cylinder(9, 40)     # central bore, counterbored below
    - Pos(0, 0, 8) * Cylinder(15, 20)    # counterbore → triggers Section A–A
    - Pos(-38, 24, 0) * Cylinder(4, 40)  # 4× corner holes (recognised as a pattern)
    - Pos(38, 24, 0) * Cylinder(4, 40)
    - Pos(-38, -24, 0) * Cylinder(4, 40)
    - Pos(38, -24, 0) * Cylinder(4, 40)
)
make_drawing(part, out="my_part", title="Mounting Plate", number="DWG-001")
# writes my_part.svg and my_part.dxf   (or from a STEP file: make_drawing(step_file="p.step", out="my_part"))

For inspection and editing, get a composable Drawing:

from draftwright import build_drawing

dwg = build_drawing(part, title="Mounting Plate")
issues = dwg.lint()                       # list[LintIssue] — coverage, page bounds, ISO
svg_path, dxf_path = dwg.export("my_part")

Declarative drawings — reference features, declare intent

Instead of relying on detection, reference the build123d objects you built and declare only the drawing intent — geometry supplies the sizes (⌀ read off the object), you supply tolerances, fits, datums, GD&T, and surface finish. The fluent Sheet skips detection and dimensions exactly what you declare (ADR 0011):

from build123d import Box, Cylinder, Pos
from draftwright import Sheet

plate = Box(120, 80, 20)
bore = Pos(0, 0, 0) * Cylinder(4, 20)

sheet = Sheet(plate - bore, title="Plate", number="DWG-002")
sheet.envelope()
sheet.datum("A", plate.faces().sort_by()[-1])             # datum A on the top face
hole = sheet.hole(bore).finish("1.6")                     # ⌀8 bore, Ra 1.6
sheet.control(hole).position(0.1, to="A", diameter=True)  # ⌀0.1 position wrt A
sheet.export("plate")                                     # writes plate.svg + plate.dxf

Every aspect the geometry can't carry is a declared verb: .tolerance(±) / .fit("H7") (ISO 286), .finish("Ra") (ISO 1302), sheet.datum(letter, ref) (ISO 5459), and sheet.control(ref) with all 14 ISO 1101 characteristics (.position/.flatness/.perpendicularity/.circular_runout/…). A feature verb returns a chainable handle (sheet.hole(bore)) that the aspect and control(...) verbs decorate; targets are placed automatically — the view and strip are derived from the referenced feature or face, with view=/side= overrides.

What it produces

  • Three orthographic views (front, plan, side) sized and scaled automatically to the page
  • Dimensions on every principal envelope face, plus bore callouts (diameter, depth, counterbore, spotface) on all holes, and ø leader-callouts for the external stepped diameters of turned parts
  • Section A–A with ISO 128-44 solid filled cutting-plane arrows and ISO 128-50 45° hatching on the cut face, triggered automatically when blind or stepped holes would otherwise be hidden-line-only
  • Title block (ISO 7200) with part name, drawing number, scale, tolerance, and date
  • LintDrawing.lint() checks annotation coverage, page bounds, and ISO compliance and returns structured LintIssue objects

All output is real build123d geometry, so PDF, SVG, and DXF all come from the same source and dimensions are live on the DXF layer.

Requires Python ≥ 3.10 and build123d ≥ 0.9.0. Annotation primitives are provided by build123d-drafting-helpers, installed automatically as a dependency.

Going further

Scale and page control

from draftwright import choose_scale

# Auto-select the best ISO/ASME standard scale for an A3 sheet
scale, page_w, page_h, n_steps = choose_scale(80, 60, 20, page="A3")

# Override
make_drawing(part, out="drawing", scale=2.0, page="A2")

Edit, critique, and self-repair

Edit a Drawing in domain vocabulary — the engine places annotations automatically, so you say what to dimension, not where:

dwg = build_drawing(part)

# Inspect detected features and add a dimension in domain terms (auto-placed):
for f in dwg.features("plan"):
    dwg.place_dim(f.page_pos, (f.page_pos[0] + f.diameter, f.page_pos[1]),
                  "below", "plan", dwg.draft, name="dim_pocket")

crit = dwg.lint_summary()   # {"passed", "score", "by_code", "issues":[…suggestion]}
dwg.repair()                # auto-fix mechanically-fixable lint; never worsens

Each LintIssue carries a domain-meaningful code and, when computable, a ready-to-apply suggestion. See docs/adr/ for the design (deterministic generation, the lint→repair loop, and the constraint-based layout engine).

Architecture

draftwright is structured as a part-drawing compiler (ADR 0008): feature detectors → a PartModel IR (Features exposing DimParameters) → a dimensioning planner → renderers, feeding a shared layout/projection/export stack. It builds on two libraries:

draftwright
    └── build123d-drafting-helpers  — Dimension, Leader, HoleCallout, …
    └── build123d                   — CAD kernel

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 and docs/adr/. The engine handles view layout (strip/zone model), scale selection, annotation placement, and section rendering.

The codebase has been entirely written by LLM (Claude Code) under detailed guidance from a person.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

draftwright-0.2.9.tar.gz (2.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

draftwright-0.2.9-py3-none-any.whl (419.6 kB view details)

Uploaded Python 3

File details

Details for the file draftwright-0.2.9.tar.gz.

File metadata

  • Download URL: draftwright-0.2.9.tar.gz
  • Upload date:
  • Size: 2.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for draftwright-0.2.9.tar.gz
Algorithm Hash digest
SHA256 813963fc15500fd0ebb1b9db07d861f667651d1292b2d75899bfed30eefc2d6b
MD5 29b4f39c9e49c4b549d1eb7bf388d6d7
BLAKE2b-256 49138adc43e220f857b3b220788e48bfa07c82d4d6ac6407b16bb571a9003d95

See more details on using hashes here.

Provenance

The following attestation bundles were made for draftwright-0.2.9.tar.gz:

Publisher: publish.yml on pzfreo/draftwright

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file draftwright-0.2.9-py3-none-any.whl.

File metadata

  • Download URL: draftwright-0.2.9-py3-none-any.whl
  • Upload date:
  • Size: 419.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for draftwright-0.2.9-py3-none-any.whl
Algorithm Hash digest
SHA256 30efe96b9c9347d3d29111c2d243bc0eba40989f6b04a7114a3351b405cdd664
MD5 125f225c1bcf834ce7b9bfd9a98c75c5
BLAKE2b-256 4ddb94fe0e4a2c9948b6ff8858f15549c3d76f84bff13c868ed2d66ef44faca3

See more details on using hashes here.

Provenance

The following attestation bundles were made for draftwright-0.2.9-py3-none-any.whl:

Publisher: publish.yml on pzfreo/draftwright

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page