Merge pull request #18 from FelixNgFender/main

4 Data modalities, python typings, python testing and CLI, client multithreading for send function

.github/workflows/ci.yml

@@ -0,0 +1,75 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+    branches:
+      - main
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# security: restrict permissions for CI jobs.
+permissions:
+  contents: read
+
+jobs:
+  server-ci:
+    name: Server CI
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Python
+        id: install_python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install Poetry
+        uses: abatilo/actions-poetry@v2
+        with:
+          poetry-version: "1.8.3"
+
+      - name: Setup a local virtual environment (if no poetry.toml file)
+        working-directory: ./python
+        run: |
+          poetry config virtualenvs.create true --local
+          poetry config virtualenvs.in-project true --local
+
+      - name: Restore cached virtualenv
+        uses: actions/cache/restore@v4
+        with:
+          path: ./python/.venv
+          key: venv-${{ runner.os }}-${{ steps.install_python.outputs.python-version }}-${{ hashFiles('./python/poetry.lock') }}
+
+      - name: Install dependencies (used by later workflows)
+        working-directory: ./python
+        run: |
+          poetry install
+          echo "$(poetry env info --path)/bin" >> $GITHUB_PATH
+          echo "VIRTUAL_ENV=$(poetry env info --path)/bin" >> $GITHUB_ENV
+
+      - name: Saved cached virtualenv
+        uses: actions/cache/save@v4
+        with:
+          path: ./python/.venv
+          key: venv-${{ runner.os }}-${{ steps.install_python.outputs.python-version }}-${{ hashFiles('./python/poetry.lock') }}
+
+      - name: Lint with ruff
+        working-directory: ./python
+        run: ruff check --output-format=github
+
+      - name: Typecheck with pyright
+        working-directory: ./python
+        run: pyright arflow
+
+      - name: Test with pytest
+        working-directory: ./python
+        timeout-minutes: 5 # pytest sometimes hangs for (yet) unknown reasons
+        # TODO: Add coverage tracking once we have a stable test suite
+        run: |
+          pytest

.github/workflows/pre-release.yml

@@ -0,0 +1,65 @@
+name: Pre-release
+
+on:
+  push:
+    tags:
+      - "*"
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    name: Release package
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Python
+        id: install_python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install Poetry
+        uses: abatilo/actions-poetry@v2
+        with:
+          poetry-version: "1.8.3"
+
+      - name: Setup a local virtual environment (if no poetry.toml file)
+        working-directory: ./python
+        run: |
+          poetry config virtualenvs.create true --local
+          poetry config virtualenvs.in-project true --local
+
+      - name: Restore cached virtualenv
+        uses: actions/cache/restore@v4
+        with:
+          path: ./python/.venv
+          key: venv-${{ runner.os }}-${{ steps.install_python.outputs.python-version }}-${{ hashFiles('./python/poetry.lock') }}
+
+      - name: Install dependencies (skipped if cache hit, fallback to install)
+        working-directory: ./python
+        run: |
+          poetry install
+          echo "$(poetry env info --path)/bin" >> $GITHUB_PATH
+          echo "VIRTUAL_ENV=$(poetry env info --path)/bin" >> $GITHUB_ENV
+
+      - name: Saved cached virtualenv
+        uses: actions/cache/save@v4
+        with:
+          path: ./python/.venv
+          key: venv-${{ runner.os }}-${{ steps.install_python.outputs.python-version }}-${{ hashFiles('./python/poetry.lock') }}
+
+      - name: Configure Test PyPI with Poetry
+        working-directory: ./python
+        run: |
+          poetry config repositories.testpypi https://test.pypi.org/legacy/
+          poetry config pypi-token.testpypi ${{ secrets.TEST_PYPI_API_TOKEN }}
+
+      - name: Build and publish the package
+        working-directory: ./python
+        run: poetry publish --build -r testpypi

.github/workflows/website.yml → .github/workflows/publish-docs.yml

@@ -1,30 +1,17 @@
-# Simple workflow for deploying static content to GitHub Pages
-name: Deploy static content to Pages
+name: Publish docs
 
 on:
-  # Runs on pushes targeting the default branch
-  push:
-    branches:
-      - main
-    paths:
-      - 'python/**'
-      - '.github/workflows/website.yml'
-      - 'website/**'
-      - 'unity/**'
-
-    # Alternative: only build for tags.
-    # tags:
-    #   - '*'
-
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
+  workflow_call:
 
-# security: restrict permissions for CI jobs.
 permissions:
-  contents: read
+  pages: write
+  id-token: write
 
 jobs:
   build-client-docs-as-artifact:
+    name: Build client docs
     runs-on: windows-latest
     steps:
       - uses: actions/checkout@v4
