{"id":49291448,"url":"https://github.com/smkent/bdbox","last_synced_at":"2026-05-14T07:07:59.452Z","repository":{"id":352362835,"uuid":"1201462877","full_name":"smkent/bdbox","owner":"smkent","description":"A live development environment for build123d models","archived":false,"fork":false,"pushed_at":"2026-05-05T06:40:54.000Z","size":572,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-05T07:31:02.062Z","etag":null,"topics":["3d","3d-models","build123d","cad","python","step","stl"],"latest_commit_sha":null,"homepage":"https://smkent.github.io/bdbox/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smkent.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-04-04T17:58:50.000Z","updated_at":"2026-05-05T05:55:04.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/smkent/bdbox","commit_stats":null,"previous_names":["smkent/bdbox"],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/smkent/bdbox","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smkent%2Fbdbox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smkent%2Fbdbox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smkent%2Fbdbox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smkent%2Fbdbox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smkent","download_url":"https://codeload.github.com/smkent/bdbox/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smkent%2Fbdbox/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33014237,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-13T13:14:54.681Z","status":"online","status_checked_at":"2026-05-14T02:00:06.663Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["3d","3d-models","build123d","cad","python","step","stl"],"created_at":"2026-04-26T00:30:27.175Z","updated_at":"2026-05-14T07:07:59.443Z","avatar_url":"https://github.com/smkent.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# bdbox\n\n**[build123d][build123d]** development with live preview and\ninteractive parameters\n\n[![License](https://img.shields.io/github/license/smkent/bdbox)](https://github.com/smkent/bdbox/blob/main/LICENSE)\n[![PyPI](https://img.shields.io/pypi/v/bdbox)](https://pypi.org/project/bdbox/)\n[![Python](https://img.shields.io/pypi/pyversions/bdbox)](https://pypi.org/project/bdbox/)\n[![CI](https://github.com/smkent/bdbox/actions/workflows/ci.yaml/badge.svg)](https://github.com/smkent/bdbox/actions/workflows/ci.yaml)\n[![Coverage](https://codecov.io/gh/smkent/bdbox/branch/main/graph/badge.svg)](https://codecov.io/gh/smkent/bdbox)\n[![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen?logo=renovatebot)](https://renovatebot.com)\n[![GitHub stars](https://img.shields.io/github/stars/smkent/bdbox?style=social)](https://github.com/smkent/bdbox)\n\n![Screenshot][docs-screenshot-ui]\n\n**[See the documentation site for full project details!][docs]**\n\n## Why?\n\nI discovered [build123d][build123d] after modeling with [OpenSCAD][openscad].\nbuild123d has some [great advantages][build123d-vs-openscad] over OpenSCAD:\n\n* Better geometry ([STEP][step] file export) than OpenSCAD's\n  [mesh of vertexes][openscad-csg]\n* Common CAD operations like [**`chamfer`**][build123d-chamfer] and\n  [**`fillet`**][build123d-fillet] are simple\n* [build123d models are Python programs][build123d-pypi], whereas\n  [OpenSCAD uses its own modeling language][openscad-language]\n\nComparatively, build123d's development experience was lacking. OpenSCAD previews\na model on save or hotkey, makes exporting a model render simple, and\n[even provides a GUI for setting toplevel variables][openscad-customizer]!\nI started with some self-made tooling to work around these drawbacks, but having\nto remember how to use and maintain it resulted in me working on models less.\n\nI built **`bdbox`** to be the missing tool I wanted: Let models just define\ntheir geometry plus optional parameters, and let **`bdbox`** handle everything\nelse!\n\n**[See more background info in the documentation!][docs-background]**\n\n## Installation\n\nInstall user-wide with [`uv`][uv-tool] or [`pipx`][pipx] for use across all\nprojects:\n\n```sh\nuv tool install bdbox\n```\n\n```sh\npipx install bdbox\n```\n\nInstall in any environment where `pip` is available:\n\n```sh\npip install bdbox\n```\n\n### Installation in projects\n\nInstall in a project, such as with [`uv`][uv] or [`poetry`][poetry]:\n\n```sh\nuv add bdbox\n```\n\n```sh\npoetry add bdbox\n```\n\n`bdbox` detects and automatically uses virtual environments also containing\n`bdbox`.\n\nThis enables running via `bdbox model.py` instead of `uv run bdbox model.py`,\nfor example.\n\n## Works with any build123d model\n\nUse `bdbox` with any existing build123d script:\n\n```python\n# mymodel.py\nfrom build123d import Box\n\nresult = Box(10, 10, 10)\n```\n\nExport geometry files:\n\n```sh\nbdbox mymodel.py export           # Export STEP files to current directory\nbdbox mymodel.py export output/   # Export STEP files to output/\nbdbox mymodel.py export -f stl    # Export STL files to current directory\n```\n\nView your model using the web UI, which includes [OCP CAD Viewer][ocp_vscode]\nand an [interactive parameters panel][docs-panel]:\n\n```sh\nbdbox mymodel.py view\n```\n\nModule paths work too:\n\n```sh\nbdbox mypackage.mymodule view\nbdbox mypackage.mymodule export\n```\n\n**[See more about actions in the documentation!][docs-actions]**\n\n## Add parameters\n\nDeclare typed parameters with defaults and constraints:\n\n```python\nfrom bdbox import Float, Int, Params, Preset, show\nfrom build123d import Box\n\nclass P(Params):\n    width = Float(10.0, min=5, max=100)\n    length = Float(20.0, min=5, max=100)\n    thickness = Int(2, min=1, max=10)\n    presets = (\n        Preset(\"small\", width=5.0, length=8.0),\n        Preset(\"large\", width=80.0, length=40.0, thickness=5),\n    )\n\nresult = Box(P.width, P.length, P.thickness)\nshow(result)\n```\n\nOr inherit from `Model` for reusable, importable models:\n\n```python\nfrom bdbox import Float, Int, Model, Preset\nfrom build123d import Box\n\nclass MyModel(Model):\n    width = Float(10.0, min=5, max=100)\n    length = Float(20.0, min=5, max=100)\n    thickness = Int(2, min=1, max=10)\n    presets = (\n        Preset(\"small\", width=5.0, length=8.0),\n        Preset(\"large\", width=80.0, length=40.0, thickness=5),\n    )\n\n    def build(self):\n        return Box(self.width, self.length, self.thickness)\n```\n\nParameters become CLI flags automatically:\n\n```sh\npython mymodel.py                 # Run with default values\npython mymodel.py view            # View with live reload and parameter panel\npython mymodel.py --width 50      # Override a field value\npython mymodel.py --preset large  # Apply a named preset\npython mymodel.py --help          # Usage info with all parameters\n```\n\nExport geometry files using the built-in `export` action:\n\n```sh\npython mymodel.py export          # Export STEP files to current directory\npython mymodel.py export -f stl   # Export STL files to current directory\n```\n\n**[See more about parameters in the documentation!][docs-parameters]**\n\n## Project template\n\nThis project is generated and maintained with [copier-python][copier-python].\n\n[build123d-chamfer]: https://build123d.readthedocs.io/en/stable/direct_api_reference.html#topology.Mixin3D.chamfer\n[build123d-fillet]: https://build123d.readthedocs.io/en/stable/direct_api_reference.html#topology.Mixin3D.fillet\n[build123d-pypi]: https://pypi.org/project/build123d/\n[build123d-vs-openscad]: https://build123d.readthedocs.io/en/stable/OpenSCAD.html\n[build123d]: https://build123d.readthedocs.io\n[copier-python]: https://smkent.github.io/copier-python\n[docs-actions]: https://smkent.github.io/bdbox/actions/\n[docs-background]: https://smkent.github.io/bdbox/background/\n[docs-panel]: https://smkent.github.io/bdbox/parameters/panel/\n[docs-parameters]: https://smkent.github.io/bdbox/parameters/\n[docs-screenshot-ui]: https://smkent.github.io/bdbox/bdbox-ui.png\n[docs]: https://smkent.github.io/bdbox/\n[ocp_vscode]: https://github.com/bernhard-42/vscode-ocp-cad-viewer\n[openscad-csg]: https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/CSG_Modelling\n[openscad-customizer]: https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Customizer\n[openscad-language]: https://en.wikibooks.org/wiki/OpenSCAD_User_Manual#The_OpenSCAD_Language_Reference\n[openscad]: https://openscad.org/\n[pipx]: https://pipx.pypa.io\n[poetry]: https://python-poetry.org/\n[step]: https://en.wikipedia.org/wiki/ISO_10303-21\n[uv-tool]: https://docs.astral.sh/uv/guides/tools/\n[uv]: https://docs.astral.sh/uv/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmkent%2Fbdbox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmkent%2Fbdbox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmkent%2Fbdbox/lists"}