spyrrow 0.2.0__cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl → 0.4.0__cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl

spyrrow/__init__.pyi

@@ -14,23 +14,91 @@ class Item:
         shape: list[Point],
         demand: int,
         allowed_orientations: list[float],
-    ): ...
+    ):
+        """
+        An Item represents any closed 2D shape by its outer boundary.
+
+        Spyrrow doesn't support hole(s) inside the shape as of yet. Therefore no Item can be nested inside another.
+
+        Continous rotation is not supported as of yet. A workaround  is to specify any integer degrees between 0 and 360
+        to the allowed_orientations list.
+
+        Args:
+            id: The Item identifier for a given StripPackingInstance.
+              Best autoincremented as the instance verifies that all ids are presents starting from 0.
+            shape: An ordered list of (x,y) defining the shape boundary. The shape is represented as a polygon formed by this list of points.
+              The origin point can be included twice as the finishing point. If not, [last point, first point] is infered to be the last straight line of the shape.
+            demand: The quantity of identical Items to be placed inside the strip. Should be positive.
+            allowed_orientations: List of angles in degrees allowed. An empty list is equivalent to [0.].
+              The algorithmn is only very weakly sensible to the length of the list given.
+
+        """
+    
+    def to_json_str(self)->str:
+        """ Return a string of the JSON representation of the object"""
 
 class PlacedItem:
+    """
+    An object representing where a copy of an Item was placed inside the strip.
+
+    Attributes:
+        id (int): The Item identifier for a given StripPackingInstance.
+        translation (tuple[float,float]): the translation vector in the X-Y axis
+        rotation (float): The roation angle in degrees, assuming that the original Item was defined with 0° as its rotation angle.
+    """
+
     id: int
     shape: list[Point]
     translation: Point
     rotation: float
 
 class StripPackingSolution:
+    """
+    An object representing the solution to a given StripPackingInstance.
+
+    Can not be directly instanciated. Result from StripPackingInstance.solve.
+
+    Attributes:
+        width (float): the width of the strip found to contains all Items. In the same unit as input.
+        placed_items (list[PlacedItem]): a list of all PlacedItems, describing how Items are placed in the solution
+        density (float): the fraction of the final strip used by items.
+    """
+
     width: float
     density: float
     placed_items: list[PlacedItem]
 
 class StripPackingInstance:
     name: str
-    height: float
+    strip_height: float
     items: list[Item]
 
-    def __init__(self, name: str, height: float, items: list[Item]): ...
-    def solve(self, computation_time: int = 600) -> StripPackingSolution: ...
+    def __init__(self, name: str, strip_height: float, items: list[Item]):
+        """
+        An Instance of a Strip Packing Problem.
+
+        Args:
+            name (str): The name of the instance. Required by the underlying sparrow library.
+              An empty string '' can be used, if the user doesn't have a use for this name.
+            strip_height (float): the fixed height of the strip. The unit should be compatible with the Item
+            items (list[Item]): The Items which defines the instances. All Items should be defined with the same scale ( same length unit).
+              Items ids should be an increasing series starting at 0 until len(items)-1.
+
+         Raises:
+            ValueError
+        """
+    def to_json_str(self)->str:
+        """ Return a string of the JSON representation of the object"""
+
+
+    def solve(self, computation_time: int = 600) -> StripPackingSolution:
+        """
+        The method to solve the instance.
+
+        Args:
+            computation_time (int): The total computation time in seconds used to find a solution.
+              The algorithm won't exit early.Waht you input is what you get. Default is 600 s = 10 minutes.
+
+        Returns:
+            a StripPackingSolution
+        """

spyrrow-0.4.0.dist-info/METADATA

