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 SVG and DXF.

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

part = Box(80, 60, 20) - Pos(0, 0, 5) * Cylinder(8, 20)
make_drawing(part, out="my_part", title="Mounting Block", number="DWG-001")
# writes my_part.svg and my_part.dxf

Or from the command line:

draftwright my_part.step --title "Mounting Block" --number DWG-001

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 SVG and DXF export come from the same source and dimensions are live on the DXF layer.

Installation

pip install draftwright

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

Usage

From a build123d solid

from draftwright import make_drawing, build_drawing, Drawing

# One-shot: write SVG + DXF
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")

From a STEP file

from draftwright import make_drawing
make_drawing(step_file="part.step", out="drawing")

Or via the CLI:

draftwright part.step --out drawing --scale 2 --page A3
draftwright part.step --script   # write an editable .py drawing script instead

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 a single module (make_drawing.py) on top of two Apache 2.0 libraries:

draftwright  (AGPL-3.0)
    └── build123d-drafting-helpers  (Apache 2.0)  — Dimension, Leader, HoleCallout, …
    └── build123d  (Apache 2.0)                   — 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.

License

draftwright is licensed under the GNU Affero General Public License v3 (AGPL-3.0).

This means:

  • You can use, modify, and distribute it freely in open-source projects
  • If you run draftwright as part of a network service (e.g. an API that generates drawings), you must make your application's source code available to users

For commercial use without these obligations, contact pzfreo@gmail.com.

The annotation primitives in build123d-drafting-helpers are Apache 2.0 and may be embedded in commercial applications without restriction.

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.1.10.tar.gz (1.8 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.1.10-py3-none-any.whl (103.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for draftwright-0.1.10.tar.gz
Algorithm Hash digest
SHA256 b37f5a2ac6eb8af84767481aaec5903f25737acc2d76529f4dfaa28be2d21701
MD5 b73e82696d85237b9eb5650332461653
BLAKE2b-256 cd70ceb98d94da27d949cc8d9094ef9e1fcb562c09ac132dab895dc398febabe

See more details on using hashes here.

Provenance

The following attestation bundles were made for draftwright-0.1.10.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.1.10-py3-none-any.whl.

File metadata

  • Download URL: draftwright-0.1.10-py3-none-any.whl
  • Upload date:
  • Size: 103.4 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.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 b92458e1953a571ac8e680f31a78583dcc98fe2e8e7431798e7a32eb8ffa38fb
MD5 c57ce3e3b4934d1c3917338b8d334364
BLAKE2b-256 92530130e90bc1f19bd3a7fc4cdb0a4c38731e06e3a55d6925d369acb40292a1

See more details on using hashes here.

Provenance

The following attestation bundles were made for draftwright-0.1.10-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