Python cross-compiling script and ABI3

Signed-off-by: Yuki Kishimoto <yukikishimoto@protonmail.com>

Author: yukibtc

justfile

@@ -47,6 +47,10 @@ aar:
 jar:
     @cd jvm && bash assemble.sh
 
+# Assemble the python wheels
+py:
+    @cd python && bash assemble.sh
+
 # Assemble the C# package
 csharp:
     @cd csharp && bash assemble.sh
@@ -61,6 +65,11 @@ publish-aar: aar
 publish-jar: jar
 	cd jvm && ./gradlew publishAndReleaseToMavenCentral --no-configuration-cache
 
+# Publish Wheels
+[confirm]
+publish-py: py
+    cd python && twine upload dist/*
+
 # Compile and build Swift Package
 [macos]
 swift:

python/Dockerfile

@@ -0,0 +1,33 @@
+FROM python:3.9-slim
+
+# Set up working directory
+WORKDIR /build
+
+# Create directories for mounting volumes
+RUN mkdir -p python binding binaries dist
+
+# Copy source
+COPY src/nostr-sdk/__init__.py python/src/nostr-sdk/
+COPY LICENSE python/
+COPY MANIFEST.in python/
+COPY pyproject.toml python/
+COPY README.md python/
+COPY requirements.txt python/
+COPY setup.py python/
+
+# Copy the build script
+COPY --chown=1000:1000 buildwheel.sh .
+RUN chmod +x buildwheel.sh
+
+# Install Python build tools
+RUN pip install -r python/requirements.txt
+
+# Update permissions
+RUN chown -R 1000:1000 /build
+RUN chmod -R 777 /build
+
+# Change user
+USER 1000
+
+# Set the entrypoint to our build script
+ENTRYPOINT ["/build/buildwheel.sh"]

python/assemble.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+
+set -exuo pipefail
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+DIST_DIR="${SCRIPT_DIR}/dist"
+SRC_DIR="${SCRIPT_DIR}/src/nostr-sdk"
+FFI_DIR="${SCRIPT_DIR}/../ffi"
+
+# Clean
+rm -rf "${DIST_DIR}"
+rm -rf "${SRC_DIR}/*.so"
+rm -rf "${SRC_DIR}/nostr_sdk.py"
+
+# Make dir
+mkdir -p "${DIST_DIR}"
+
+# Build docker image
+docker build -t wheel-builder "${SCRIPT_DIR}"
+
+# Generate bindings
+cargo run -p nostr-sdk-ffi --features uniffi-cli --bin uniffi-bindgen generate --library "${FFI_DIR}/apple/macos/x86_64/libnostr_sdk_ffi.dylib" --language python --no-format -o "${SRC_DIR}"
+
+# Build linux wheels
+docker run --rm -v "${FFI_DIR}/linux/x86/:/build/binaries" -v "${SRC_DIR}:/build/binding" -v "$(pwd)/dist:/build/dist" -e PLAT_NAME="manylinux_2_17_i686" wheel-builder
+docker run --rm -v "${FFI_DIR}/linux/x86_64/:/build/binaries" -v "${SRC_DIR}:/build/binding" -v "$(pwd)/dist:/build/dist" -e PLAT_NAME="manylinux_2_17_x86_64" wheel-builder
+docker run --rm -v "${FFI_DIR}/linux/aarch64/:/build/binaries" -v "${SRC_DIR}:/build/binding" -v "$(pwd)/dist:/build/dist" -e PLAT_NAME="manylinux_2_17_aarch64" wheel-builder
+
+# Build macos wheels
+docker run --rm -v "${FFI_DIR}/apple/macos/x86_64/:/build/binaries" -v "${SRC_DIR}:/build/binding" -v "$(pwd)/dist:/build/dist" -e PLAT_NAME="macosx_11_0_x86_64" wheel-builder
+docker run --rm -v "${FFI_DIR}/apple/macos/aarch64/:/build/binaries" -v "${SRC_DIR}:/build/binding" -v "$(pwd)/dist:/build/dist" -e PLAT_NAME="macosx_11_0_arm64" wheel-builder
+
+# Build win wheels
+docker run --rm -v "${FFI_DIR}/win/x86/:/build/binaries" -v "${SRC_DIR}:/build/binding" -v "$(pwd)/dist:/build/dist" -e PLAT_NAME="win32" wheel-builder
+docker run --rm -v "${FFI_DIR}/win/x86_64/:/build/binaries" -v "${SRC_DIR}:/build/binding" -v "$(pwd)/dist:/build/dist" -e PLAT_NAME="win_amd64" wheel-builder
+docker run --rm -v "${FFI_DIR}/win/aarch64/:/build/binaries" -v "${SRC_DIR}:/build/binding" -v "$(pwd)/dist:/build/dist" -e PLAT_NAME="win_arm64" wheel-builder

python/buildwheel.sh

@@ -0,0 +1,44 @@
+#!/bin/bash
+
+# Build a wheel. This script is used from the Dockerfile!
+
+set -exuo pipefail
+
+# Check if required arguments are provided
+if [ -z "$PLAT_NAME" ]; then
+    echo "ERROR: PLAT_NAME environment variable is required"
+    exit 1
+fi
+
+echo "Building wheel for platform: $PLAT_NAME"
+
+ls -l /build/python
+
+# Copy binaries to python directory if they exist
+if [ "$(ls -A /build/binaries)" ]; then
+    cp -r /build/binaries/* /build/python/src/nostr-sdk/
+    echo "Copied binaries to Python package directory"
+else
+    echo "No binaries found in /build/binaries"
+    exit 1
+fi
+
+# Copy generated binding file to the correct location if it exists
+if [ -f "/build/binding/nostr_sdk.py" ]; then
+    # Make sure the target directory exists
+    cp /build/binding/nostr_sdk.py /build/python/src/nostr-sdk/
+    echo "Copied binding file (nostr_sdk.py) to src/nostr-sdk/ directory"
+else
+    echo "WARNING: Binding file (nostr_sdk.py) not found in /build/binding"
+    exit 1
+fi
+
+
+# Enter Python package directory
+cd /build/python
+
+# Build the wheel with Python 3.9 ABI3 compatibility
+python setup.py bdist_wheel --plat-name "$PLAT_NAME" --python-tag cp39.abi3
+
+# Copy wheel to the output directory
+cp dist/*.whl /build/dist/

python/setup.py

@@ -22,4 +22,10 @@
     # This is required to ensure the library name includes the python version, abi, and platform tags
     # See issue #350 for more information
     has_ext_modules=lambda: True,
+    # This enables abi3 compatibility
+    options={
+        "bdist_wheel": {
+            "py_limited_api": "cp39",  # Support Python 3.9+
+        }
+    },
 )

scripts/macos.sh

@@ -5,7 +5,6 @@
 set -exuo pipefail
 
 CDYLIB="libnostr_sdk_ffi.dylib"
-STATIC_LIB="libnostr_sdk_ffi.a"
 SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 TARGET_DIR="${SCRIPT_DIR}/../target"
 MANIFEST_PATH="${SCRIPT_DIR}/../Cargo.toml"
@@ -38,7 +37,4 @@ cp "${TARGET_DIR}/x86_64-apple-darwin/release/${CDYLIB}" "${FFI_APPLE_DIR}/macos
 cp "${TARGET_DIR}/aarch64-apple-darwin/release/${CDYLIB}" "${FFI_APPLE_DIR}/macos/aarch64"
 cp "${TARGET_DIR}/universal2-apple-darwin/release/${CDYLIB}" "${FFI_APPLE_DIR}/macos/universal"
 
-# Copy static libraries
-cp "${TARGET_DIR}/x86_64-apple-darwin/release/${STATIC_LIB}" "${FFI_APPLE_DIR}/macos/x86_64"
-cp "${TARGET_DIR}/aarch64-apple-darwin/release/${STATIC_LIB}" "${FFI_APPLE_DIR}/macos/aarch64"
-cp "${TARGET_DIR}/universal2-apple-darwin/release/${STATIC_LIB}" "${FFI_APPLE_DIR}/macos/universal"
+# NOTE: if the static lib are required for something, copy them in another directory, not in the same of the dylib!!!