<p align="center">
<img alt="build123d logo" src="docs/assets/build123d_logo/logo-banner.svg">
</p>
[](https://build123d.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/gumyr/build123d/actions/workflows/test.yml)
[](https://github.com/gumyr/build123d/actions/workflows/lint.yml)
[](https://codecov.io/gh/gumyr/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 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.
The documentation for **build123d** can 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.
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](https://build123d.readthedocs.io/en/latest/installation.html).
Raw data
{
"_id": null,
"home_page": "",
"name": "build123d",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "3d models,3d printing,3d,brep,cad,cadquery,opencscade,python",
"author": "",
"author_email": "Roger Maitland <gumyr9@gmail.com>",
"download_url": "",
"platform": null,
"description": "<p align=\"center\">\n <img alt=\"build123d logo\" src=\"docs/assets/build123d_logo/logo-banner.svg\">\n</p>\n\n[](https://build123d.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/gumyr/build123d/actions/workflows/test.yml)\n[](https://github.com/gumyr/build123d/actions/workflows/lint.yml)\n[](https://codecov.io/gh/gumyr/build123d)\n\nBuild123d 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.\n\nBuild123d 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.\n\nThe documentation for **build123d** can found at [readthedocs](https://build123d.readthedocs.io/en/latest/index.html).\n\nThere is a [***Discord***](https://discord.com/invite/Bj9AQPsCfx) server (shared with CadQuery) where you can ask for help in the build123d channel.\n\nThe recommended method for most users is to install **build123d** is:\n```\npip install build123d\n```\n\nTo get the latest non-released version of **build123d*** one can install from GitHub using one of the following two commands:\n\nIn Linux/MacOS, use the following command:\n```\npython3 -m pip install git+https://github.com/gumyr/build123d\n```\nIn Windows, use the following command:\n```\npython -m pip install git+https://github.com/gumyr/build123d\n```\n\nIf you receive errors about conflicting dependencies, you can retry the installation after having upgraded pip to the latest version with the following command:\n```\npython3 -m pip install --upgrade pip\n```\n\nDevelopment install\n```\ngit clone https://github.com/gumyr/build123d.git\ncd build123d\npython3 -m pip install -e .\n```\n\nFurther installation instructions are available (e.g. Poetry, Apple Silicon) see the [installation section on readthedocs](https://build123d.readthedocs.io/en/latest/installation.html).\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A python CAD programming library",
"version": "0.4.0",
"project_urls": {
"Bug Tracker": "https://github.com/gumyr/build123d/issues",
"Documentation": "https://build123d.readthedocs.io/en/latest/index.html",
"Homepage": "https://github.com/gumyr/build123d"
},
"split_keywords": [
"3d models",
"3d printing",
"3d",
"brep",
"cad",
"cadquery",
"opencscade",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "31e7bf5851fbba564ed7aad46d29f771fb208b4581276457d70f58c6704139ed",
"md5": "6e745c72198e1b4b119f3db8fb354450",
"sha256": "1a94089dea2427e09cae9b023c01ac9cb6fd0a61faf015252eb139af4263e180"
},
"downloads": -1,
"filename": "build123d-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6e745c72198e1b4b119f3db8fb354450",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 181299,
"upload_time": "2024-02-19T20:34:04",
"upload_time_iso_8601": "2024-02-19T20:34:04.216700Z",
"url": "https://files.pythonhosted.org/packages/31/e7/bf5851fbba564ed7aad46d29f771fb208b4581276457d70f58c6704139ed/build123d-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-19 20:34:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gumyr",
"github_project": "build123d",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "build123d"
}
JSON
