Reference¶

The API, generated from the docstrings in the source. Everything you need for a design is importable from the package itself:

import woodwright as ww

oak = ww.Stock.board(thickness=20, species="oak")
frame = ww.Assembly("corner", root_location=ww.orient(right_end=ww.UP, back_edge=ww.RIGHT))

• Command line: woodwright list and woodwright export.
• Assemblies: Assembly, resolving it into a ResolvedModel, the cut list.
• Parts and stock: Stock, Board, Rod and their named sides.
• Placement: orienting the first part, positions along and across a joint.
• Joints: every joint, from Butt to BlindMitredDovetail.
• Cuts: cuts made by joints, or added to a part yourself.
• Rules: rules of thumb for the dimensions you leave out.
• Export: writing the model, its views, drawings and plans.
• Drawings and plans: shop drawings, sheets, the plans PDF, identical parts.

The examples are in woodwright.examples (see the gallery). woodwright is built on build123d: the shapes it produces are build123d shapes.