Replace pip with uv in payjoin-ffi/python (#1073)

Author: spacebear21

.github/workflows/python.yml

@@ -27,22 +27,26 @@ jobs:
       - name: "Install Rust 1.85.0"
         uses: dtolnay/rust-toolchain@1.85.0
 
-      - name: "Install Python"
-        uses: actions/setup-python@v4
-        with:
-          python-version: 3.12
-
       - name: "Use cache"
         uses: Swatinem/rust-cache@v2
 
+      - name: Install a specific version of uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: "0.8.2"
+          enable-cache: true
+
+      - name: "uv sync"
+        run: uv sync --all-extras
+
       - name: "Generate payjoin-ffi.py and binaries"
         run: bash ./scripts/generate_bindings.sh
 
       - name: "Build wheel"
-        run: python -m build --wheel
+        run: uv build --wheel
 
       - name: "Install wheel"
-        run: pip install ./dist/*.whl
+        run: uv run pip install ./dist/*.whl
 
       - name: "Run tests"
-        run: python -m unittest -v
+        run: uv run python -m unittest --verbose

payjoin-ffi/python/.gitignore

@@ -8,7 +8,7 @@ __pycache__/
 *.swp
 *.whl
 build/
-venv
+.venv
 
 # Auto-generated shared libraries
 *.dylib

payjoin-ffi/python/README.md

@@ -8,46 +8,51 @@ Grab the latest release with a simple:
 
 ```shell
 pip install payjoin
+
+# Or, for uv:
+uv add payjoin
 ```
 
 ## Running Tests
 
 Follow these steps to clone the repository and run the tests.
 
-
 ```shell
-git clone https://github.com/payjoin/rust-payjoin.git
-cd rust-payjoin/payjoin-ffi/python
+# Ensure you have uv installed:
+# https://docs.astral.sh/uv/getting-started/installation/
 
-# Setup a python virtual environment
-python -m venv venv
-source venv/bin/activate
+# Setup virtual environment/install all packages (including developer packages)
+uv sync --all-extras
 
-PYBIN="./venv/bin/" bash ./scripts/generate_bindings.sh
+bash ./scripts/generate_bindings.sh
 
 # Build the wheel
-python -m build --wheel
+uv build --wheel
 
-# Force reinstall payjoin
-pip install ./dist/payjoin-<version>.whl --force-reinstall
+# Force reinstall payjoin with <version>
+uv pip install ./dist/payjoin-*.whl --force-reinstall
 
 # Run all tests
-python -m unittest --verbose
+uv run python -m unittest --verbose
 ```
 
-Note that you'll need Docker to run the integration tests. If you get a "Failed to start container" error, ensure the Docker engine is running on your machine.
-You can [filter which tests](https://docs.python.org/3/library/unittest.html#command-line-interface) to run by passing a file or test name as argument.
-
 ## Building the Package
 
 ```shell
-# Setup a python virtual environment
-python -m venv venv
-source venv/bin/activate
+# Setup virtual environment/install packages for release
+uv sync --all-extras
 
-PYBIN="./venv/bin/" bash ./scripts/generate_bindings.sh
+bash ./scripts/generate_bindings.sh
 
 # Build the wheel
-python -m build --wheel
+uv build --wheel
 
+# Force reinstall payjoin with <version>
+uv pip install ./dist/payjoin-*.whl --force-reinstall
+
+# Example:
+# uv pip install ./dist/payjoin-0.24.0-cp313-cp313-linux_x86_64.whl
+
+# Run all tests
+uv run python -m unittest --verbose
 ```

payjoin-ffi/python/pyproject.toml

@@ -6,9 +6,17 @@ build-backend = "setuptools.build_meta"
 name = "payjoin"
 description = "The Python language bindings for the Payjoin Dev Kit"
 readme = "README.md"
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 license = "MIT"
 dynamic = ["version"]
+dependencies = [
+    "build==1.3.0",
+    "semantic-version==2.9.0",
+    "setuptools==78.1.1",
+    "typing-extensions==4.0.1",
+    "wheel==0.38.4",
+    "httpx==0.28.1",
+]
 
 [tool.setuptools]
 packages = ["payjoin"]
@@ -19,3 +27,9 @@ include-package-data = true
 pythonpath = [
   "."
 ]
+
+[dependency-groups]
+dev = [
+    "toml==0.10.2",
+    "yapf==0.43.0",
+]

payjoin-ffi/python/requirements-dev.txt

@@ -8,19 +8,15 @@ echo "Running on $OS"
 # Install Rust targets if on macOS
 if [[ "$OS" == "Darwin" ]]; then
     LIBNAME=libpayjoin_ffi.dylib
-    python3 --version
-    pip install -r requirements.txt -r requirements-dev.txt
 elif [[ "$OS" == "Linux" ]]; then
     LIBNAME=libpayjoin_ffi.so
-    PYBIN=$(dirname $(which python))
-    PYBIN="$PYBIN" 
-    ${PYBIN}/python --version
-    ${PYBIN}/pip install -r requirements.txt -r requirements-dev.txt
 else
     echo "Unsupported os: $OS"
     exit 1
 fi
 
+uv run python --version
+
 cd ../
 # This is a test script the actual release should not include the test utils feature
 cargo build --features _test-utils --profile dev 

payjoin-ffi/python/requirements.txt

@@ -16,9 +16,12 @@
 ## Install the package
 ```shell
 pip install payjoin
+
+# Or, if using uv
+uv add payjoin
 ```
 
-## Usage 
+## Usage
 ```python
 import payjoin as payjoin
 """