woodwright 0.1.0__tar.gz

woodwright-0.1.0/.gitignore

@@ -0,0 +1,75 @@
+### macOS
+# Finder metadata
+.DS_Store
+
+# Thumbnails
+._*
+
+# Custom folder icons
+Icon
+
+
+# Volume root files
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+### JetBrains
+# JetBrains IDE directory
+.idea/
+
+# CMake build directories
+cmake-build-*/
+
+# File-based project format
+*.iws
+*.iml
+
+# IntelliJ build output
+out/
+
+### Python
+# Byte-compiled files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+build/
+dist/
+*.egg-info/
+*.egg
+
+# dotenv environment variable files
+.env
+
+# Virtual environments
+.venv
+env/
+venv/
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.pytest_cache/
+
+# Type checkers
+.mypy_cache/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+# .python-version
+
+output/

woodwright-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Bohumír Zámečník
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

woodwright-0.1.0/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.5
+Name: woodwright
+Version: 0.1.0
+Summary: A semantic CAD library for woodworking.
+Project-URL: Homepage, https://github.com/bzamecnik/woodwright
+Project-URL: Source, https://github.com/bzamecnik/woodwright
+Project-URL: Issues, https://github.com/bzamecnik/woodwright/issues
+Project-URL: Documentation, https://github.com/bzamecnik/woodwright/tree/HEAD/docs
+Author-email: Bohumir Zamecnik <bohumir.zamecnik@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: build123d,cad,cut list,furniture,joinery,woodworking
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Manufacturing
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Multimedia :: Graphics :: 3D Modeling
+Classifier: Topic :: Scientific/Engineering
+Classifier: Typing :: Typed
+Requires-Python: >=3.14
+Requires-Dist: build123d>=0.13.0
+Description-Content-Type: text/markdown
+
+# woodwright
+
+A semantic CAD library for woodworking. You describe furniture the way a
+woodworker thinks about it: boards with named sides, and the joints between
+them. woodwright works out the joinery, the cut sizes and where every part
+goes, and produces 3D models (STEP, STL), drawings (SVG) and cut lists.
+
+It is built on [build123d](https://github.com/gumyr/build123d). This is an
+early alpha: the API will still change.
+
+## Installation
+
+```shell
+pip install woodwright  # or: uv add woodwright
+```
+
+Requires Python 3.14. Source: <https://github.com/bzamecnik/woodwright>
+
+## Quickstart
+
+A rail tenoned into a stile. You give the design dimensions and the joint;
+the tenon, the mortise, the rail's cut length and its placement are derived.
+
+```python
+from pathlib import Path
+
+import woodwright as ww
+from woodwright.export import export_model
+
+oak = ww.Stock.board(thickness=20, species="oak")
+
+frame = ww.Assembly("corner", root_location=ww.orient(right_end=ww.UP, back_edge=ww.RIGHT))
+stile = frame.add(ww.Board("stile", oak, length=600, width=60))
+rail = frame.add(ww.Board("rail", oak, length=300, width=60))  # shoulder to shoulder
+frame.join(ww.MortiseTenon(tenon=rail.left_end, mortise=stile.back_edge))
+
+model = frame.resolve()
+print(model.cut_list())
+export_model(model, Path("output/corner"))  # STEP, STL, SVG views, cut list
+```
+
+```text
+stile  600 x 60 x 20 mm  oak
+       - mortise 50 x 8 mm, 42 deep, in stile.back_edge
+rail   340 x 60 x 20 mm  oak
+       - tenon 50 x 8 mm, 40 long, on rail.left_end
+```
+
+Cuts and joints so far: grooves, dados, rabbets, mortises, tenons (haunched,
+mitred), chamfers, mitres, tapers; butt, dado, rabbet, groove, tongue and
+groove, mortise and tenon, bridle, half lap, cross lap, mitre corners and
+splices, sliding, through and half-blind dovetails, and table-top buttons.
+
+## Example library
+
+`woodwright.examples` holds over fifty examples, from single cuts through
+joints to projects: a try square, a mallet, a bookshelf, a dovetailed drawer
+with a bottom, a dining table.
+
+```shell
+python -m woodwright.examples list
+python -m woodwright.examples export projects.table --out output
+```
+
+The design ideas are in [docs/vision.md](https://github.com/bzamecnik/woodwright/blob/HEAD/docs/vision.md)
+and [docs/plan.md](https://github.com/bzamecnik/woodwright/blob/HEAD/docs/plan.md).
+
+## Development
+
+Install the environment and dependencies:
+```shell
+uv sync
+pre-commit install  # ruff lint + format on commit
+```
+
+Optionally, for notebooks with an interactive 3D viewer:
+```shell
+uv sync --group notebook
+uv run jupyter lab
+```
+
+Run the tests and the linters:
+```shell
+uv run pytest
+uv run ruff format
+uv run ruff check --fix
+```
+
+## License
+
+[MIT License](./LICENSE).
+
+### Credits
+
+- Ideas and guidance: Bohumír Zámečník
+- Most of the implementation: Claude Code (Opus 5.5)

woodwright-0.1.0/README.md

@@ -0,0 +1,96 @@
+# woodwright
+
+A semantic CAD library for woodworking. You describe furniture the way a
+woodworker thinks about it: boards with named sides, and the joints between
+them. woodwright works out the joinery, the cut sizes and where every part
+goes, and produces 3D models (STEP, STL), drawings (SVG) and cut lists.
+
+It is built on [build123d](https://github.com/gumyr/build123d). This is an
+early alpha: the API will still change.
+
+## Installation
+
+```shell
+pip install woodwright  # or: uv add woodwright
+```
+
+Requires Python 3.14. Source: <https://github.com/bzamecnik/woodwright>
+
+## Quickstart
+
+A rail tenoned into a stile. You give the design dimensions and the joint;
+the tenon, the mortise, the rail's cut length and its placement are derived.
+
+```python
+from pathlib import Path
+
+import woodwright as ww
+from woodwright.export import export_model
+
+oak = ww.Stock.board(thickness=20, species="oak")
+
+frame = ww.Assembly("corner", root_location=ww.orient(right_end=ww.UP, back_edge=ww.RIGHT))
+stile = frame.add(ww.Board("stile", oak, length=600, width=60))
+rail = frame.add(ww.Board("rail", oak, length=300, width=60))  # shoulder to shoulder
+frame.join(ww.MortiseTenon(tenon=rail.left_end, mortise=stile.back_edge))
+
+model = frame.resolve()
+print(model.cut_list())
+export_model(model, Path("output/corner"))  # STEP, STL, SVG views, cut list
+```
+
+```text
+stile  600 x 60 x 20 mm  oak
+       - mortise 50 x 8 mm, 42 deep, in stile.back_edge
+rail   340 x 60 x 20 mm  oak
+       - tenon 50 x 8 mm, 40 long, on rail.left_end
+```
+
+Cuts and joints so far: grooves, dados, rabbets, mortises, tenons (haunched,
+mitred), chamfers, mitres, tapers; butt, dado, rabbet, groove, tongue and
+groove, mortise and tenon, bridle, half lap, cross lap, mitre corners and
+splices, sliding, through and half-blind dovetails, and table-top buttons.
+
+## Example library
+
+`woodwright.examples` holds over fifty examples, from single cuts through
+joints to projects: a try square, a mallet, a bookshelf, a dovetailed drawer
+with a bottom, a dining table.
+
+```shell
+python -m woodwright.examples list
+python -m woodwright.examples export projects.table --out output
+```
+
+The design ideas are in [docs/vision.md](https://github.com/bzamecnik/woodwright/blob/HEAD/docs/vision.md)
+and [docs/plan.md](https://github.com/bzamecnik/woodwright/blob/HEAD/docs/plan.md).
+
+## Development
+
+Install the environment and dependencies:
+```shell
+uv sync
+pre-commit install  # ruff lint + format on commit
+```
+
+Optionally, for notebooks with an interactive 3D viewer:
+```shell
+uv sync --group notebook
+uv run jupyter lab
+```
+
+Run the tests and the linters:
+```shell
+uv run pytest
+uv run ruff format
+uv run ruff check --fix
+```
+
+## License
+
+[MIT License](./LICENSE).
+
+### Credits
+
+- Ideas and guidance: Bohumír Zámečník
+- Most of the implementation: Claude Code (Opus 5.5)

woodwright-0.1.0/docs/initial_vision.md

@@ -0,0 +1,19 @@
+# Initial vision
+
+Let's design a textual markup language to describe furniture design and construction. For a programmer and hobby woodworker it feels limiting that description of furniture to be designed or documented is purely visual - 2D sketches on paper or possibly 3D CAD models which take a lot work to make in specialized software. It makes it unsuitable to discuss with LLMs, to parametrize, easily work with programmatically, construct, modify or convert into other representations (2D plans, 3D models, images).
+
+Furniture is typically composed of pieces which are first shaped from rough lumber to given size and shape, including joints, and then assembled together and surface-finished. Thus, it could be represented as a graph where the pieces are vertices and their joints are edges. Also the shaping process can be expressed this way: individual stages can be vertices, while the shaping operations (cutting, drilling, etc.) can be expressed as edges or a different kind of vertices connected by edges. Similarly for gluing, fastening with screws, nails, finishing, etc. The various vertices or edges can have properties, such as a kind of material, sizes, etc.
+
+A crucial aspect is representing shapes. One possible paradigm could be constructive solid geometry (CSG), nicely represented e.g. by OpenSCAD, where shapes can be constructed using text-based representation language. Maybe that is too general for furniture. I guess there can be some standard library where common shapes (in a parametric form) can be represented and then applied in a composable way. For example, there can be a primitive "board" as a cuboid with 3 dimensions (length, width, thickness). It may be possible to apply operations, such as cutting through or partially in some way. Those could be combined to make a shape of a mortice or tenon. Those can be then applied on a board to make e.g. an apron for a table or with different parameter a stretcher. Typically multiple copies of the same shape (maybe with different parameters) may be needed. Then they can be assembled by orienting the pieces and connecting their joints.
+
+A construction and assembly process could then be expressed by a graph of shaping and joining those primitive objects.
+
+3D modeling software often allows using geometric constraints so that some properties of the shapes can be enforced and some dimensions can be calculated automatically, while others are fixed.
+
+The language could be an application of an existing markup language, so that any infrastructure for it can be reused. It should be nicely readable and writable by human. YAML or something similar might be a nice basis. 
+
+One of the open questions is a coordinate system. Either we can rely one some local cartesian coordinates or try a coordinate-free approach with Geometric Algebra but still keep it approachable for casual users.
+
+This opens up door for more advances possibilities, such as static load analysis for safety and material optimization.
+
+The original idea comes from 2025-12-11.