b3dkit 0.1.0__tar.gz

b3dkit-0.1.0/.coveragerc

@@ -0,0 +1,6 @@
+[run]
+omit =
+    *test*
+    *conftest*
+[report]
+show_missing = True

b3dkit-0.1.0/.gitignore

@@ -0,0 +1,170 @@
+# any test 3d binaries
+*.stl
+*.step
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+#VS Code Counter
+.VSCodeCounter/
+
+# MacOS desktop files
+**/.DS_Store

b3dkit-0.1.0/.vscode/settings.json

@@ -0,0 +1,17 @@
+{
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "cSpell.words": [
+        "Automatable",
+        "dataclass",
+        "dataclasses",
+        "getcwd",
+        "kwargs",
+        "partomate",
+        "partomatic"
+    ],
+    "python-envs.pythonProjects": []
+}

b3dkit-0.1.0/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2024 Christopher Litsinger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

b3dkit-0.1.0/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.4
+Name: b3dkit
+Version: 0.1.0
+Summary: build123d libraries and utilities
+Project-URL: Homepage, https://github.com/x0pherl/b3dkit
+Project-URL: Issues, https://github.com/x0pherl/b3dkit/issues
+Project-URL: Documentation, https://b3dkit.readthedocs.org
+Author: x0pherl
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Requires-Dist: build123d>=0.0.1
+Requires-Dist: ocp-vscode
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: hatchling; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: markdown-include; extra == 'docs'
+Requires-Dist: mkdocs; extra == 'docs'
+Requires-Dist: mkdocs-material; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# b3dkit Overview
+
+ b3dkit is a general purpose library extending some of [build123d](https://github.com/gumyr/build123d)'s Parts and adding handy utility functions.
+
+It's grown to include some capabilities not required by that project. Useful components include:
+
+- dovetail: Splits a build123d `Part` object into two parts that can easily be slid together with very tight tolerances. Useful when building parts larger than your printer's build volume. This includes a "snugtail" type that is uniquely suited to 3d printing and results in very strong bonds with a high surface area for friction to hold it in place, or glue to bond.
+- click_fit: a tapered profile that allows for better printing & assembly than a simple half Sphere to allow parts to "click" or snap into place when fit together. The extruded shape and the socket are both shaped carefully to allow a mix of easy assembly and good hold.
+- Point: a lightweight X,Y coordinate point object with some geometric functions built into the object.
+- HexWall: builds a field of hexagons with gaps in-between within a given set of bounds.
+
+# Documentation
+
+Complete developer documentation for b3dkit is maintained in the docs folder and on the [b3dkit documentation](https://b3dkit.readthedocs.io) site.
+
+# Fork from fb-lbrary
+
+The b3dkit library began as a library specific to [Fender-Bender](https://github.com/x0pherl/fender-bender): a way to externalize and isolate some common utilities, functions, & methods from the  project. It has since grown to include many parts and utilities that are not used by fender-bender. As part of a major rewrite to adhere method names and usage to feel more like Build123d native usage, we've forked and renamed the project to b3dkit, to better reflect our current purpose.
+
+
+# Modifying the Source
+The included source files rely on the build123d library. I recommend following the build123d installation instructions.
+
+# Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+# License
+This project is licensed under the terms of the [MIT](https://choosealicense.com/licenses/mit/) license

b3dkit-0.1.0/README.md

@@ -0,0 +1,28 @@
+# b3dkit Overview
+
+ b3dkit is a general purpose library extending some of [build123d](https://github.com/gumyr/build123d)'s Parts and adding handy utility functions.
+
+It's grown to include some capabilities not required by that project. Useful components include:
+
+- dovetail: Splits a build123d `Part` object into two parts that can easily be slid together with very tight tolerances. Useful when building parts larger than your printer's build volume. This includes a "snugtail" type that is uniquely suited to 3d printing and results in very strong bonds with a high surface area for friction to hold it in place, or glue to bond.
+- click_fit: a tapered profile that allows for better printing & assembly than a simple half Sphere to allow parts to "click" or snap into place when fit together. The extruded shape and the socket are both shaped carefully to allow a mix of easy assembly and good hold.
+- Point: a lightweight X,Y coordinate point object with some geometric functions built into the object.
+- HexWall: builds a field of hexagons with gaps in-between within a given set of bounds.
+
+# Documentation
+
+Complete developer documentation for b3dkit is maintained in the docs folder and on the [b3dkit documentation](https://b3dkit.readthedocs.io) site.
+
+# Fork from fb-lbrary
+
+The b3dkit library began as a library specific to [Fender-Bender](https://github.com/x0pherl/fender-bender): a way to externalize and isolate some common utilities, functions, & methods from the  project. It has since grown to include many parts and utilities that are not used by fender-bender. As part of a major rewrite to adhere method names and usage to feel more like Build123d native usage, we've forked and renamed the project to b3dkit, to better reflect our current purpose.
+
+
+# Modifying the Source
+The included source files rely on the build123d library. I recommend following the build123d installation instructions.
+
+# Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+# License
+This project is licensed under the terms of the [MIT](https://choosealicense.com/licenses/mit/) license

b3dkit-0.1.0/build.bat

@@ -0,0 +1,44 @@
+@echo off
+setlocal
+
+
+SET PROJECT_NAME=b3dkit
+
+SET /P PYTEST_CHOSEN=Do you want to run pytest --cov ([Y]/N)?
+IF /I "%PYTEST_CHOSEN%" NEQ "N" GOTO TEST
+GOTO BUILD
+
+:TEST
+pytest --cov
+
+SET /P PYTEST_CLEAN=Based on the pytest results, proceed with the build? ([Y]/N)?
+IF /I "%PYTEST_CLEAN%" NEQ "N" GOTO BUILD
+
+GOTO END
+
+:BUILD
+py -m pip uninstall -y %PROJECT_NAME%
+del /F /Q dist\*.*
+
+py -m build
+py -m pip install -e .
+
+:TESTLOCAL
+python -c "exec(\"from b3dkit import dovetail_subpart, click_fit, Point, shifted_midpoint\nprint(shifted_midpoint(Point(0,0), Point(10,10),0))\")"
+
+
+SET /P PYPI_UPLOAD=Based on that simple test, upload to pypi? ([Y]/N)?
+IF /I "%PYPI_UPLOAD%" NEQ "N" GOTO UPLOAD
+
+GOTO END
+
+:UPLOAD
+py -m twine upload dist/*
+py -m pip uninstall -y b3dkit
+py -m pip install b3dkit
+python -c "exec(\"from b3dkit import dovetail_subpart, click_fit, Point, shifted_midpoint\nprint(shifted_midpoint(Point(0,0), Point(10,10),0))\")"
+
+ECHO "REMINDER!!! Commit and push git changes!!!"
+
+:END
+endlocal

b3dkit-0.1.0/build.sh

@@ -0,0 +1,44 @@
+#!/bin/bash
+
+set -e
+
+PROJECT_NAME="b3dkit"
+# Define the test command as a variable
+TEST_CMD="from b3dkit import Divot; print(f'Divot test valid?: {Divot().is_valid}')"
+# Define sleep time for PyPI availability
+PYPI_WAIT_TIME=30
+
+read -p "Do you want to run pytest --cov ([Y]/N)? " PYTEST_CHOSEN
+PYTEST_CHOSEN=${PYTEST_CHOSEN:-Y}
+if [[ "$PYTEST_CHOSEN" =~ ^[Yy]$ ]]; then
+    pytest --cov
+    read -p "Based on the pytest results, proceed with the build? ([Y]/N)? " PYTEST_CLEAN
+    PYTEST_CLEAN=${PYTEST_CLEAN:-Y}
+    if [[ ! "$PYTEST_CLEAN" =~ ^[Yy]$ ]]; then
+        echo "Build aborted."
+        exit 0
+    fi
+fi
+
+# Build process
+pip3 uninstall -y "$PROJECT_NAME" || true
+rm -rf dist/*
+
+python3 -m build
+pip3 install -e .
+
+# # Local testß
+python3 -c "$TEST_CMD"
+
+read -p "Based on that simple test, upload to PyPI? ([Y]/N)? " PYPI_UPLOAD
+PYPI_UPLOAD=${PYPI_UPLOAD:-Y}
+if [[ "$PYPI_UPLOAD" =~ ^[Yy]$ ]]; then
+    python3 -m twine upload dist/*
+    pip3 uninstall -y "$PROJECT_NAME" || true
+    sleep $PYPI_WAIT_TIME
+    pip3 install "$PROJECT_NAME"
+    python3 -c "$TEST_CMD"
+    echo "REMINDER!!! Commit and push git changes!!!"
+else
+    echo "Upload to PyPI skipped."
+fi

b3dkit-0.1.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

b3dkit-0.1.0/docs/antichamfer.md

@@ -0,0 +1,64 @@
+# Anti Chamfer Module Documentation
+
+## Overview
+
+The `antichamfer` module provides functionality to create anti-chamfers. An anti-chamfer extends outward from a face, similar to a foot or flat crown molding, rather than cutting inward like a traditional chamfer. This is useful for creating bases, flanges, or decorative edges that extend beyond the original part geometry.
+
+## Functions
+
+### anti_chamfer
+
+#### arguments
+
+ - length: the depth of the anti-chamfer (how far to offset inward from the original face)
+ - length2: the width of the taper at the bottom (optional, defaults to length if not specified)
+ - face: the face or faces to apply the anti-chamfer to (can be a single Face or an iterable of Faces)
+
+The function creates a tapered extrusion that extends outward from the specified faces. The taper angle is calculated based on the ratio of length2 to length, creating different bevel profiles depending on these values.
+
+## Usage Notes
+
+- When length2 is not specified, the anti-chamfer creates a 45-degree bevel
+- When length2 is smaller than length, the bevel is steeper (more vertical)
+- When length2 is larger than length, the bevel is more gradual (more horizontal)
+- The function automatically handles both single Face objects and collections of faces
+
+## Example
+```python
+from build123d import (
+    Align,
+    Axis,
+    Box,
+    BuildPart,
+    Location,
+    fillet,
+)
+from b3dkit.antichamfer import anti_chamfer
+
+# Create a basic box
+with BuildPart() as base_part:
+    Box(20, 20, 10, align=(Align.CENTER, Align.CENTER, Align.MIN))
+
+# Apply anti-chamfer to the top face with equal length values (45-degree bevel)
+result = anti_chamfer(
+    base_part.faces().filter_by(Axis.Z)[-1],  # top face
+    2.0,  # length
+    2.0,  # length2
+    
+)
+
+# Apply anti-chamfer to multiple faces with different taper
+with BuildPart() as complex_part:
+    Box(30, 15, 8)
+    fillet(complex_part.edges().filter_by(Axis.Z), 1)
+
+# Anti-chamfer on top and bottom faces with steeper taper
+anti_chamfered = anti_chamfer(
+    [
+        complex_part.faces().filter_by(Axis.Z)[-1],  # top
+        complex_part.faces().filter_by(Axis.Z)[0]    # bottom
+    ],
+    1.5,   # length
+    0.8,   # length2 - Creates steeper angle
+)
+```

b3dkit-0.1.0/docs/ball_socket.md

@@ -0,0 +1,79 @@
+# Ball Socket
+
+# Ball Socket Joint System Documentation
+
+## Overview
+
+The ball socket joint components are designed to create flexible connections between 3D printed parts that require multi-axis rotation. This system consists of two complementary components: a ball mount and a ball socket. The ball mount is a ball attached to a shaft, while the ball socket provides a cavity with flexible walls that grip the ball while allowing smooth rotation.
+
+This joint system is particularly useful for creating articulated mechanisms, adjustable brackets, camera mounts, robotic joints, or any application where you need a connection that can rotate freely in multiple directions while maintaining a somewhat secure hold.
+
+The `BallMount` and `BallSocket` classes create matched components with built-in tolerances for 3D printing.
+
+## Classes
+
+### BallMount
+
+Part Object: BallMount
+
+Creates a mounting point for a BallSocket, defined by the radius of the ball.
+
+## Arguments
+
+- `ball_radius` (float): The radius of the spherical ball in millimeters. This determines the overall size of the joint system and must match the ball_radius used for the corresponding ball_socket.
+- `rotation` (RotationLike, optional): angles to rotate about axes. Defaults to (0, 0, 0)
+- `align` (Align | tuple[Align, Align, Align] | None, optional): align MIN, CENTER,
+        or MAX of object. Defaults to (Align.CENTER, Align.CENTER, Align.CENTER)
+- `mode` (Mode, optional): combine mode. Defaults to Mode.ADD
+
+
+### BallSocket
+
+Part Object: BallMount
+
+Creates a ball socket component for a ball-and-socket joint system, defined by the ball radius, wall_thickness, and tolerance.
+
+## Arguments
+
+- `ball_radius` (float): The radius of the spherical ball that will be inserted into this socket, in millimeters. Must match the ball_radius of the corresponding ball_mount for proper fit.
+- `wall_thickness` (float, default=2): The thickness of the socket walls in millimeters. Affects both strength and flexibility. Thicker walls provide more strength but may reduce flexibility. Recommended range: 1.5-3mm.
+- `tolerance` (float, default=0.1): Additional clearance around the ball in millimeters. Positive values create looser fits, negative values create tighter fits. Typical range: 0.05-0.2mm.
+- `rotation` (RotationLike, optional): angles to rotate about axes. Defaults to (0, 0, 0)
+- `align` (Align | tuple[Align, Align, Align] | None, optional): align MIN, CENTER,
+        or MAX of object. Defaults to (Align.CENTER, Align.CENTER, Align.CENTER)
+- `mode` (Mode, optional): combine mode. Defaults to Mode.ADD
+
+
+## Example Usage
+
+```python
+from b3dkit.ball_socket import BallMount, BallSocket
+
+# Create a basic ball joint system with 15mm radius
+mount = BallMount(15.0)
+socket = BallSocket(15.0)
+
+# Create a tighter-fitting joint with thicker walls
+precision_mount = BallMount(12.0)
+precision_socket = BallSocket(
+    ball_radius=12.0,
+    wall_thickness=2.5,
+    tolerance=0.05
+)
+
+# Create a looser joint for easy assembly
+loose_mount = BallMount(10.0)
+loose_socket = BallSocket(
+    ball_radius=10.0,
+    wall_thickness=2.0,
+    tolerance=0.15
+)
+
+# For heavy-duty applications
+heavy_duty_mount = BallMount(20.0)
+heavy_duty_socket = BallSocket(
+    ball_radius=20.0,
+    wall_thickness=4.0,
+    tolerance=0.1
+)
+```