b3dkit 0.1.1__tar.gz → 0.1.3__tar.gz

{b3dkit-0.1.1 → b3dkit-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: b3dkit
-Version: 0.1.1
+Version: 0.1.3
 Summary: build123d libraries and utilities
 Project-URL: Homepage, https://github.com/x0pherl/b3dkit
 Project-URL: Issues, https://github.com/x0pherl/b3dkit/issues
@@ -10,21 +10,21 @@ 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
+Requires-Python: >=3.10
+Requires-Dist: build123d>=0.10.0
+Requires-Dist: ocp-vscode>=3.1.1
 Provides-Extra: dev
-Requires-Dist: pytest; extra == 'dev'
-Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest-cov>=7.0.0; extra == 'dev'
+Requires-Dist: pytest>=9.0.2; extra == 'dev'
 Provides-Extra: docs
-Requires-Dist: markdown-include; extra == 'docs'
-Requires-Dist: mkdocs; extra == 'docs'
-Requires-Dist: mkdocs-material; extra == 'docs'
+Requires-Dist: markdown-include>=0.8.1; extra == 'docs'
+Requires-Dist: mkdocs-material>=9.7.6; extra == 'docs'
+Requires-Dist: mkdocs>=1.6.1; extra == 'docs'
 Provides-Extra: maintain
-Requires-Dist: build; extra == 'maintain'
-Requires-Dist: hatch-vcs; extra == 'maintain'
-Requires-Dist: hatchling; extra == 'maintain'
-Requires-Dist: twine; extra == 'maintain'
+Requires-Dist: build>=1.4.0; extra == 'maintain'
+Requires-Dist: hatch-vcs>=0.5.0; extra == 'maintain'
+Requires-Dist: hatchling>=1.29.0; extra == 'maintain'
+Requires-Dist: twine>=6.2.0; extra == 'maintain'
 Description-Content-Type: text/markdown
 
 # b3dkit Overview

{b3dkit-0.1.1 → b3dkit-0.1.3}/docs/basic_shapes.md

@@ -111,18 +111,26 @@ Creates an extruded diamond (4-sided polygon) that behaves like a cylinder. This
 DiamondCylinder(
     radius: float,
     height: float,
-    rotation: tuple = (0, 0, 0),
-    align: tuple = (Align.CENTER, Align.CENTER, Align.CENTER),
-    stretch: tuple = (1, 1, 1)
+    arc_size: float = 360,
+    stretch: tuple = (1, 1, 1),
+    rotation: RotationLike = (0, 0, 0),
+    align: Align | tuple[Align, Align, Align] | None = None,
+    mode: Mode = Mode.ADD,
 )
 ```
 
 **Arguments:**
 - `radius` (float): The radius of the circumscribed circle
 - `height` (float): The height of the extrusion
-- `rotation` (tuple, default=(0, 0, 0)): Rotation angles (X, Y, Z) in degrees
-- `align` (tuple, default=(Align.CENTER, Align.CENTER, Align.CENTER)): Alignment
+- `arc_size` (float, default=360): Angular sweep in degrees for the circular clipping sector used to intersect the base profile
 - `stretch` (tuple, default=(1, 1, 1)): Scaling factors (X, Y, Z)
+- `rotation` (RotationLike, default=(0, 0, 0)): Rotation angles (X, Y, Z) in degrees
+- `align` (Align | tuple[Align, Align, Align] | None, default=None): Alignment along X, Y, Z axes
+- `mode` (Mode, default=Mode.ADD): Boolean combination mode
+
+**Arc Size Behavior:**
+- `arc_size=360` produces the full diamond profile
+- `arc_size<360` clips the XY profile and reduces volume while preserving Z behavior from `height` and `stretch[2]`
 
 **Returns:**
 - `Part`: The diamond cylinder
@@ -165,10 +173,12 @@ Creates an extruded regular polygon that behaves like a cylinder.
 PolygonalCylinder(
     radius: float,
     height: float,
-    sides: int = 6,
-    rotation: tuple = (0, 0, 0),
-    align: tuple = (Align.CENTER, Align.CENTER, Align.CENTER),
-    stretch: tuple = (1, 1, 1)
+    side_count: int = 6,
+    arc_size: float = 360,
+    stretch: tuple = (1, 1, 1),
+    rotation: RotationLike = (0, 0, 0),
+    align: Align | tuple[Align, Align, Align] | None = None,
+    mode: Mode = Mode.ADD,
 )
 ```
 
@@ -176,12 +186,16 @@ PolygonalCylinder(
 **Arguments:**
 - `radius` (float): The radius of the circumscribed circle
 - `height` (float): The height of the extrusion
-- `sides` (int, default=6): Number of sides of the polygon
+- `side_count` (int, default=6): Number of sides of the polygon
+- `arc_size` (float, default=360): Angular sweep in degrees for the circular clipping sector used to intersect the base profile
 - `stretch` (tuple, default=(1, 1, 1)): Scaling factors (X, Y, Z)
-- `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
+- `rotation` (RotationLike, default=(0, 0, 0)): Angles to rotate about axes
+- `align` (Align | tuple[Align, Align, Align] | None, default=None): Align MIN, CENTER, or MAX on each axis
+- `mode` (Mode, default=Mode.ADD): Boolean combination mode
+
+**Arc Size Behavior:**
+- `arc_size=360` keeps the full regular polygonal profile
+- `arc_size<360` clips the XY profile and reduces volume while preserving Z behavior from `height` and `stretch[2]`
 
 
 ### RoundedCylinder

b3dkit-0.1.3/docs/hexwall.md

@@ -0,0 +1,128 @@
+# Hexagonal Patterns
+
+This module provides two part objects for creating hexagonal (honeycomb) patterns:
+
+- [`HexWall`](#hexwall) — a flat box with a hexagonal cutout pattern.
+- [`HexCylindrical`](#hexcylindrical) — a honeycomb of hexagonal holes wrapped around the curved surface of a cone or cylinder.
+
+## HexWall
+
+Part Object: `HexWall`
+
+Create a box with a hexagonal cutout pattern defined by length, width, and height, apothem, and wall thickness. This Part is useful for generating hexagonal patterns in 3D models.
+
+### Arguments
+
+- `length` (float): The length of the hexagonal wall.
+- `width` (float): The width of the hexagonal wall.
+- `height` (float): The height of the hexagonal wall.
+- `apothem` (float): The apothem (distance from the center to the midpoint of a side) of the hexagons.
+- `wall_thickness` (float): The thickness of the walls of the hexagons.
+- `align` (Union[Align, tuple[Align, Align, Align]], default=(Align.CENTER, Align.CENTER, Align.CENTER)): The alignment of the hexagonal wall. Can be a single `Align` value or a tuple of three `Align` values for x, y, and z alignment.
+- `inverse` (bool, default=False): If `True`, creates an inverse hexagonal pattern.
+
+### Returns
+
+- `Part`: The created hexagonal wall part.
+
+### Example
+
+```python
+from b3dkit import HexWall
+from build123d import Align
+
+# Create a hexagonal wall with specified dimensions and properties
+hex_wall = HexWall(
+    length=100,
+    width=100,
+    height=10,
+    apothem=5,
+    wall_thickness=1,
+    align=(Align.CENTER, Align.CENTER, Align.CENTER),
+    inverse=False
+)
+
+# Create an inverse hexagonal wall
+inverse_hex_wall = HexWall(
+    length=100,
+    width=100,
+    height=10,
+    apothem=5,
+    wall_thickness=1,
+    align=(Align.CENTER, Align.CENTER, Align.CENTER),
+    inverse=True
+)
+```
+
+## HexCylindrical
+
+Part Object: `HexCylindrical`
+
+Wraps a honeycomb of hexagonal holes around the curved surface of a `Cone` or `Cylinder`. It builds the hole geometry *only* — a `Part` containing one cutter per hole — so you subtract it from your solid to vent or lighten it.
+
+The holes are laid out row by row: `horizontal_count` holes run around the surface at each height, `vertical_count` rows stack up the slope starting `z_distance` above the base, and alternate rows are offset half a step for the honeycomb stagger. Each hex is projected onto the true surface so it follows the curvature, then thickened into a cutter.
+
+Each row is centered on a fixed meridian, so the pattern stays left/right symmetric as a cone tapers instead of drifting to one side. Rows that would climb past the top edge of the surface are dropped automatically.
+
+### Arguments
+
+- `cylindrical` (Cone | Cylinder): The cone or cylinder to wrap holes around. Assumed upright on the Z axis with its base at the bottom; its circular edges define the radius at each height. A pointed cone (top radius 0) is supported — its apex radius is inferred from the bounding box.
+- `hole_radius` (float): Radius of each hexagonal hole (the `RegularPolygon` radius).
+- `spacing_radius` (float): Hex cell radius controlling spacing; nearest holes are `2 * spacing_radius` apart (matching `HexLocations(radius=...)`).
+- `horizontal_count` (int): Number of holes around the surface in each row.
+- `vertical_count` (int): Number of rows stacked up the slope. Rows that fall off the top edge are skipped, so the actual number of rows may be fewer.
+- `thickness` (float): How far each cutter extends in/out of the surface. Set `thickness >= wall_thickness` to cut clean through a hollow wall.
+- `z_distance` (float): Height of the lowest row of holes, measured up from the bottom of the surface (not an absolute Z coordinate).
+- `rotation` (RotationLike, default=(0, 0, 0)): Angles to rotate about the axes.
+- `align` (Union[None, Align, tuple[Align, Align, Align]], default=None): Align MIN, CENTER, or MAX of the object.
+- `mode` (Mode, default=Mode.ADD): Combine mode used when the object is created inside an active build context.
+
+### Returns
+
+- `Part`: A part whose children are the hole cutters. Subtract it from your solid (e.g. `solid - HexCylindrical(...)`, or pass `mode=Mode.SUBTRACT` inside a build context) to make the holes.
+
+### Raises
+
+- `ValueError`: If `cylindrical` has no circular edge to derive a radius profile from (e.g. a `Box`).
+- `ValueError`: If no holes fit on the surface (e.g. `z_distance` starts at or above the top edge, or the surface is too short for the given spacing).
+
+### Example
+
+```python
+from b3dkit import HexCylindrical
+from build123d import Cone, Cylinder, Align
+
+# Vent a tapering cone with a honeycomb pattern
+cone = Cone(
+    bottom_radius=40,
+    top_radius=20,
+    height=60,
+    align=(Align.CENTER, Align.CENTER, Align.MIN),
+)
+holes = HexCylindrical(
+    cone,
+    hole_radius=2,
+    spacing_radius=4,
+    horizontal_count=16,
+    vertical_count=6,
+    thickness=4,        # >= wall thickness so the holes cut all the way through
+    z_distance=8,       # start the first row 8mm up from the base
+)
+vented_cone = cone - holes
+
+# The same call works on a straight cylinder (constant radius)
+cylinder = Cylinder(
+    radius=30,
+    height=60,
+    align=(Align.CENTER, Align.CENTER, Align.MIN),
+)
+vented_cylinder = cylinder - HexCylindrical(
+    cylinder,
+    hole_radius=2,
+    spacing_radius=4,
+    horizontal_count=20,
+    vertical_count=8,
+    thickness=4,
+    z_distance=6,
+)
+```

{b3dkit-0.1.1 → b3dkit-0.1.3}/pyproject.toml

@@ -1,37 +1,37 @@
 [project]
 name = "b3dkit"
-version = "0.1.1"
+version = "0.1.3"
 authors = [
   { name="x0pherl"},
 ]
 description = "build123d libraries and utilities"
 readme = "README.md"
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 classifiers = [
     "Programming Language :: Python :: 3",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
 ]
 dependencies = [
-  "build123d>=0.0.1",
-  "ocp_vscode",
+  "build123d>=0.10.0",
+  "ocp_vscode>=3.1.1",
 ]
 
 [project.optional-dependencies]
 dev = [
-  "pytest",
-  "pytest-cov",
+  "pytest>=9.0.2",
+  "pytest-cov>=7.0.0",
   ]
 maintain =[
-  "twine",
-  "hatch-vcs",
-  "hatchling",
-  "build",
+  "twine>=6.2.0",
+  "hatch-vcs>=0.5.0",
+  "hatchling>=1.29.0",
+  "build>=1.4.0",
 ]
 docs = [
-  "mkdocs",
-  "mkdocs-material",
-  "markdown-include",
+  "mkdocs>=1.6.1",
+  "mkdocs-material>=9.7.6",
+  "markdown-include>=0.8.1",
 ]
 
 [project.urls]
@@ -40,7 +40,7 @@ Issues = "https://github.com/x0pherl/b3dkit/issues"
 Documentation = "https://b3dkit.readthedocs.org"
 
 [build-system]
-requires = ["hatchling", "hatch-vcs"]
+requires = ["hatchling>=1.29.0", "hatch-vcs>=0.5.0"]
 
 build-backend = "hatchling.build"
 

{b3dkit-0.1.1 → b3dkit-0.1.3}/src/b3dkit/basic_shapes.py

@@ -25,6 +25,7 @@ from build123d import (
     JernArc,
     Line,
     Location,
+    Locations,
     Mode,
     Part,
     Plane,
@@ -127,7 +128,7 @@ def circular_intersection(radius: float, coordinate: float) -> float:
         - coordinate: a coordinate along one axis of the circle (must be a
             positive value less than the radius)
     """
-    if 0 > coordinate > radius:
+    if not (0 <= coordinate <= radius):
         raise ValueError("The x-coordinate cannot be greater than the radius.")
     return sqrt(radius**2 - coordinate**2)
 
@@ -218,6 +219,7 @@ class PolygonalCylinder(BasePartObject):
         radius: float,
         height: float,
         side_count: int = 6,
+        arc_size: float = 360,
         stretch: tuple = (1, 1, 1),
         rotation: RotationLike = (0, 0, 0),
         align: Union[None, Align, tuple[Align, Align, Align]] = None,
@@ -230,6 +232,7 @@ class PolygonalCylinder(BasePartObject):
             - radius: the radius of the cylinder
             - height: the height of the cylinder
             - side_count: the number of sides of the polygonal base (default is 6)
+            - arc_size: (float, optional) – angular size of cone. Defaults to 360.
             - stretch: scales the base polygon
             - rotation: the rotation of the cylinder
             - align: the alignment of the cylinder
@@ -239,14 +242,21 @@ class PolygonalCylinder(BasePartObject):
         validate_inputs(context, self)
 
         with BuildPart() as tube:
-            with BuildSketch():
+            with BuildSketch() as poly:
                 RegularPolygon(
                     radius=radius, side_count=side_count, align=tuplify(align, 2)
                 )
+                center = poly.sketch.face().center()
+                with Locations((center.X, center.Y)):
+                    Circle(
+                        radius=radius,
+                        arc_size=arc_size,
+                        align=None,
+                        mode=Mode.INTERSECT,
+                    ),
             extrude(amount=height * stretch[2])
-        super().__init__(
-            part=tube.part, rotation=rotation, align=tuplify(align, 3), mode=mode
-        )
+            scale(tube.part, by=(stretch[0], stretch[1], 1))
+        super().__init__(part=tube.part, rotation=rotation, align=align, mode=mode)
 
 
 class DiamondCylinder(PolygonalCylinder):
@@ -255,6 +265,7 @@ class DiamondCylinder(PolygonalCylinder):
         self,
         radius: float,
         height: float,
+        arc_size: float = 360,
         stretch: tuple = (1, 1, 1),
         rotation: RotationLike = (0, 0, 0),
         align: Union[None, Align, tuple[Align, Align, Align]] = None,
@@ -264,17 +275,19 @@ class DiamondCylinder(PolygonalCylinder):
         creates an extruded diamond that behaves like a cylinder
         -------
         arguments:
-            - radius: the radius of the cylinder
-            - height: the height of the cylinder
-            - rotation: the rotation of the cylinder
-            - align: the alignment of the cylinder (default
+            - radius: (float) - the radius of the cylinder
+            - height: (float) - the height of the cylinder
+            - arc_size: (float, optional) – angular size of cone. Defaults to 360.
+            - rotation: (RotationLike) - the rotation of the cylinder
+            - align: (Union[None, Align, tuple[Align, Align, Align]]) - the alignment of the cylinder (default
                     is (Align.CENTER, Align.CENTER, Align.CENTER) )
-            - mode: the mode to use when adding the part
+            - mode: (Mode) - the mode to use when adding the part
         """
         super().__init__(
             radius=radius,
             height=height,
             side_count=4,
+            arc_size=arc_size,
             stretch=stretch,
             rotation=rotation,
             align=align,
@@ -379,19 +392,14 @@ class TeardropCylinder(BasePartObject):
 if __name__ == "__main__":
 
     show(
-        DiamondTorus(
-            50,
-            2,
-        ),
-        reset_camera=Camera.KEEP,
-    )
-    show(
-        DiamondCylinder(
+        PolygonalCylinder(
             radius=50,
             height=200,
+            side_count=6,
+            arc_size=270,
             stretch=(1, 1, 1),
             rotation=(0, 0, 0),
-            align=(Align.MIN, Align.MIN, Align.CENTER),
+            align=(Align.CENTER, Align.CENTER, Align.MAX),
         ),
         reset_camera=Camera.KEEP,
     )

{b3dkit-0.1.1 → b3dkit-0.1.3}/src/b3dkit/bolt_fittings.py

@@ -7,6 +7,7 @@ from build123d import (
     BuildSketch,
     Circle,
     Cylinder,
+    GridLocations,
     Location,
     Mode,
     Part,
@@ -80,7 +81,6 @@ class TeardropBoltCutSinkhole(BasePartObject):
                 align=(Align.CENTER, Align.CENTER, Align.MIN),
             ),
             if extension_distance > 0:
-                # extrude(sinkhole.faces().sort_by(Axis.Z)[0], amount=extension_distance)
                 extrude(
                     sinkhole.faces().sort_by(Axis.Z)[-1],
                     amount=extension_distance,
@@ -97,7 +97,7 @@ class TeardropBoltCutSinkhole(BasePartObject):
         )
 
 
-class BoltCutSinkhole(BasePartObject):
+class BoltCutSinkhole(TeardropBoltCutSinkhole):
 
     def __init__(
         self,
@@ -132,7 +132,8 @@ class BoltCutSinkhole(BasePartObject):
             - mode: the mode to use when adding the sinkhole
         Returns:
             - Part: A cylindrical bolt hole part with countersink"""
-        sinkhole = TeardropBoltCutSinkhole(
+
+        super().__init__(
             shaft_radius=shaft_radius,
             shaft_depth=shaft_depth,
             head_radius=head_radius,
@@ -145,13 +146,6 @@ class BoltCutSinkhole(BasePartObject):
             mode=mode,
         )
 
-        super().__init__(
-            part=sinkhole,
-            rotation=rotation,
-            align=tuplify(align, 3),
-            mode=mode,
-        )
-
 
 class SquareNutSinkhole(BasePartObject):
 
@@ -359,5 +353,6 @@ class HeatsinkCut(BasePartObject):
 if __name__ == "__main__":
     with BuildPart() as tst:
         Box(20, 20, 20)
-        BoltCutSinkhole(mode=Mode.SUBTRACT)
+        with GridLocations(10, 10, 2, 2):
+            BoltCutSinkhole(mode=Mode.SUBTRACT)
     show(tst.part, reset_camera=Camera.KEEP)