bdbox 0.5.1

Parametric configuration and tooling for build123d models.

bdbox

A live development environment for build123d models.

See the documentation site for full project details!

Installation

pip install bdbox

Works with any build123d model

Use bdbox with build123d models:

# mybox.py
from build123d import Box

result = Box(10, 10, 10)

Export to STEP or STL with bdbox:

bdbox mybox.py export out.step  # Export to STEP
bdbox mybox.py export out.stl   # Export to STL

View your model in your browser with OCP CAD Viewer, started automatically. bdbox automatically re-renders your model on save:

bdbox mybox.py view

See more about actions in the documentation!

Add parameters for interactive customization

Opt in to parametric customization by importing from bdbox. Declare typed parameters with defaults, then override them individually or with named presets:

from bdbox import Float, Int, Params, Preset, show
from build123d import Box

class P(Params):
    width = Float(10.0, min=5, max=100)
    length = Float(20.0, min=5, max=100)
    thickness = Int(2, min=1, max=10)
    presets = (
        Preset("small", width=5.0, length=8.0),
        Preset("large", width=80.0, length=40.0, thickness=5),
    )

result = Box(P.width, P.length, P.thickness)
show(result)

Or inherit from the provided base class for reusable, importable models:

from bdbox import Float, Int, Model, Preset
from build123d import Box

class MyBox(Model):
    width = Float(10.0, min=5, max=100)
    length = Float(20.0, min=5, max=100)
    thickness = Int(2, min=1, max=10)
    presets = (
        Preset("small", width=5.0, length=8.0),
        Preset("large", width=80.0, length=40.0, thickness=5),
    )

    def build(self):
        return Box(self.width, self.length, self.thickness)

Parameters become CLI flags automatically:

python mybox.py                 # Run with default values
python mybox.py view            # View with live reload
python mybox.py --width 50      # Override a field value
python mybox.py --preset large  # Apply a named preset
python mybox.py --help          # Usage info with all parameters

Export geometry to STEP or STL files using the built-in export action:

python mybox.py export output.step  # Export to STEP
python mybox.py export output.stl   # Export to STL

See more about parameters in the documentation!

Project template

This project is generated and maintained with copier-python.