Adding Python library to client

.github/workflows/CI.yaml

@@ -0,0 +1,234 @@
+# This file is autogenerated by maturin v1.7.0
+# To update, run
+#
+#    maturin generate-ci github
+#
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - master
+    tags:
+      - '*'
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  unit_test:
+    name: Unit tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+      - run: cargo test --all-features
+  rust_integration_test:
+    name: Rust Integration test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: cd tests/rust-test && ./test.sh
+  python_integration_test:
+    name: Python Integration test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: getsentry/[email protected]
+        id: venv
+        with:
+          python-version: 3.10.7
+      - run: cd tests/python-sync && ./test.sh
+  linux:
+    runs-on: ${{ matrix.platform.runner }}
+    defaults:
+      run:
+        working-directory: ./szurubooru-client
+    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: 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: -F python --release --out dist --find-interpreter -m szurubooru-client/Cargo.toml
+          sccache: 'true'
+          manylinux: auto
+          before-script-linux: |
+            # If we're running on rhel centos, install needed packages.
+            if command -v yum &> /dev/null; then
+                yum update -y && yum install -y perl-core openssl openssl-devel pkgconfig libatomic
+
+                # If we're running on i686 we need to symlink libatomic
+                # in order to build openssl with -latomic flag.
+                if [[ ! -d "/usr/lib64" ]]; then
+                    ln -s /usr/lib/libatomic.so.1 /usr/lib/libatomic.so
+                fi
+            else
+                # If we're running on debian-based system.
+                apt update -y && apt-get install -y libssl-dev openssl pkg-config
+            fi
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-linux-${{ matrix.platform.target }}
+          path: dist
+
+  musllinux:
+    runs-on: ${{ matrix.platform.runner }}
+    defaults:
+      run:
+        working-directory: ./szurubooru-client
+    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: -F python --release --out dist --find-interpreter -m szurubooru-client/Cargo.toml
+          sccache: 'true'
+          manylinux: musllinux_1_2
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-musllinux-${{ matrix.platform.target }}
+          path: dist
+
+  windows:
+    runs-on: ${{ matrix.platform.runner }}
+    defaults:
+      run:
+        working-directory: ./szurubooru-client
+    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: -F python --release --out dist --find-interpreter -m szurubooru-client/Cargo.toml
+          sccache: 'true'
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-windows-${{ matrix.platform.target }}
+          path: dist
+
+  macos:
+    runs-on: ${{ matrix.platform.runner }}
+    defaults:
+      run:
+        working-directory: ./szurubooru-client
+    strategy:
+      matrix:
+        platform:
+          - runner: macos-12
+            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: -F python --release --out dist --find-interpreter -m szurubooru-client/Cargo.toml
+          sccache: 'true'
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-macos-${{ matrix.platform.target }}
+          path: dist
+
+  sdist:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./szurubooru-client
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build sdist
+        uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: --out dist -m szurubooru-client/Cargo.toml
+      - name: Upload sdist
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-sdist
+          path: dist
+
+  python_release:
+   name: Python Release
+   runs-on: ubuntu-latest
+   if: "startsWith(github.ref, 'refs/tags/')"
+   needs: [linux, musllinux, windows, macos, sdist]
+   steps:
+     - uses: actions/download-artifact@v4
+     - 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 wheels-*/*
+  crate_release:
+    name: Crates.io Release
+    runs-on: ubuntu-latest
+    if: "startsWith(github.ref, 'refs/tags/')"
+    needs: [linux, musllinux, windows, macos, sdist]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Cargo publish
+        run: cargo publish --token ${CRATES_TOKEN}
+        env:
+          CRATES_TOKEN: ${{ secrets.CRATES_TOKEN }}

.gitignore

@@ -5,3 +5,7 @@ szurubooru-integration-test/szurubooru/data/*
 szurubooru-integration-test/szurubooru/pgsql/*
 szurubooru-integration-test/szurubooru/server/*
 **/.DS_Store
+**/target
+*.so
+*.pyc
+/docs/_build/**

CHANGELOG.md

@@ -1,3 +1,21 @@
+## v0.5.0 (2024-09-05)
+
+### Feat
+
+- **all**: adding python library wrapper
+
+### Fix
+
+- **python**: refactoring python client
+- **cargo**: adding vendored openssl to help with build
+- **python-client**: fixing paged search results to use a PyList instead
+
+### Refactor
+
+- **python**: adding custom python modules to possibly help with documentation
+- **models**: removing unnecessary python classes
+- **models**: saving some changes in prep of python library
+
 ## v0.4.0 (2024-08-12)
 
 ### Feat