@@ -0,0 +1,68 @@
+Metadata-Version: 2.4
+Name: spyrrow
+Version: 0.4.0
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+License-File: LICENSE.txt
+Author-email: Paul Durand-Lupinski <paul.durand-lupinski@reeverse-systems.com>
+License: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: documentation, https://spyrrow.readthedocs.io/
+Project-URL: source, https://github.com/PaulDL-RS/spyrrow
+
+# Spyrrow
+
+`spyrrow` is a Python wrapper on the Rust project [`sparrow`](https://github.com/JeroenGar/sparrow).
+It enables to solve 2D [Strip packing problems](https://en.wikipedia.org/wiki/Strip_packing_problem). 
+
+The documentation is hosted [here](https://spyrrow.readthedocs.io/). 
+
+## Installation
+
+Spyrrow is hosted on [PyPI](https://pypi.org/project/spyrrow/).
+
+You can install with the package manager of your choice, using the PyPI package index.
+
+For example, with `pip`, the default Python package:
+```bash
+pip install spyrrow
+```
+
+## Examples
+```python
+import spyrrow
+
+rectangle1 = spyrrow.Item(
+        0, [(0, 0), (1, 0), (1, 1), (0, 1), (0, 0)], demand=4, allowed_orientations=[0]
+    )
+triangle1 = spyrrow.Item(
+        1,
+        [(0, 0), (1, 0), (1, 1), (0, 0)],
+        demand=6,
+        allowed_orientations=[0, 90, 180, -90],
+    )
+
+instance = spyrrow.StripPackingInstance("test", strip_height=2.001, items=[rectangle1,triangle1])
+sol:spyrrow.StripPackingSolution = instance.solve(30)
+print(sol.width)
+print(sol.density)
+print("\n")
+for pi in sol.placed_items:
+    print(pi.id)
+    print(pi.rotation)
+    print(pi.translation)
+    print("\n")
+```
+
+## Contributing
+
+Spyrrow is open to contributions.
+The first target should be to reach  Python open sources packages standards and practices. 
+Second, a easier integration with the package `shapely` is envsionned.
+
+Please use GitHub issues to request features. 
+They will be considered relative to what is already implemented in the parent library `sparrow`. 
+If necessary, they can be forwarded to it. 
+

spyrrow-0.4.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+spyrrow-0.4.0.dist-info/METADATA,sha256=xISpeyAxcBngcjpXGDIIwv7I3AfHo56GUUpwojWvk5A,2136
+spyrrow-0.4.0.dist-info/WHEEL,sha256=r1_28i_1ylcHbqjX_F4wyasCD36lcm8h5iIstv_iqLo,125
+spyrrow-0.4.0.dist-info/licenses/LICENSE.txt,sha256=JOcOnGFqH2ZNyuMV3DBGh5kNL_3IqaS5832hwXhZ-Js,1076
+spyrrow/__init__.py,sha256=MajlSBAliv8o8SqAqLgJARyi3egmvNIaXKTDXxvIAFY,111
+spyrrow/__init__.pyi,sha256=MZXI5_RK5wSwDwPSZIV-m75mgi_ZW35MQuPQVpAiFHc,4010
+spyrrow/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+spyrrow/spyrrow.cpython-311-i386-linux-gnu.so,sha256=tGf585yTTUJpo55xiCYknKWZgUwCHysTtbCmhsufJTY,1578556
+spyrrow-0.4.0.dist-info/RECORD,,

{spyrrow-0.2.0.dist-info → spyrrow-0.4.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: maturin (1.8.4)
+Generator: maturin (1.8.6)
 Root-Is-Purelib: false
 Tag: cp311-cp311-manylinux_2_17_i686.manylinux2014_i686

spyrrow-0.2.0.dist-info/METADATA

@@ -1,54 +0,0 @@
-Metadata-Version: 2.4
-Name: spyrrow
-Version: 0.2.0
-Classifier: Programming Language :: Rust
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Programming Language :: Python :: Implementation :: PyPy
-License-File: LICENSE.txt
-License: MIT
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
-
-# Spyrrow
-
-Python wrapper on the Rust project [`sparrow`](https://github.com/JeroenGar/sparrow)
-
-## Examples
-```python
-import spyrrow
-
-rectangle1 = spyrrow.Item([(0,0),(1,0),(1,1),(0,1),(0,0)], demand=4, allowed_orientations=[0])
-triangle1 = spyrrow.Item([(0,0),(1,0),(1,1),(0,0)], demand=6, allowed_orientations=[0,90,180,-90])
-
-instance = spyrrow.StripPackingInstance("test", height=2.001, items=[rectangle1,triangle1])
-sol:spyrrow.StripPackingSolution = instance.solve(30)
-print(sol.width)
-print(sol.density)
-print("\n")
-for pi in sol.placed_items:
-    print(pi.id)
-    print(pi.rotation)
-    print(pi.translation)
-    print("\n")
-```
-
-## Informations
-
-The algorithmn is  insensitive to rotation angles and shapes complexity (to a certain extend)
-
-# TODOS
-
-## Pay attention to that
-
-
-use test-profile for local developpment
-
-investiguate the compile options, nightly and SIMD and PyPa target architectures
-
-- add presets for parameters as enums 
-
-## Mixed project Python/Rust
-possibility to add conversion from shapely in a shapely variant
-investiguate the possibility of maturin to handle extras
-
-

spyrrow-0.2.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-spyrrow-0.2.0.dist-info/METADATA,sha256=p9D_QSmvABrTUdR-gSzH7Jy4Q3KDGeclq7SlgSNpnZo,1467
-spyrrow-0.2.0.dist-info/WHEEL,sha256=l1FKM0hop4XeVWkVQ9p_Yk6RMb-wdqVB46g-I-1N-Jk,125
-spyrrow-0.2.0.dist-info/licenses/LICENSE.txt,sha256=JOcOnGFqH2ZNyuMV3DBGh5kNL_3IqaS5832hwXhZ-Js,1076
-spyrrow/__init__.py,sha256=MajlSBAliv8o8SqAqLgJARyi3egmvNIaXKTDXxvIAFY,111
-spyrrow/__init__.pyi,sha256=9cCpUUc08P05BLw-ZZan96eJM9WaOdRDld42lWLHOTE,756
-spyrrow/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-spyrrow/spyrrow.cpython-311-i386-linux-gnu.so,sha256=nNpxaipRL8mux_QzmMYlaB0Z-GIQ9op5eK0u1ZN_bgY,1534248
-spyrrow-0.2.0.dist-info/RECORD,,