feat: Add Python bindings

.github/workflows/bindings.yml → .github/workflows/c-bindings.yml

@@ -2,7 +2,7 @@ on:
   release:
     types:
       - published
-name: Publish bindings
+name: Publish C bindings
 jobs:
   build-binaries:
     if: startsWith(github.ref_name, 'accesskit_c-v')

.github/workflows/ci.yml

@@ -28,6 +28,9 @@ jobs:
           clang-format-version: 15
           check-path: bindings/c
 
+      - name: black --check
+        uses: psf/black@stable
+
   test:
     runs-on: ${{ matrix.os }}
     strategy:

.github/workflows/python-bindings.yml

@@ -0,0 +1,76 @@
+on:
+  push:
+    tags:
+      - 'accesskit_python-v*'
+
+name: Publish Python bindings
+
+jobs:
+  build-wheels:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        include:
+          - os: macos-latest
+            python-arch: x64
+            rust-target: x86_64
+          - os: macos-latest
+            python-arch: x64
+            rust-target: universal2-apple-darwin
+          - os: ubuntu-latest
+            python-arch: x64
+            rust-target: x86_64
+          - os: ubuntu-latest
+            python-arch: x64
+            rust-target: i686
+            skip-wheel-installation: true
+          - os: windows-latest
+            python-arch: x64
+            rust-target: x64
+          - os: windows-latest
+            python-arch: x86
+            rust-target: x86
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.7
+          architecture: ${{ matrix.python-arch }}
+      - uses: dtolnay/rust-toolchain@stable
+      - name: Build wheel
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.rust-target }}
+          manylinux: auto
+          args: --release --out dist --sdist
+      - name: Test wheel installation
+        if: matrix.skip-wheel-installation != true
+        run: |
+          pip install accesskit --no-index --find-links dist --force-reinstall
+          python -c "import accesskit"
+      - name: Upload wheel
+        uses: actions/upload-artifact@v3
+        with:
+          name: wheels
+          path: dist
+
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    if: "startsWith(github.ref, 'refs/tags/')"
+    needs: [build-wheels]
+    steps:
+      - uses: actions/download-artifact@v3
+        with:
+          name: wheels
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+        run: |
+          pip install --upgrade twine
+          twine upload --skip-existing *

Cargo.toml

@@ -8,12 +8,14 @@ members = [
     "platforms/windows",
     "platforms/winit",
     "bindings/c",
+    "bindings/python",
 ]
 default-members = [
     "common",
     "consumer",
     "platforms/winit",
     "bindings/c",
+    "bindings/python",
 ]
 
 [profile.release]

README.md

@@ -56,7 +56,11 @@ While we expect GUI toolkit developers to eventually integrate AccessKit into th
 
 ### Language bindings
 
-UI toolkit developers who merely want to use AccessKit should not be required to use Rust directly. In addition to a direct Rust API, AccessKit provides a C API covering both the core data structures and all platform adapters. This C API can be used from a variety of languages. The Rust source for the C bindings is in [the `bindings/c directory`](https://github.com/AccessKit/accesskit/tree/main/bindings/c). The AccessKit project also provides a pre-built package, including a header file, both dynamic and static libraries, and sample code, for the C API, so toolkit developers won't need to deal with Rust at all. The latest pre-built package can be found in [AccessKit's GitHub releases](https://github.com/AccessKit/accesskit/releases); search for the name "accesskit_c".
+UI toolkit developers who merely want to use AccessKit should not be required to use Rust directly.
+
+AccessKit provides a C API covering both the core data structures and all platform adapters. This C API can be used from a variety of languages. The Rust source for the C bindings is in [the `bindings/c directory`](https://github.com/AccessKit/accesskit/tree/main/bindings/c). The AccessKit project also provides a pre-built package, including a header file, both dynamic and static libraries, and sample code, for the C API, so toolkit developers won't need to deal with Rust at all. The latest pre-built package can be found in [AccessKit's GitHub releases](https://github.com/AccessKit/accesskit/releases); search for the name "accesskit_c".
+
+Bindings for the Python programming language are also available. Rust source code is in [the `bindings/python directory`](https://github.com/AccessKit/accesskit/tree/main/bindings/python). Releases can be found on [PyPI](https://pypi.org/project/accesskit/) and can be included in your project using `pip`.
 
 While many languages can use a C API, we also plan to provide libraries that make it easier to safely use AccessKit from languages other than Rust and C. In particular, we're planning to provide such a library for Java and other JVM-based languages.
 

bindings/python/.cargo/config.toml

@@ -0,0 +1,11 @@
+[target.aarch64-apple-darwin]
+rustflags = [
+  "-C", "link-arg=-undefined",
+  "-C", "link-arg=dynamic_lookup",
+]
+
+[target.x86_64-apple-darwin]
+rustflags = [
+  "-C", "link-arg=-undefined",
+  "-C", "link-arg=dynamic_lookup",
+]

bindings/python/Cargo.toml

@@ -0,0 +1,30 @@
+[package]
+name = "accesskit_python"
+version = "0.1.0"
+authors = ["Arnold Loubriat <[email protected]>"]
+license = "MIT OR Apache-2.0"
+description = "Python bindings to the AccessKit library"
+readme = "README.md"
+publish = false
+edition = "2021"
+
+[lib]
+name = "accesskit"
+crate-type = ["cdylib"]
+doc = false
+
+[features]
+extension-module = ["pyo3/extension-module"]
+
+[dependencies]
+accesskit = { version = "0.12.0", path = "../../common", features = ["pyo3"] }
+pyo3 = { version = "0.20", features = ["abi3-py37", "multiple-pymethods"] }
+
+[target.'cfg(target_os = "windows")'.dependencies]
+accesskit_windows = { version = "0.15.0", path = "../../platforms/windows" }
+
+[target.'cfg(target_os = "macos")'.dependencies]
+accesskit_macos = { version = "0.10.0", path = "../../platforms/macos" }
+
+[target.'cfg(any(target_os = "linux", target_os = "dragonfly", target_os = "freebsd", target_os = "openbsd", target_os = "netbsd"))'.dependencies]
+accesskit_unix = { version = "0.6.0", path = "../../platforms/unix" }

bindings/python/README.md

@@ -0,0 +1,3 @@
+# AccessKit
+
+These are the bindings to use AccessKit from Python.