Py bindings ci

.github/workflows/build-python.yml

@@ -0,0 +1,104 @@
+# Copied from [bdk-ffi](https://github.com/bitcoindevkit/bdk-ffi/blob/master/.github/workflows/test-python.yaml)
+name: Build and Test Python
+on: [push, pull_request]
+
+jobs:
+  build-manylinux_2_28-x86_64-wheels:
+    name: "Build and test Manylinux 2.28 x86_64 wheels"
+    runs-on: ubuntu-20.04
+    defaults:
+      run:
+        working-directory: python
+    container:
+      image: quay.io/pypa/manylinux_2_28_x86_64
+      env:
+        PLAT: manylinux_2_28_x86_64
+        PYBIN: "/opt/python/${{ matrix.python_dir }}/bin"
+    strategy:
+      matrix:
+        include:
+          - python: "3.8"
+            python_dir: "cp38-cp38"
+          - python: "3.9"
+            python_dir: "cp39-cp39"
+          - python: "3.10"
+            python_dir: "cp310-cp310"
+          - python: "3.11"
+            python_dir: "cp311-cp311"
+          - python: "3.12"
+            python_dir: "cp312-cp312"
+    steps:
+      - name: "Checkout"
+        uses: actions/checkout@v4
+
+      - name: "Install Rust 1.78.0"
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: 1.78.0
+
+      - name: "Install Python"
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: "Generate payjoin-ffi.py and binaries"
+        run: PYBIN="/opt/python/${{ matrix.python_dir }}/bin" bash ./scripts/generate_linux.sh
+
+      - name: "Build wheel"
+        # Specifying the plat-name argument is necessary to build a wheel with the correct name,
+        # see issue BDK#350 for more information
+        run: ${PYBIN}/python setup.py bdist_wheel --plat-name $PLAT --verbose
+
+      - name: "Install wheel"
+        run: ${PYBIN}/pip install ./dist/*.whl
+
+      - name: "Run tests"
+        run: ${PYBIN}/python -m unittest --verbose test/payjoin_unit_test.py
+
+  build-macos:
+    name: "Build and test macOS"
+    runs-on: macos-13
+    defaults:
+      run:
+        working-directory: python
+    strategy:
+      matrix:
+        python:
+          - "3.8"
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+    steps:
+      - name: "Checkout"
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: "Install Rust 1.78.0"
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: 1.78.0
+
+      - name: "Install Python"
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: "Generate payjoin-ffi.py and binaries"
+        run: bash ./scripts/generate_macos.sh
+
+      - name: "Build wheel"
+        # Specifying the plat-name argument is necessary to build a wheel with the correct name,
+        # see issue BDK#350 for more information
+        run: python3 setup.py bdist_wheel --plat-name macosx_11_0_x86_64 --verbose
+
+      - name: "Install wheel"
+        run: pip3 install ./dist/*.whl
+
+      - name: "Run tests"
+        run: python3 -m unittest --verbose test/payjoin_unit_test.py
+
+      - name: "Build arm64 wheel"
+        run: python3 setup.py bdist_wheel --plat-name macosx_11_0_arm64 --verbose
+      # Note: You can't install the arm64 wheel on the CI, so we skip these steps and simply test that the wheel builds

.github/workflows/build.yml

@@ -21,7 +21,7 @@ jobs:
         run: cargo build --color always --all-targets --features _danger-local-https
       - name: Check formatting (nightly only)
         if: matrix.rust == 'nightly'
-        run: rustup component add rustfmt && cargo fmt --all -- --check\
+        run: rustup component add rustfmt && cargo fmt --all -- --check
 
   Lint:
     runs-on: ubuntu-latest

README.md

@@ -17,7 +17,7 @@ The directories below include instructions for using, building, and publishing t
 
 | Language | Platform              | Published Package | Building Documentation             | API Docs |
 |----------|-----------------------|-------------------|------------------------------------|----------|
-| Python   | linux, macOS, Windows | payjoin           | [Readme payjoin](python/README.md) |          |
+| Python   | linux, macOS | payjoin           | [Readme payjoin](python/README.md) |          |
 
 ## Minimum Supported Rust Version (MSRV)
 

python/.gitignore

@@ -8,4 +8,13 @@ __pycache__/
 *.swp
 *.whl
 build/
-venv
+venv
+
+# Auto-generated shared libraries
+*.dylib
+*.so
+*.dll
+
+# Auto-generated bindings python file
+src/payjoin/payjoin_ffi.py
+src/payjoin/bitcoin.py

python/requirements-dev.txt

@@ -1 +1,2 @@
-python-bitcoinlib==0.12.2
+python-bitcoinlib==0.12.2
+toml==0.10.2

python/scripts/bindgen_generate.sh

@@ -2,11 +2,9 @@
 
 #!/bin/bash
 chmod +x ./scripts/generate_linux.sh
-chmod +x ./scripts/generate_windows.sh
 chmod +x ./scripts/generate_macos.sh
 
 
 # Run each script
 scripts/generate_linux.sh
-scripts/generate_windows.sh
 scripts/generate_macos.sh

python/scripts/generate_linux.sh

@@ -1,14 +1,14 @@
 #!/usr/bin/env bash
 set -euo pipefail
-python3 --version
-pip install --user -r requirements.txt
+${PYBIN}/python --version
+${PYBIN}/pip install -r requirements.txt -r requirements-dev.txt
 LIBNAME=libpayjoin_ffi.so
 LINUX_TARGET=x86_64-unknown-linux-gnu
 
 echo "Generating payjoin_ffi.py..."
 cd ../
-cargo run --features uniffi --bin uniffi-bindgen generate src/payjoin_ffi.udl --language python --out-dir python/src/payjoin/
-
+cargo build --profile release --features uniffi
+cargo run --profile release --features uniffi --bin uniffi-bindgen generate --library target/release/$LIBNAME --language python --out-dir python/src/payjoin/
 
 echo "Generating native binaries..."
 rustup target add $LINUX_TARGET

python/scripts/generate_macos.sh

@@ -2,21 +2,21 @@
 
 set -euo pipefail
 python3 --version
-pip install --user -r requirements.txt
+pip install -r requirements.txt -r requirements-dev.txt
 LIBNAME=libpayjoin_ffi.dylib
 
 echo "Generating payjoin_ffi.py..."
 cd ../
-cargo run --features uniffi --bin uniffi-bindgen generate src/payjoin_ffi.udl --language python --out-dir python/src/payjoin/
-
+cargo build --features uniffi --profile release 
+cargo run --features uniffi --profile release --bin uniffi-bindgen generate --library target/release/$LIBNAME --language python --out-dir python/src/payjoin/
 
 echo "Generating native binaries..."
 rustup target add aarch64-apple-darwin x86_64-apple-darwin
 
 cargo build --profile release-smaller --target aarch64-apple-darwin --features uniffi
 echo "Done building aarch64-apple-darwin"
 
-cargo build --profile release-smaller --target x86_64-apple-darwin
+cargo build --profile release-smaller --target x86_64-apple-darwin --features uniffi
 echo "Done building x86_64-apple-darwin"
 
 echo "Building macos fat library"

python/setup.py

@@ -1,6 +1,13 @@
 #!/usr/bin/env python
 
+import os
 from setuptools import setup, find_packages
+import toml
+
+# Read version from Cargo.toml
+cargo_toml_path = os.path.join(os.path.dirname(__file__), '..', 'Cargo.toml')
+cargo_toml = toml.load(cargo_toml_path)
+version = cargo_toml['package']['version']
 
 LONG_DESCRIPTION = """# payjoin
 This repository creates libraries for various programming languages, all using the Rust-based [Payjoin](https://github.com/payjoin/rust-payjoin) 
@@ -25,7 +32,7 @@
     zip_safe=False,
     packages=["payjoin"],
     package_dir={"payjoin": "./src/payjoin"},
-    version="0.20.0",
+    version=version,
     license="MIT or Apache 2.0",
     has_ext_modules=lambda: True,
 )