|PyPI-Versions| |PyPI-Wheel| |Build-Status| |Read-the-Docs| |GitHub-License|
|PyPI-Downloads|
Primary use: Given a set of rectangles with fixed orientations, find a bounding box of minimum area that contains them all with no overlap.
This project is inspired by Matt Perdeck's blog post Fast Optimizing Rectangle Packing Algorithm for Building CSS Sprites_.
Read the Docs_.GitHub_.Install latest version from PyPI_:
.. code:: sh
$ python3 -m pip install rectangle-packerOr clone the repository_ and install with:
.. code:: sh
$ python3 setup.py install.. code:: python
# Import the module
>>> import rpack
# Create a bunch of rectangles (width, height)
>>> sizes = [(58, 206), (231, 176), (35, 113), (46, 109)]
# Pack
>>> positions = rpack.pack(sizes)
# The result will be a list of (x, y) positions:
>>> positions
[(0, 0), (58, 0), (289, 0), (289, 113)]The output positions are the lower left corner coordinates of each rectangle in the input.
These positions will yield a packing with no overlaps and enclosing area as small as possible (best effort).
.. note::
* You must use **positive integers** as rectangle width and height.
* The module name is **rpack** which is an abbreviation of the package
name at PyPI (rectangle-packer).
* The computational time required by :py:func:`rpack.pack` increases by
the number *and* size of input rectangles. If this becomes a problem,
you might need to implement your own `divide-and-conquer algorithm`_.Example A:
.. image:: https://penlect.com/rpack/2.0.1/img/packing_best_10.png :alt: pack10 :align: center
Example B:
.. image:: https://penlect.com/rpack/2.0.1/img/packing_phi.png :alt: packphi :align: center
Example C: Sometimes the input rectangles simply cannot be packed in a good way. Here is an example of low packing density:
.. image:: https://penlect.com/rpack/2.0.1/img/packing_worst_10.png :alt: pack10bad :align: center
Example D: The image below is contributed by Paul Brodersen, and illustrates a solution to a problem discussed at stackoverflow_.
.. image:: https://i.stack.imgur.com/kLat8.png :alt: PaulBrodersenExampleImage :align: center :width: 450px
.. _Read the Docs: https://rectangle-packer.readthedocs.io/en/latest/
.. GitHub: https://github.com/Penlect/rectangle-packer
.. Fast Optimizing Rectangle Packing Algorithm for Building CSS Sprites: http://www.codeproject.com/Articles/210979/Fast-optimizing-rectangle-packing-algorithm-for-bu
.. _clone the repository: https://github.com/Penlect/rectangle-packer
.. _stackoverflow: https://stackoverflow.com/a/53156709/2912349
.. PyPI: https://pypi.org/project/rectangle-packer/
.. divide-and-conquer algorithm: https://en.wikipedia.org/wiki/Divide-and-conquer_algorithm
.. |PyPI-Versions| image:: https://img.shields.io/pypi/pyversions/rectangle-packer.svg :target: https://pypi.org/project/rectangle-packer
.. |PyPI-Wheel| image:: https://img.shields.io/pypi/wheel/rectangle-packer.svg :target: https://pypi.org/project/rectangle-packer
.. |Build-Status| image:: https://travis-ci.com/Penlect/rectangle-packer.svg?branch=master :target: https://travis-ci.com/Penlect/rectangle-packer
.. |Read-the-Docs| image:: https://img.shields.io/readthedocs/rectangle-packer.svg :target: https://rectangle-packer.readthedocs.io/en/latest
.. |GitHub-License| image:: https://img.shields.io/github/license/Penlect/rectangle-packer.svg :target: https://raw.githubusercontent.com/Penlect/rectangle-packer/travis/LICENSE.md
.. |PyPI-Downloads| image:: https://img.shields.io/pypi/dm/rectangle-packer.svg :target: https://pypi.org/project/rectangle-packer