name: Python Bindings CI
on:
push:
branches:
- main
tags:
- 'python-v*'
paths:
- 'python/**'
- 'src/**'
- 'crates/**'
- 'Cargo.toml'
- 'Cargo.lock'
- '.github/workflows/python.yml'
pull_request:
branches:
- main
paths:
- 'python/**'
- 'src/**'
- 'crates/**'
- 'Cargo.toml'
- 'Cargo.lock'
- '.github/workflows/python.yml'
workflow_dispatch:
permissions:
contents: read
jobs:
test:
name: Test Python API
runs-on: ubuntu-latest
defaults:
run:
working-directory: ./python
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Validate package versions and release tag
shell: bash
run: |
python - <<'PY'
import os
import tomllib
from pathlib import Path
cargo_version = tomllib.loads(Path("Cargo.toml").read_text())["package"]["version"]
project = tomllib.loads(Path("pyproject.toml").read_text())["project"]
project_version = project.get("version")
if project_version is not None and cargo_version != project_version:
raise SystemExit(
f"Cargo.toml ({cargo_version}) and pyproject.toml ({project_version}) versions differ"
)
if project_version is None and "version" not in project.get("dynamic", []):
raise SystemExit("pyproject.toml must define or dynamically source the package version")
if os.environ.get("GITHUB_REF_TYPE") == "tag":
expected_tag = f"python-v{cargo_version}"
actual_tag = os.environ["GITHUB_REF_NAME"]
if actual_tag != expected_tag:
raise SystemExit(f"release tag {actual_tag!r} must be {expected_tag!r}")
PY
- name: Build test wheel
uses: PyO3/maturin-action@v1
with:
args: --release --out dist --find-interpreter
working-directory: ./python
- name: Install test wheel
run: python -m pip install --force-reinstall dist/*.whl
- name: Run Python API tests
run: python -m unittest discover -s tests -v
linux:
needs: test
if: github.event_name == 'workflow_dispatch' || startsWith(github.ref, 'refs/tags/python-v')
runs-on: ${{ matrix.platform.runner }}
defaults:
run:
working-directory: ./python
strategy:
matrix:
platform:
- runner: ubuntu-latest
target: x86_64
- runner: ubuntu-latest
target: x86
- runner: ubuntu-latest
target: aarch64
- runner: ubuntu-latest
target: armv7
- runner: ubuntu-latest
target: s390x
- runner: ubuntu-latest
target: ppc64le
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: 3.x
- name: Build wheels
uses: PyO3/maturin-action@v1
with:
target: ${{ matrix.platform.target }}
args: --release --out dist --find-interpreter
sccache: 'true'
manylinux: auto
working-directory: ./python
- name: Upload wheels
uses: actions/upload-artifact@v4
with:
name: wheels-linux-${{ matrix.platform.target }}
path: ./python/dist
musllinux:
needs: test
if: github.event_name == 'workflow_dispatch' || startsWith(github.ref, 'refs/tags/python-v')
runs-on: ${{ matrix.platform.runner }}
defaults:
run:
working-directory: ./python
strategy:
matrix:
platform:
- runner: ubuntu-latest
target: x86_64
- runner: ubuntu-latest
target: x86
- runner: ubuntu-latest
target: aarch64
- runner: ubuntu-latest
target: armv7
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: 3.x
- name: Build wheels
uses: PyO3/maturin-action@v1
with:
target: ${{ matrix.platform.target }}
args: --release --out dist --find-interpreter
sccache: 'true'
manylinux: musllinux_1_2
working-directory: ./python
- name: Upload wheels
uses: actions/upload-artifact@v4
with:
name: wheels-musllinux-${{ matrix.platform.target }}
path: ./python/dist
windows:
needs: test
if: github.event_name == 'workflow_dispatch' || startsWith(github.ref, 'refs/tags/python-v')
runs-on: ${{ matrix.platform.runner }}
defaults:
run:
working-directory: ./python
strategy:
matrix:
platform:
- runner: windows-latest
target: x64
- runner: windows-latest
target: x86
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: 3.x
architecture: ${{ matrix.platform.target }}
- name: Build wheels
uses: PyO3/maturin-action@v1
with:
target: ${{ matrix.platform.target }}
args: --release --out dist --find-interpreter
sccache: 'true'
working-directory: ./python
- name: Upload wheels
uses: actions/upload-artifact@v4
with:
name: wheels-windows-${{ matrix.platform.target }}
path: ./python/dist
macos:
needs: test
if: github.event_name == 'workflow_dispatch' || startsWith(github.ref, 'refs/tags/python-v')
runs-on: ${{ matrix.platform.runner }}
defaults:
run:
working-directory: ./python
strategy:
matrix:
platform:
- runner: macos-14
target: x86_64
- runner: macos-14
target: aarch64
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: 3.x
- name: Build wheels
uses: PyO3/maturin-action@v1
with:
target: ${{ matrix.platform.target }}
args: --release --out dist --find-interpreter
sccache: 'true'
working-directory: ./python
- name: Upload wheels
uses: actions/upload-artifact@v4
with:
name: wheels-macos-${{ matrix.platform.target }}
path: ./python/dist
sdist:
needs: test
if: github.event_name == 'workflow_dispatch' || startsWith(github.ref, 'refs/tags/python-v')
runs-on: ubuntu-latest
defaults:
run:
working-directory: ./python
steps:
- uses: actions/checkout@v4
- name: Build sdist
uses: PyO3/maturin-action@v1
with:
command: sdist
args: --out dist
working-directory: ./python
- name: Upload sdist
uses: actions/upload-artifact@v4
with:
name: wheels-sdist
path: ./python/dist
release:
name: Release
runs-on: ubuntu-latest
if: startsWith(github.ref, 'refs/tags/python-v')
needs: [linux, musllinux, windows, macos, sdist]
steps:
- uses: actions/download-artifact@v4
with:
path: ./python/dist
merge-multiple: true
- name: Publish to PyPI
uses: PyO3/maturin-action@v1
env:
MATURIN_PYPI_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
with:
command: upload
args: --non-interactive --skip-existing dist/*
working-directory: ./python