feat: building wheels and add continuous integration

Author: domferr

.github/workflows/build_wheels.yml

@@ -0,0 +1,35 @@
+name: Build
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+     - main
+
+jobs:
+  build_wheels:
+    name: Build wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        # macos-13 is an intel runner, macos-14 is apple silicon
+        os: [ubuntu-latest] #, windows-latest, macos-13, macos-14]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      # Used to host cibuildwheel
+      - uses: actions/setup-python@v5
+
+      - name: Install cibuildwheel
+        run: python -m pip install cibuildwheel==2.21.3
+
+      - name: Build wheels
+        run: python -m cibuildwheel --output-dir wheelhouse
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: cibw-wheels-${{ matrix.os }}-${{ strategy.job-index }}
+          path: ./wheelhouse/*.whl

.gitignore

@@ -2,4 +2,5 @@
 .vscode/
 build/
 __pycache__/
-*.egg-info
+*.egg-info
+wheelhouse

.gitmodules

@@ -1,3 +1,3 @@
 [submodule "fastflow"]
-	path = fastflow
+	path = extern/fastflow
 	url = https://github.com/fastflow/fastflow.git

Makefile

@@ -1,14 +1,11 @@
-.PHONY: clean config repara-copy titanic-copy build
+.PHONY: clean config repara-copy titanic-copy build ci
 
 # run source .venv/bin/activate before running make build
 build: clean
 	pip install .
 
-repara-copy:
-	rsync -av -e ssh --exclude 'fastflow' --exclude '.git' --exclude '.venv' --exclude '*.egg-info' --exclude 'build' ./ [email protected]:/home/dferraro/fastflow-python
-
-titanic-copy:
-	rsync -av -e ssh --exclude 'fastflow' --exclude '.git' --exclude '.venv' --exclude '*.egg-info' --exclude 'build' ./ [email protected]:/home/dferraro/fastflow-python
+ci:
+	cibuildwheel --platform linux
 
 clean:
 	rm -rf build

README.md

@@ -26,7 +26,7 @@ Whether you’re processing massive datasets, building scalable applications, or
 
 ## Installation
 
-To install **fastflow**, ensure you have the following dependencies: `python3`, `python3-venv` and `python3-dev`. For example on Ubuntu you can install them using `apt install`.
+To install **fastflow**, ensure you have the following dependencies: `python3`, `python3-venv` and `python3-dev`. For example on Ubuntu you can install them using `apt install`. Ensure you have updated submodules by running `git submodule init && git submodule update`.
 
 1. From the root directory, create virtual environment via `python3 -m venv .venv`
 2. From the root directory, activate the virtual environment by running `source .venv/bin/activate`
@@ -485,6 +485,10 @@ pipeline.add_stage(sink())
 pipeline.run_and_wait_end()
 ```
 
+## Test CI locally
+
+To test the CI locally (optional), useful to test changes before actually change the whole ci, `pip install cibuildwheel` and then run `cibuildwheel --platform linux` or `make ci`.
+
 ## Contributing
 
 Contributions are welcome! Please submit pull requests or open issues to help improve this project.

fastflow renamed to extern/fastflow

@@ -1,3 +1,21 @@
 [build-system]
 requires = ["setuptools>=61.0"]
 build-backend = "setuptools.build_meta"
+
+[project]
+name = "fastflow"
+version = "1.0.0"
+requires-python = ">= 3.8"
+authors = [
+  {name = "Domenico Ferraro", email = "[email protected]"},
+]
+maintainers = [
+  {name = "Domenico Ferraro", email = "[email protected]"},
+]
+description = "Unlock the full potential of parallel computing in Python with FastFlow, a powerful C++ library now available in Python, that brings high-performance, scalable parallelism right to your fingertips."
+readme = {file = "README.md", content-type = "text/markdown"}
+license = {file = "LICENSE"}
+
+[tool.cibuildwheel]
+# Disable building PyPy wheels on all platforms and skip 32-bit builds
+skip = ["pp*", "*-manylinux_i686", "*-musllinux_i686"]

pyproject.toml

@@ -7,19 +7,20 @@ def main():
         description="Description",
         author="Domenico Ferraro",
         author_email="[email protected]",
-        python_requires=">=3.8",
         ext_modules=[
             Extension(
                 "fastflow", 
                 ["fastflow_module.cpp"],
-                include_dirs=['fastflow', 'include'],
+                include_dirs=['extern/fastflow', 'include'],
                 language="c++",
                 extra_compile_args=['-O3', '-std=c++17'],
                 # use a safe subset of the Python C API to get a forward-compatibility guarantee 
                 # to support any future version of Python, without recompilation
                 py_limited_api = True
             )
         ],
+        package_dir={"": "."},
+        python_requires=">=3.8",
     )
 
 if __name__ == "__main__":