spyrrow 0.2.0__tar.gz → 0.3.0__tar.gz

spyrrow-0.3.0/.readthedocs.yaml

@@ -0,0 +1,18 @@
+# https://docs.readthedocs.io/en/stable/config-file/v2.html#supported-settings
+
+version: 2
+
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.11"
+    rust: "1.86"
+
+python:
+  install:
+    - method: pip
+      path: .

{spyrrow-0.2.0 → spyrrow-0.3.0}/Cargo.lock

@@ -707,11 +707,13 @@ dependencies = [
 
 [[package]]
 name = "spyrrow"
-version = "0.2.0"
+version = "0.3.0"
 dependencies = [
  "jagua-rs",
  "pyo3",
  "rand",
+ "serde",
+ "serde_json",
  "sparrow",
 ]
 

{spyrrow-0.2.0 → spyrrow-0.3.0}/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "spyrrow"
-version = "0.2.0"
-edition = "2021"
+version = "0.3.0"
+edition = "2024"
 license = "MIT"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
@@ -13,4 +13,6 @@ crate-type = ["cdylib"]
 jagua-rs = { git = "https://github.com/JeroenGar/jagua-rs.git", rev="06152d8654d8b9b0652c14ccd1f5d693b703b5de", features = ["spp"], default-features = false}
 pyo3 = "0.24.0"
 rand = { version = "0.9.0", features = ["small_rng"] }
+serde = {version = "1.0.219", features = ["derive"]}
+serde_json = "1.0.140"
 sparrow = { git = "https://github.com/JeroenGar/sparrow.git",rev="cb456fe41443c6c3153141aa8e945fedba78e60b",features = ["only_final_svg"], default-features = false}

spyrrow-0.3.0/PKG-INFO

@@ -0,0 +1,68 @@
+Metadata-Version: 2.4
+Name: spyrrow
+Version: 0.3.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.3.0/README.md

@@ -0,0 +1,53 @@
+# 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.3.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)

spyrrow-0.3.0/docs/api.rst

@@ -0,0 +1,12 @@
+API
+===
+
+Public API of `spyrrow`
+
+.. autoclass:: spyrrow::Item
+
+.. autoclass:: spyrrow::StripPackingInstance
+
+.. autoclass:: spyrrow::StripPackingSolution
+
+.. autoclass:: spyrrow::PlacedItem

spyrrow-0.3.0/docs/conf.py

@@ -0,0 +1,32 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'spyrrow'
+copyright = '2025, Paul Durand-Lupinski'
+author = 'Paul Durand-Lupinski'
+release = '0.3.0'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.napoleon',
+    'sphinx.ext.autodoc'
+]
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# Napoleon settings
+napoleon_google_docstring = True
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']

spyrrow-0.3.0/docs/index.rst

@@ -0,0 +1,57 @@
+.. spyrrow documentation master file, created by
+   sphinx-quickstart on Mon May 19 14:10:17 2025.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+spyrrow documentation
+=====================
+
+`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>`_. 
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   api
+
+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:
+
+.. code-block:: bash
+
+   pip install spyrrow
+
+Examples
+========
+
+.. code-block:: 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")

spyrrow-0.3.0/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

{spyrrow-0.2.0 → spyrrow-0.3.0}/pyproject.toml

@@ -10,8 +10,14 @@ classifiers = [
     "Programming Language :: Python :: Implementation :: CPython",
     "Programming Language :: Python :: Implementation :: PyPy",
 ]
+authors = [ {name = "Paul Durand-Lupinski", email = "paul.durand-lupinski@reeverse-systems.com"}]
 license = { file = "LICENSE.txt" }
 dynamic = ["version"]
+
+[project.urls]
+documentation = "https://spyrrow.readthedocs.io/"
+source = "https://github.com/PaulDL-RS/spyrrow"
+
 [tool.maturin]
 features = ["pyo3/extension-module"]
 
@@ -19,4 +25,5 @@ features = ["pyo3/extension-module"]
 dev = [
     "pytest",
     "ruff",
-]
+    "sphinx>=8.1.3",
+]

spyrrow-0.3.0/spyrrow.pyi

@@ -0,0 +1,104 @@
+from typing import TypeAlias
+
+Point: TypeAlias = tuple[float, float]
+
+class Item:
+    id: int
+    demand: int
+    shape: list[Point]
+    allowed_orientations: list[float]
+
+    def __init__(
+        self,
+        id: int,
+        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
+    strip_height: float
+    items: list[Item]
+
+    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
+        """