A python CAD programming library
Find a file
jdegenstein 338e0bc0bf
Merge pull request #869 from jdegenstein/opt_deps
pyproject.toml -> add optional dependencies [ocp_vscode] [development] [docs] [all]
2025-01-15 10:38:22 -06:00
.github mypy.yml -> mypy with py310 and py313 (dropping py312) 2025-01-13 11:56:39 -06:00
docs add missing [docs] dependencies, pin sphinx to a new version, point readthedocs to a .[docs] installation 2025-01-14 13:02:09 -06:00
examples tea_cup_algebra.py -> update to use location_at (^) too 2024-10-22 16:16:34 -05:00
src/build123d Improve Edge.intersect & coverage 2025-01-15 10:06:39 -05:00
tests Improve Edge.intersect & coverage 2025-01-15 10:06:39 -05:00
tools Order functions, methods and properties in a class by Python's conventional order 2025-01-04 15:46:21 -05:00
.gitignore Speed up test_pack.py by fuse()ing once per test case. 2023-11-15 11:03:21 -08:00
.pylintrc Disable linting on imported modules 2025-01-07 14:26:56 -05:00
.readthedocs.yaml add missing [docs] dependencies, pin sphinx to a new version, point readthedocs to a .[docs] installation 2025-01-14 13:02:09 -06:00
CONTRIBUTING.md CONTRIBUTING.md -> standardize on black formatter 2024-02-22 10:33:39 -06:00
LICENSE Adding LICENSE file 2023-08-20 14:43:46 -04:00
MANIFEST.in scm_versioning MANIFEST.in and pyproject.toml 2023-02-21 21:00:25 -06:00
mypy.ini Fixed typing problems 2025-01-13 14:48:01 -05:00
partcad.yaml Updated partcad.yaml to make the examples work in the latest PartCAD 2024-09-20 22:19:34 -07:00
pyproject.toml add missing [docs] dependencies, pin sphinx to a new version, point readthedocs to a .[docs] installation 2025-01-14 13:02:09 -06:00
README.md Fixed typo 2025-01-14 10:18:47 -05:00

build123d logo

Documentation Status tests pylint mypy codecov

Python Versions Code style: black License

PyPI version Downloads Downloads/month PyPI - Wheel

Build123d is a python-based, parametric, boundary representation (BREP) modeling framework for 2D and 3D CAD. It's built on the Open Cascade geometric kernel and allows for the creation of complex models using a simple and intuitive python syntax. Build123d can be used to create models for 3D printing, CNC machining, laser cutting, and other manufacturing processes. Models can be exported to a wide variety of popular CAD tools such as FreeCAD and SolidWorks.

Build123d could be considered as an evolution of CadQuery where the somewhat restrictive Fluent API (method chaining) is replaced with stateful context managers - e.g. with blocks - thus enabling the full python toolbox: for loops, references to objects, object sorting and filtering, etc.

The documentation for build123d can found at readthedocs.

There is a Discord server (shared with CadQuery) where you can ask for help in the build123d channel.

The recommended method for most users is to install build123d is:

pip install build123d

To get the latest non-released version of build123d one can install from GitHub using one of the following two commands:

In Linux/MacOS, use the following command:

python3 -m pip install git+https://github.com/gumyr/build123d

In Windows, use the following command:

python -m pip install git+https://github.com/gumyr/build123d

If you receive errors about conflicting dependencies, you can retry the installation after having upgraded pip to the latest version with the following command:

python3 -m pip install --upgrade pip

Development install

git clone https://github.com/gumyr/build123d.git
cd build123d
python3 -m pip install -e .

Further installation instructions are available (e.g. Poetry) see the installation section on readthedocs.