mirrors/build123d
1
Fork 0
mirror of https://github.com/gumyr/build123d.git synced 2025-12-06 02:30:55 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #882 from hoijui/patch-1

Browse source 
README: Makes reading it a tiny bit smoother
This commit is contained in:
Roger Maitland 2025-01-29 10:09:36 -05:00 • committed by GitHub
commit 79a962561d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 18 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -17,26 +17,30 @@
[![Downloads/month](https://pepy.tech/badge/build123d/month)](https://pepy.tech/project/build123d) [![Downloads/month](https://pepy.tech/badge/build123d/month)](https://pepy.tech/project/build123d)
[![PyPI - Wheel](https://img.shields.io/pypi/wheel/build123d.svg)](https://pypi.org/project/build123d/) [![PyPI - Wheel](https://img.shields.io/pypi/wheel/build123d.svg)](https://pypi.org/project/build123d/)
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 is a python-based, parametric, [boundary representation (BREP)][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](https://cadquery.readthedocs.io/en/latest/index.html) 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. 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](https://build123d.readthedocs.io/en/latest/index.html). The documentation for **build123d** can be found at [readthedocs](https://build123d.readthedocs.io/en/latest/index.html).
There is a [***Discord***](https://discord.com/invite/Bj9AQPsCfx) server (shared with CadQuery) where you can ask for help in the build123d channel. There is a [***Discord***](https://discord.com/invite/Bj9AQPsCfx) server (shared with [CadQuery]) where you can ask for help in the build123d channel.
The recommended method for most users to install **build123d** is:
The recommended method for most users is to install **build123d** is:
``` ```
pip install build123d pip install build123d
``` ```
To get the latest non-released version of **build123d** one can install from GitHub using one of the following two commands: 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: Linux/MacOS:
``` ```
python3 -m pip install git+https://github.com/gumyr/build123d python3 -m pip install git+https://github.com/gumyr/build123d
``` ```
In Windows, use the following command:
Windows:
``` ```
python -m pip install git+https://github.com/gumyr/build123d python -m pip install git+https://github.com/gumyr/build123d
``` ```
@ -46,7 +50,8 @@ If you receive errors about conflicting dependencies, you can retry the installa
python3 -m pip install --upgrade pip python3 -m pip install --upgrade pip
``` ```
Development install Development install:
``` ```
git clone https://github.com/gumyr/build123d.git git clone https://github.com/gumyr/build123d.git
cd build123d cd build123d
@ -54,3 +59,8 @@ python3 -m pip install -e .
``` ```
Further installation instructions are available (e.g. Poetry) see the [installation section on readthedocs](https://build123d.readthedocs.io/en/latest/installation.html). Further installation instructions are available (e.g. Poetry) see the [installation section on readthedocs](https://build123d.readthedocs.io/en/latest/installation.html).
[BREP]: https://en.wikipedia.org/wiki/Boundary_representation
[CadQuery]: https://cadquery.readthedocs.io/en/latest/index.html
[FreeCAD]: https://www.freecad.org/
[Open Cascade]: https://dev.opencascade.org/