clams-python 1.5.0__tar.gz → 1.6.0__tar.gz

clams_python-1.6.0/.github/workflows/codecov.yml

@@ -0,0 +1,18 @@
+name: "🧪 Test"
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
+    branches:
+      - main
+      - develop
+jobs:
+  test-and-codecov:
+    name: "🤙 Call SDK test workflow"
+    uses: clamsproject/.github/.github/workflows/sdk-codecov-pyproj.yml@main
+    secrets:
+      CC_REPO_UPLOAD_TOKEN: ${{ secrets.CODECOV_UPLOAD_TOKEN_CLAMS_PYTHON }}
+

clams_python-1.6.0/.github/workflows/container.yml

@@ -0,0 +1,185 @@
+name: "♻️,🏋 Build an image and upload to ghcr"
+
+on:
+  workflow_call:
+    inputs:
+      version:
+        required: true
+        type: string
+        description: 'clams-python SDK version'
+      buildfilename:
+        required: true
+        type: string
+        description: 'name of the container build file to use'
+      ref:
+        required: false
+        type: string
+        description: 'git ref to checkout (defaults to version)'
+  workflow_dispatch:
+    inputs:
+      version:
+        required: true
+        type: string
+        description: 'clams-python SDK version'
+      buildfilename:
+        required: true
+        type: string
+        description: 'name of the container build file to use'
+      ref:
+        required: false
+        type: string
+        description: 'git ref to checkout (defaults to version)'
+
+env:
+  REGISTRY: ghcr.io
+
+jobs:
+  build:
+    name: "🐳 Build (${{ matrix.platform }})"
+    runs-on: ${{ matrix.runner }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - platform: linux/amd64
+            runner: ubuntu-latest
+          - platform: linux/arm64
+            runner: ubuntu-24.04-arm
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - name: "🔧 Prepare"
+      id: prepare
+      run: |
+        platform=${{ matrix.platform }}
+        echo "pair=${platform//\//-}" >> $GITHUB_OUTPUT
+        slug=$(echo "${{ inputs.buildfilename }}" | sed 's|[^a-zA-Z0-9]|-|g; s/^-*//; s/-*$//')
+        echo "slug=${slug}" >> $GITHUB_OUTPUT
+
+    - name: "🛍️ Checkout repository"
+      uses: actions/checkout@v5
+      with:
+        ref: ${{ inputs.ref || inputs.version }}
+
+    - name: "👷 Set up Docker Buildx"
+      uses: docker/setup-buildx-action@v3
+
+    - name: "🏷 Prepare OCI annotations"
+      id: getlabels
+      run: |
+        EOF=$(dd if=/dev/urandom bs=15 count=1 status=none | base64)
+        echo "EXISTING_LABELS<<$EOF" >> $GITHUB_ENV
+        cat ${{ inputs.buildfilename }} | grep LABEL | sed -E 's/^LABEL\s+([^=]+)="?(.+)("|$)/\1=\2/g' >> $GITHUB_ENV
+        echo "$EOF" >> $GITHUB_ENV
+        echo $EXISTING_LABELS
+
+    - name: "🏷 Get image build context"
+      id: getcontext
+      run: |
+        echo "CONTEXT=$(dirname ${{ inputs.buildfilename }})" >> $GITHUB_ENV
+
+    - name: "🏷 Get image name suffix"
+      id: getsuffix
+      run: |
+        export filename=$(basename ${{ inputs.buildfilename }})
+        export nameonly="${filename%.*}"
+        if [ ${nameonly} == ${filename} ]; then echo "SUFFIX=" >> $GITHUB_ENV ; else echo "SUFFIX=-${nameonly}" >> $GITHUB_ENV; fi
+
+    - name: "🏷 Prepare docker labels"
+      id: meta
+      uses: docker/metadata-action@v5
+      with:
+        images: ${{ env.REGISTRY }}/${{ github.repository }}${{ env.SUFFIX }}
+        labels: |
+          ${{ env.EXISTING_LABELS }}
+
+    - name: "🔏 Log in to registry"
+      uses: docker/login-action@v3
+      with:
+        registry: ${{ env.REGISTRY }}
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: "🏗 Build and push by digest"
+      id: build
+      uses: docker/build-push-action@v6
+      with:
+        context: ${{ env.CONTEXT }}
+        platforms: ${{ matrix.platform }}
+        file: ${{ inputs.buildfilename }}
+        labels: ${{ env.DOCKER_METADATA_OUTPUT_LABELS }}
+        build-args: |
+          clams_version=${{ inputs.version }}
+        outputs: type=image,"name=${{ env.REGISTRY }}/${{ github.repository }}${{ env.SUFFIX }}",push-by-digest=true,name-canonical=true,push=true
+
+    - name: "📤 Export digest"
+      run: |
+        mkdir -p /tmp/digests
+        digest="${{ steps.build.outputs.digest }}"
+        touch "/tmp/digests/${digest#sha256:}"
+
+    - name: "📦 Upload digest"
+      uses: actions/upload-artifact@v4
+      with:
+        name: digests-${{ steps.prepare.outputs.slug }}-${{ steps.prepare.outputs.pair }}
+        path: /tmp/digests/*
+        if-no-files-found: error
+        retention-days: 1
+
+  merge:
+    name: "🔗 Create multi-platform manifest"
+    runs-on: ubuntu-latest
+    needs: build
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - name: "🔧 Prepare"
+      id: prepare
+      run: |
+        slug=$(echo "${{ inputs.buildfilename }}" | sed 's|[^a-zA-Z0-9]|-|g; s/^-*//; s/-*$//')
+        echo "slug=${slug}" >> $GITHUB_OUTPUT
+
+    - name: "🏷 Get image name suffix"
+      id: getsuffix
+      run: |
+        export filename=$(basename ${{ inputs.buildfilename }})
+        export nameonly="${filename%.*}"
+        if [ ${nameonly} == ${filename} ]; then echo "SUFFIX=" >> $GITHUB_ENV ; else echo "SUFFIX=-${nameonly}" >> $GITHUB_ENV; fi
+
+    - name: "📥 Download digests"
+      uses: actions/download-artifact@v4
+      with:
+        path: /tmp/digests
+        pattern: digests-${{ steps.prepare.outputs.slug }}-*
+        merge-multiple: true
+
+    - name: "👷 Set up Docker Buildx"
+      uses: docker/setup-buildx-action@v3
+
+    - name: "🏷 Prepare docker tags"
+      id: meta
+      uses: docker/metadata-action@v5
+      with:
+        images: ${{ env.REGISTRY }}/${{ github.repository }}${{ env.SUFFIX }}
+        tags: |
+          type=pep440,pattern={{version}},value=${{ inputs.version }}
+          type=ref,event=tag
+          type=ref,event=pr
+
+    - name: "🔏 Log in to registry"
+      uses: docker/login-action@v3
+      with:
+        registry: ${{ env.REGISTRY }}
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: "🔗 Create manifest list and push"
+      working-directory: /tmp/digests
+      run: |
+        docker buildx imagetools create \
+          $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \
+          $(printf '${{ env.REGISTRY }}/${{ github.repository }}${{ env.SUFFIX }}@sha256:%s ' *)

clams_python-1.6.0/.github/workflows/containers.yml

@@ -0,0 +1,216 @@
+# This file is auto-generated. Do not edit manually.
+
+name: "📦 Publish (base images)"
+
+on:
+  push:
+    tags:
+      - '[0-9]+.[0-9]+.[0-9]+'
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'version to tag images'
+        required: true
+
+jobs:
+  set-version:
+    runs-on: ubuntu-latest
+    name: "🏷 Set version value"
+    outputs:
+      version: ${{ steps.output_version.outputs.version }}
+    steps:
+    - name: "📌 Set VERSION value from dispatch inputs"
+      id: get_version_dispatch
+      if: ${{ github.event_name == 'workflow_dispatch' }}
+      run: echo "VERSION=${{ github.event.inputs.version }}" >> $GITHUB_ENV
+    - name: "📌 Set VERSION value from pushed tag"
+      id: get_version_tag
+      if: ${{ github.event_name == 'push' }}
+      run: echo "VERSION=$(echo "${{ github.ref }}" | cut -d/ -f3)" >> $GITHUB_ENV
+    - name: "🏷 Record VERSION for follow-up jobs"
+      id: output_version
+      run: |
+        echo "version=${{ env.VERSION }}" >> $GITHUB_OUTPUT
+  check-deployment:
+    name: "✅ PyPI deployment check"
+    runs-on: ubuntu-latest
+    needs: ['set-version']
+    steps:
+    - name: "⏱️ Wait up to 20 minutes for the new clams-python is deployed on PyPI"
+      uses: nev7n/wait_for_response@v1
+      with:
+        url: "https://pypi.org/pypi/clams-python/${{ needs.set-version.outputs.version }}/json"
+        responseCode: 200
+        timeout: 1200000
+        interval: 5000
+
+  call-build-base:
+    name: "🤙 Call container workflow with the base"
+    needs: ['set-version', 'check-deployment']
+    uses: ./.github/workflows/container.yml
+    secrets: inherit
+    with:
+      buildfilename: './container/Containerfile'
+      version: ${{ needs.set-version.outputs.version }}
+
+  call-build-ffmpeg:
+    name: "🤙 Call container workflow with `ffmpeg`"
+    needs: ['set-version', 'call-build-base']
+    uses: ./.github/workflows/container.yml
+    secrets: inherit
+    with:
+      buildfilename: './container/ffmpeg.containerfile'
+      version: ${{ needs.set-version.outputs.version }}
+
+  call-build-jdk8:
+    name: "🤙 Call container workflow with `jdk8`"
+    needs: ['set-version', 'call-build-base']
+    uses: ./.github/workflows/container.yml
+    secrets: inherit
+    with:
+      buildfilename: './container/jdk8.containerfile'
+      version: ${{ needs.set-version.outputs.version }}
+
+  call-build-tf2:
+    name: "🤙 Call container workflow with `tf2`"
+    needs: ['set-version', 'call-build-base']
+    uses: ./.github/workflows/container.yml
+    secrets: inherit
+    with:
+      buildfilename: './container/tf2.containerfile'
+      version: ${{ needs.set-version.outputs.version }}
+
+  call-build-torch2:
+    name: "🤙 Call container workflow with `torch2`"
+    needs: ['set-version', 'call-build-base']
+    uses: ./.github/workflows/container.yml
+    secrets: inherit
+    with:
+      buildfilename: './container/torch2.containerfile'
+      version: ${{ needs.set-version.outputs.version }}
+
+  call-build-ffmpeg-tf2:
+    name: "🤙 Call container workflow with `ffmpeg-tf2`"
+    needs: ['set-version', 'call-build-ffmpeg']
+    uses: ./.github/workflows/container.yml
+    secrets: inherit
+    with:
+      buildfilename: './container/ffmpeg-tf2.containerfile'
+      version: ${{ needs.set-version.outputs.version }}
+
+  call-build-ffmpeg-torch2:
+    name: "🤙 Call container workflow with `ffmpeg-torch2`"
+    needs: ['set-version', 'call-build-ffmpeg']
+    uses: ./.github/workflows/container.yml
+    secrets: inherit
+    with:
+      buildfilename: './container/ffmpeg-torch2.containerfile'
+      version: ${{ needs.set-version.outputs.version }}
+
+  call-build-opencv4:
+    name: "🤙 Call container workflow with `opencv4`"
+    needs: ['set-version', 'call-build-ffmpeg']
+    uses: ./.github/workflows/container.yml
+    secrets: inherit
+    with:
+      buildfilename: './container/opencv4.containerfile'
+      version: ${{ needs.set-version.outputs.version }}
+
+  call-build-hf:
+    name: "🤙 Call container workflow with `hf`"
+    needs: ['set-version', 'call-build-hf5']
+    uses: ./.github/workflows/container.yml
+    secrets: inherit
+    with:
+      buildfilename: './container/hf.containerfile'
+      version: ${{ needs.set-version.outputs.version }}
+
+  call-build-opencv4-tf2:
+    name: "🤙 Call container workflow with `opencv4-tf2`"
+    needs: ['set-version', 'call-build-opencv4']
+    uses: ./.github/workflows/container.yml
+    secrets: inherit
+    with:
+      buildfilename: './container/opencv4-tf2.containerfile'
+      version: ${{ needs.set-version.outputs.version }}
+
+  call-build-opencv4-torch2:
+    name: "🤙 Call container workflow with `opencv4-torch2`"
+    needs: ['set-version', 'call-build-opencv4']
+    uses: ./.github/workflows/container.yml
+    secrets: inherit
+    with:
+      buildfilename: './container/opencv4-torch2.containerfile'
+      version: ${{ needs.set-version.outputs.version }}
+
+  call-build-hf4:
+    name: "🤙 Call container workflow with `hf4`"
+    needs: ['set-version', 'call-build-torch2']
+    uses: ./.github/workflows/container.yml
+    secrets: inherit
+    with:
+      buildfilename: './container/hf4.containerfile'
+      version: ${{ needs.set-version.outputs.version }}
+
+  call-build-hf5:
+    name: "🤙 Call container workflow with `hf5`"
+    needs: ['set-version', 'call-build-torch2']
+    uses: ./.github/workflows/container.yml
+    secrets: inherit
+    with:
+      buildfilename: './container/hf5.containerfile'
+      version: ${{ needs.set-version.outputs.version }}
+
+  call-build-ffmpeg-hf:
+    name: "🤙 Call container workflow with `ffmpeg-hf`"
+    needs: ['set-version', 'call-build-ffmpeg-hf5']
+    uses: ./.github/workflows/container.yml
+    secrets: inherit
+    with:
+      buildfilename: './container/ffmpeg-hf.containerfile'
+      version: ${{ needs.set-version.outputs.version }}
+
+  call-build-ffmpeg-hf4:
+    name: "🤙 Call container workflow with `ffmpeg-hf4`"
+    needs: ['set-version', 'call-build-ffmpeg-torch2']
+    uses: ./.github/workflows/container.yml
+    secrets: inherit
+    with:
+      buildfilename: './container/ffmpeg-hf4.containerfile'
+      version: ${{ needs.set-version.outputs.version }}
+
+  call-build-ffmpeg-hf5:
+    name: "🤙 Call container workflow with `ffmpeg-hf5`"
+    needs: ['set-version', 'call-build-ffmpeg-torch2']
+    uses: ./.github/workflows/container.yml
+    secrets: inherit
+    with:
+      buildfilename: './container/ffmpeg-hf5.containerfile'
+      version: ${{ needs.set-version.outputs.version }}
+
+  call-build-opencv4-hf:
+    name: "🤙 Call container workflow with `opencv4-hf`"
+    needs: ['set-version', 'call-build-opencv4-hf5']
+    uses: ./.github/workflows/container.yml
+    secrets: inherit
+    with:
+      buildfilename: './container/opencv4-hf.containerfile'
+      version: ${{ needs.set-version.outputs.version }}
+
+  call-build-opencv4-hf4:
+    name: "🤙 Call container workflow with `opencv4-hf4`"
+    needs: ['set-version', 'call-build-opencv4-torch2']
+    uses: ./.github/workflows/container.yml
+    secrets: inherit
+    with:
+      buildfilename: './container/opencv4-hf4.containerfile'
+      version: ${{ needs.set-version.outputs.version }}
+
+  call-build-opencv4-hf5:
+    name: "🤙 Call container workflow with `opencv4-hf5`"
+    needs: ['set-version', 'call-build-opencv4-torch2']
+    uses: ./.github/workflows/container.yml
+    secrets: inherit
+    with:
+      buildfilename: './container/opencv4-hf5.containerfile'
+      version: ${{ needs.set-version.outputs.version }}

clams_python-1.6.0/.github/workflows/issue-close.yml

@@ -0,0 +1,15 @@
+name: "🙅 Unassign assignees"
+
+on:
+  issues:
+    types:
+      - closed
+  pull_request:
+    types:
+      - closed
+
+jobs:
+  call-unassign:
+    name: "🤙 Call unassignment workflow"
+    uses: clamsproject/.github/.github/workflows/repo-issue-close.yml@main
+    secrets: inherit

clams_python-1.6.0/.github/workflows/issue-infra-project.yml

@@ -0,0 +1,18 @@
+name: "🗂 Add issue to `infra` GHP"
+
+on:
+  issues:
+    types:
+      - opened
+      - transferred
+  pull_request:
+    types:
+      - opened
+
+jobs:
+  call-assign:
+    name: "🤙 Call GHP workflow"
+    uses: clamsproject/.github/.github/workflows/repo-issue-project.yml@main
+    secrets: inherit
+    with:
+      projectnum: 10

clams_python-1.6.0/.github/workflows/publish.yml

@@ -0,0 +1,51 @@
+name: "📦 Publish (PyPI + docs)"
+
+on:
+  push:
+    tags:
+      - '[0-9]+.[0-9]+.[0-9]+'
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to publish (e.g., 3.2.0)'
+        required: true
+
+jobs:
+  check-pypi:
+    name: "🔍 Check PyPI for existing package"
+    runs-on: ubuntu-latest
+    outputs:
+      exists: ${{ steps.check.outputs.exists }}
+      version: ${{ steps.check.outputs.version }}
+    steps:
+      - id: check
+        run: |
+          PACKAGE=$(echo "${{ github.repository }}" | cut -d/ -f2 | tr '-' '_')
+          VERSION=${{ inputs.version || github.ref_name }}
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          STATUS=$(curl -s -o /dev/null -w "%{http_code}" "https://pypi.org/pypi/$PACKAGE/$VERSION/json")
+          if [ "$STATUS" = "200" ]; then
+            echo "Package $PACKAGE $VERSION already exists on PyPI, skipping upload"
+            echo "exists=true" >> $GITHUB_OUTPUT
+          else
+            echo "Package $PACKAGE $VERSION not found on PyPI, proceeding with upload"
+            echo "exists=false" >> $GITHUB_OUTPUT
+          fi
+
+  publish-pypi:
+    name: "📦 Build and upload to PyPI"
+    needs: check-pypi
+    if: needs.check-pypi.outputs.exists == 'false'
+    uses: clamsproject/.github/.github/workflows/sdk-publish-pyproj.yml@main
+    secrets: inherit
+
+  publish-docs:
+    name: "📖 Build and publish docs"
+    needs: [check-pypi, publish-pypi]
+    if: always() && needs.check-pypi.result == 'success' && needs.publish-pypi.result != 'failure'
+    uses: clamsproject/clamsproject.github.io/.github/workflows/sdk-docs.yml@main
+    with:
+      source_repo: clamsproject/clams-python
+      source_ref: ${{ needs.check-pypi.outputs.version }}
+      project_name: clams-python
+    secrets: inherit

clams_python-1.6.0/.gitignore

@@ -0,0 +1,88 @@
+# python test files 
+.coverage
+.pytype
+
+# build time temp files
+VERSION*
+
+# linux
+.*.sw?
+*~
+.directory # KDE directory preferences
+.Trash-* # Linux trash folder which might appear on any partition or disk
+
+# macos
+.DS_Store
+.AppleDouble
+.LSOverride
+Icon # Icon must end with two \r
+._* # Thumbnails
+.DocumentRevisions-V100 # Files that might appear in the root of a volume
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.AppleDB # Directories potentially created on remote AFP share
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# windows
+Thumbs.db
+ehthumbs.db
+Desktop.ini
+$RECYCLE.BIN/
+*.cab # Windows Installer files
+*.msi
+*.msm
+*.msp
+*.lnk # Windows shortcuts
+
+# idea
+.idea
+*.iml
+out
+gen
+
+# sqlite
+*.db
+*.sqlite3
+
+
+# java
+*.class
+.mtj.tmp/ # Mobile Tools for Java (J2ME)
+target/ # Package Files #
+*.jar
+*.war
+*.ear
+hs_err_pid* # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+
+# python 
+**/*.pyc
+**/__pycache__
+build/
+dist/
+*.egg-info
+clams_python-*/
+coverage.xml
+
+# shared folders
+dropbox_shared*/
+github_shared*/
+gdrive_shared*/
+
+# external references
+\!rel_*/
+\!ref_*/
+
+# ctag generated file
+tags
+.tags
+
+# sphinx
+docs-test/
+documentation/appmetadata.jsonschema
+documentation/whatsnew.md

clams_python-1.6.0/.pytype.cfg

@@ -0,0 +1,10 @@
+# NOTE: All relative paths are relative to the location of this file.
+
+[pytype]
+
+# Space-separated list of files or directories to exclude.
+exclude =
+    **/*_test.py
+    **/test_*.py
+    clams/develop/templates/**/*.py
+