Prepare py package for distribution

Author: michelerenzullo

CMakeLists.txt

@@ -213,13 +213,30 @@ if(WITH_BINDINGS)
 
     pybind11_add_module(gaussianblur MODULE ${BINDING_SOURCES})
 
-    target_link_libraries(gaussianblur PRIVATE GaussianBlurLib)
 
+    # Set the RPATH to "./../../lib" in case is under 'external/$PLATFORM/$ABI/lib', and to "." (same directory)
+    # respect the origin location of the .so file
+    #
+    # Can also be skipped and the developer will have the duty
+    # to install the built libs into /usr/lib/ or use "export LD_LIBRARY_PATH=..."
+    # before running the python script that uses the raw binded shared library instead of the wheel.
+    if(APPLE)
+        set(RPATH "@loader_path/../../lib;@loader_path")
+        set(EXTRA_LINK_FLAGS "")
+    elseif(UNIX)
+        set(RPATH "$ORIGIN/../../lib;$ORIGIN")
+        # On Linux, we need to add --no-as-needed to the linker flags
+        # so that the linker doesn't remove the shared library if it's not used.
+        # Not our case tho, but it's a good practice.
+        set(EXTRA_LINK_FLAGS "-Wl,--no-as-needed")
+    endif()
+
+    target_link_libraries(gaussianblur PRIVATE GaussianBlurLib ${EXTRA_LINK_FLAGS})
 
-    # Set the output directory for the shared library to:
-    # <repo_root>/python/bindings/gaussianblur/
     set_target_properties(gaussianblur PROPERTIES
         LIBRARY_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/python/gaussianblur
+        INSTALL_RPATH "${RPATH}"
+        BUILD_WITH_INSTALL_RPATH ON
     )
 
     # Optionally, add an install rule for the bindings.
@@ -234,10 +251,12 @@ if(WITH_BINDINGS)
         COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_BINARY_DIR}/py_wheel/gaussianblur
         COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_FILE:gaussianblur> ${CMAKE_BINARY_DIR}/py_wheel/gaussianblur/
         COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/python/gaussianblur/__init__.py ${CMAKE_BINARY_DIR}/py_wheel/gaussianblur/
+        COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_FILE:GaussianBlurLib> ${CMAKE_BINARY_DIR}/py_wheel/gaussianblur/
         COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/python/setup.py ${CMAKE_BINARY_DIR}/py_wheel/
         COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/python/pyproject.toml ${CMAKE_BINARY_DIR}/py_wheel/