@@ -47,41 +34,52 @@ jobs:
           path: ./unity/Documentation/clientHTMLOutput
 
   build-server-docs:
+    name: Build server docs
     needs: build-client-docs-as-artifact
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
 
       - name: Install Python
+        id: install_python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.10.12'
+          python-version: "3.10"
 
       - name: Install Poetry
         uses: abatilo/actions-poetry@v2
         with:
-          poetry-version: '1.8.3'
+          poetry-version: "1.8.3"
 
       - name: Setup a local virtual environment (if no poetry.toml file)
         working-directory: ./python
         run: |
           poetry config virtualenvs.create true --local
           poetry config virtualenvs.in-project true --local
 
-      - name: Define a cache for the virtual environment based on the dependencies lock file
-        uses: actions/cache@v3
+      - name: Restore cached virtualenv
+        uses: actions/cache/restore@v4
         with:
           path: ./python/.venv
-          key: venv-${{ hashFiles('./python/poetry.lock') }}
-        
+          key: venv-${{ runner.os }}-${{ steps.install_python.outputs.python-version }}-${{ hashFiles('./python/poetry.lock') }}
+
       - name: Install docs dependencies
         working-directory: ./python
-        run: poetry install --with docs
+        run: |
+          poetry install --with docs
+          echo "$(poetry env info --path)/bin" >> $GITHUB_PATH
+          echo "VIRTUAL_ENV=$(poetry env info --path)/bin" >> $GITHUB_ENV
+
+      # - name: Saved cached virtualenv
+      #   uses: actions/cache/save@v4
+      #   with:
+      #     path: ./python/.venv
+      #     key: venv-${{ runner.os }}-${{ steps.install_python.outputs.python-version }}-${{ hashFiles('./python/poetry.lock') }}
 
       - name: Build the documentation
         working-directory: ./python
-        run: poetry run python tools/make_docs_cli.py
-      
+        run: python tools/make_docs_cli.py
+
       - name: Move docs to website directory
         run: |
           mkdir -p ./website/docs/server/
@@ -92,7 +90,7 @@ jobs:
         with:
           name: client-docs
           path: ./website/docs/client
-      
+
       # # cleanup client docs artifacts
       # - name: Delete client docs artifact
       #   run: |
@@ -107,7 +105,8 @@ jobs:
           path: ./website
 
   # Single deploy job since we're just deploying
-  deploy:
+  deploy-website:
+    name: Deploy website
     needs: build-server-docs
     runs-on: ubuntu-latest
     permissions:

.github/workflows/release.yml

@@ -0,0 +1,76 @@
+name: Release
+
+on:
+  release:
+    types:
+      - published
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    name: Release package
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Python
+        id: install_python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install Poetry
+        uses: abatilo/actions-poetry@v2
+        with:
+          poetry-version: "1.8.3"
+
+      - name: Setup a local virtual environment (if no poetry.toml file)
+        working-directory: ./python
+        run: |
+          poetry config virtualenvs.create true --local
+          poetry config virtualenvs.in-project true --local
+
+      - name: Restore cached virtualenv
+        uses: actions/cache/restore@v4
+        with:
+          path: ./python/.venv
+          key: venv-${{ runner.os }}-${{ steps.install_python.outputs.python-version }}-${{ hashFiles('./python/poetry.lock') }}
+
+      - name: Install dependencies (skipped if cache hit, fallback to install)
+        working-directory: ./python
+        run: |
+          poetry install
+          echo "$(poetry env info --path)/bin" >> $GITHUB_PATH
+          echo "VIRTUAL_ENV=$(poetry env info --path)/bin" >> $GITHUB_ENV
+
+      - name: Saved cached virtualenv
+        uses: actions/cache/save@v4
+        with:
+          path: ./python/.venv
+          key: venv-${{ runner.os }}-${{ steps.install_python.outputs.python-version }}-${{ hashFiles('./python/poetry.lock') }}
+
+      - name: Use PyPI API token
+        working-directory: ./python
+        run: poetry config pypi-token.pypi ${{ secrets.PYPI_API_TOKEN }}
+
+      - name: Build and publish the package
+        working-directory: ./python
+        run: poetry publish --build
+
+      - name: Upload Python package to GitHub
+        uses: actions/upload-artifact@v4
+        with:
+          path: ./python/dist/
+          if-no-files-found: error
+
+  publish-docs:
+    name: Publish documentation
+    permissions:
+      pages: write
+      id-token: write
+    uses: ./.github/workflows/publish-docs.yml

.github/workflows/update-contributors.yml

@@ -0,0 +1,19 @@
+name: Update contributors
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  contrib-readme-job:
+    runs-on: ubuntu-latest
+    name: A job to automate contrib in readme
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Contribute List
+        uses: akhilmhdh/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}