mirrors/build123d
1
Fork 0
mirror of https://github.com/gumyr/build123d.git synced 2025-12-05 18:20:46 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions
A python CAD programming library
1339 commits 8 branches 12 tags 47 MiB
Find a file
Andreas **Felix** Häberle a836505173 modified example for review example_1.rst 
modified:   examples/benchy.py
	new file:   examples/benchy_v2024.py
	modified:   examples/boxes_on_faces.py
	modified:   examples/boxes_on_faces_algebra.py
	modified:   examples/build123d_customizable_logo.py
	modified:   examples/build123d_customizable_logo_algebra.py
	modified:   examples/build123d_logo_algebra.py
2024-01-21 19:13:44 +01:00
.github disable TestPyPI 2023-11-30 19:57:48 -06:00
docs helper scripts and images 2024-01-21 19:12:10 +01:00
examples modified example for review example_1.rst 2024-01-21 19:13:44 +01:00
src/build123d Added to FAQ 2024-01-20 13:54:30 -05:00
tests Allowing tests to be run from project dir 2024-01-13 11:16:36 -05:00
.gitignore Speed up test_pack.py by fuse()ing once per test case. 2023-11-15 11:03:21 -08:00
.pylintrc Resolve all pylint in {im,ex}porters.py 2023-11-14 19:45:38 -08:00
.readthedocs.yaml Update .readthedocs.yaml to ubuntu-22.04 2023-09-28 11:29:16 -05:00
CONTRIBUTING.md pack(): introduced a new helper for packing parts into a 2D footprint. 2023-11-09 15:06:49 -08: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 mypy static typechecking improvements 2023-02-20 18:35:27 -05:00
pyproject.toml added optional dependencies 2024-01-21 19:10:08 +01:00
README.md Updating docs for pypi installation 2023-12-06 14:43:41 -05:00
requirements.txt Adding coverage badge 2023-02-13 20:41:01 -05:00

README.md

build123d logo

Documentation Status tests pylint codecov

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, Apple Silicon) see the installation section on readthedocs.