+        COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/python/LICENSE ${CMAKE_BINARY_DIR}/py_wheel/
+        COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/python/README.md ${CMAKE_BINARY_DIR}/py_wheel/
         COMMAND python3 -m build ${CMAKE_BINARY_DIR}/py_wheel
         COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/py_wheel/dist/*.whl ${CMAKE_SOURCE_DIR}/python/
-        COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/py_wheel/dist/*.whl ${PrefixPath}/python/
     )
 endif()

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2025 Michele Renzullo <[email protected]>
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -273,7 +273,6 @@ LibGaussianBlur implements a robust Continuous Integration and Continuous Deploy
   - Tests must pass successfully before generating the coverage report and build the Android and WASM libraries.
 
 ## Roadmap
-- Python wheel packages
 - Doxygen
 - Flutter plugin with native bindings
 
@@ -282,7 +281,7 @@ Contributions are welcome! Please open an issue or submit a pull request on GitH
 
 
 ## License
-This project is licensed under the MIT License. See the LICENSE file for details.
+This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.
 
 ## Acknowledgements
 

bootstrap/bootstrap.gaussianblur.sh

@@ -5,7 +5,7 @@
 
 PREFIX="gaussian_blur"
 TEMP_EXTERNAL_BUILD_DIR=.deps
-GAUSSIANBLUR_VERSION="1.0.5"
+GAUSSIANBLUR_VERSION="1.1.1"
 GAUSSIANBLUR_FOLDER="v${GAUSSIANBLUR_VERSION}"
 GAUSSIANBLUR_BUILD_DIR="${PREFIX}-${GAUSSIANBLUR_FOLDER}"
 

python/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Michele Renzullo <[email protected]>
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

python/README.md

@@ -0,0 +1,99 @@
+# GaussianBlur
+
+![Continuous Integration](https://github.com/michelerenzullo/LibGaussianBlur/actions/workflows/ci.yml/badge.svg?branch=main) 
+![coverage](https://raw.githubusercontent.com/michelerenzullo/LibGaussianBlur/refs/heads/main/coverage.svg)
+![license](https://img.shields.io/github/license/michelerenzullo/libgaussianblur)  
+
+GaussianBlur provide a high-performance interface to the underlying LibGaussianBlur C++ library, enabling efficient Gaussian blur image processing through a simple Python API.
+
+## Overview
+
+LibGaussianBlur is a C++ library designed to apply Gaussian blur to images using the Fast Fourier Transform (FFT) multi-threaded for tiles. The Python bindings expose this powerful functionality in a user-friendly way, integrating with popular Python imaging libraries such as Pillow and numpy.
+
+Key features include:
+
+- **FFT-based Gaussian Blur:** Apply precise Gaussian blur using FFT techniques.
+- **Optimized Performance:** Leverages parallel tile processing and multi-threading.
+- **Cross-Platform Support:** Efficiently processes images on multiple operating systems.
+- **Flexible API:** Easily integrate with existing Python image processing workflows.
+
+## Example Requirements
+
+*Note: The following packages are only required for running the usage example and are not mandatory dependencies of the module itself.*
+
+- Python >= 3.11
+- [Pillow](https://pillow.readthedocs.io/) – for image loading and saving
+- [numpy](https://numpy.org/) – for numerical operations
+
+## Installation
+
+Install the module from PyPI:
+
+```bash
+pip install gaussianblur
+```
+
+Alternatively, you can build it from source if needed. Make sure the underlying C++ library and its dependencies are correctly configured.
+
+## Usage Example
+
+Below is a simple example demonstrating how to use the `gaussianblur` module:
+
+```python
+from PIL import Image as PILImage
+import numpy as np
+import gaussianblur
+
+# This is a simple example of how to use the gaussianblur module in Python.
+def main():
+    input_file = "input.png"
+    output_file = "output.png"
+    
+    # Load image using Pillow
+    pil_img = PILImage.open(input_file)
+    
+    # Create an instance of the gaussianblur.Image object
+    img = gaussianblur.Image()
+    img.geom.rows = pil_img.size[1]
+    img.geom.cols = pil_img.size[0]
+    img.geom.channels = len(pil_img.getbands())
+    img.data = np.array(pil_img).flatten().tolist()
+    
+    # Set the sigma value for the Gaussian blur
+    sigma = 7.5
+    
+    # If True, the alpha channel will be blurred as well (if present)
+    apply_to_alpha_channel = True
+    
+    # Apply Gaussian blur
+    gaussianblur.gaussianblur(img, sigma, apply_to_alpha_channel)
+    print("Gaussian blur applied.")
+    
+    # Save the output image
+    out_np_img = np.array(img.data, dtype=np.uint8).reshape(img.geom.rows, img.geom.cols, img.geom.channels)
+    PILImage.fromarray(out_np_img, pil_img.mode).save(output_file)
+    print("Output written to", output_file)
+
+if __name__ == "__main__":
+    main()
+```
+
+## How It Works
+
+The Python module leverages the robust and efficient algorithms implemented in the underlying C++ library:
+
+- **Centered Kernel Generation:** Automatically generates a centered Gaussian kernel to avoid circular convolution artifacts.
+- **FFT-based Convolution:** Performs FFT on both the kernel and image tiles to achieve efficient, high-performance convolution in each dimension and for each tile.
+- **Multi-threading & SIMD Optimizations:** Ensures speedy processing without fearing any large images, thanks to FFT and parallel processing.
+
+## Additional Information
+
+For more details about the underlying C++ library and its capabilities, please refer to the [LibGaussianBlur repository](https://github.com/michelerenzullo/LibGaussianBlur).
+
+## Contributing
+
+Contributions are welcome! If you have suggestions or improvements, please open an issue or submit a pull request on GitHub.
+
+## License
+
+This project is licensed under the Apache-2.0 License. See the [LICENSE](https://raw.githubusercontent.com/michelerenzullo/LibGaussianBlur/refs/heads/main/LICENSE) file for details.