Add Python bindings for jsartoolkitNFT

.github/workflows/CI.yml

@@ -7,26 +7,30 @@ on:
 jobs:
 
   tests:
-    strategy:
-      matrix:
-        node:
-          - 20.x
-
-    # Packages 'firefox' and 'chromium' are pre-installed.
-    #
-    # https://github.com/actions/virtual-environments/blob/ubuntu20/20210302.0/images/linux/Ubuntu2004-README.md
-    runs-on: ubuntu-20.04
-    name: Node.js ${{ matrix.node }}
+    runs-on: ubuntu-24.04  # Upgrade to Ubuntu 24.04
+    name: Node.js CI
     steps:
       - uses: actions/checkout@v4
 
-      - name: Use Node.js ${{ matrix.node }}
+      - name: Use Node.js from .nvmrc
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ matrix.node }}
+          node-version-file: ".nvmrc"
+
+      - name: Install ChromiumHeadless
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y chromium-browser
+
+      - name: Get npm cache directory
+        id: npm-cache-dir
+        shell: bash
+        run: echo "dir=$(npm config get cache)" >> ${GITHUB_OUTPUT}
+
       - uses: actions/cache@v4
+        id: npm-cache
         with:
-          path: ~/.npm
+          path: ${{ steps.npm-cache-dir.outputs.dir }}
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.os }}-node-

.github/workflows/build-python.yml

@@ -0,0 +1,120 @@
+name: Build and Test Python Bindings
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  build-linux:
+    runs-on: ubuntu-24.04
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.8'
+
+    - name: Cache pip packages
+      uses: actions/cache@v4
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt', '**/setup.py') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+
+    - name: Install system dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y libjpeg9
+
+    - name: Install Python dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install numpy setuptools wheel pybind11
+
+    - name: Update submodules
+      run: git submodule update --init
+
+    - name: Build the Python bindings
+      run: |
+        cd python-bindings
+        python setup.py build_ext --inplace
+
+    - name: Test the build
+      run: |
+        cd python-bindings
+        python test.py
+
+    - name: Run unit tests
+      run: |
+        cd python-bindings
+        python -m unittest discover -s . -p 'unittests.py'
+
+  build-windows:
+    runs-on: windows-2022
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.8'
+
+    - name: Cache pip packages
+      uses: actions/cache@v4
+      with:
+        path: ~\AppData\Local\pip\Cache
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt', '**/setup.py') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+
+    - name: Cache vcpkg
+      uses: actions/cache@v4
+      with:
+        path: |
+          vcpkg
+          !vcpkg/.git
+        key: ${{ runner.os }}-vcpkg-${{ hashFiles('vcpkg.json') }}
+
+    - name: Install vcpkg
+      run: |
+        git clone https://github.com/microsoft/vcpkg.git
+        .\vcpkg\bootstrap-vcpkg.bat
+
+    - name: Install libjpeg-turbo
+      run: .\vcpkg\vcpkg install libjpeg-turbo
+
+    - name: Install pthreads
+      run: .\vcpkg\vcpkg install pthreads
+
+    - name: Add vcpkg to path
+      shell: bash
+      run: echo "vcpkg/installed/x64-windows/bin" >> $GITHUB_PATH
+
+    - name: Install Python dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install numpy setuptools wheel pybind11
+
+    - name: Update submodules
+      run: git submodule update --init
+
+    - name: Build the Python bindings
+      run: |
+        cd python-bindings
+        python setup.py build_ext --inplace
+
+    - name: Test the build
+      run: |
+        cd python-bindings
+        python test.py
+
+    - name: Run unit tests
+      run: |
+        cd python-bindings
+        python -m unittest discover -s . -p 'unittests.py'

.github/workflows/main.yml

@@ -8,32 +8,34 @@ on:
 jobs:
   build:
 
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04  # Upgrade to Ubuntu 24.04
 
-    strategy:
-      matrix:
-        node-version: [20.x]
     steps:
     - uses: actions/checkout@v4
-    - name: Use Node.js ${{ matrix.node-version }}
+
+    - name: Use Node.js from .nvmrc
       uses: actions/setup-node@v4
       with:
-        node-version: ${{ matrix.node-version }}
+        node-version-file: ".nvmrc"
+
     - uses: actions/cache@v4
       with:
         path: ~/.npm
         key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
         restore-keys: |
           ${{ runner.os }}-node-
+
     - name: Set output
       id: vars
       run: echo name=tag::${GITHUB_REF#refs/*/} >> $GITHUB_OUTPUT
+
     - name: Check output
       env:
         RELEASE_VERSION: ${{ steps.vars.outputs.tag }}
       run: |
         echo $RELEASE_VERSION
         echo ${{ steps.vars.outputs.tag }}
+
     - uses: actions/upload-artifact@v4
       with:
         name: build
@@ -42,22 +44,30 @@ jobs:
           !build/libar.o
           !build/libar_td.o
           !build/libar_simd.o
+
     - run: git submodule update --init
+
     - run: npm install
+
     - run: docker run -dit --name emscripten -v $(pwd):/src emscripten/emsdk:3.1.69 bash
+
     - run: docker exec emscripten npm run build
+
     - uses: actions/upload-artifact@v4
       with:
         name: dist
         path: dist
+
     - run: npm run build-ts
+
     - name: Commit changes
       if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
       uses: EndBug/add-and-commit@v9
       with:
         default_author: github_actions
         message: new build files from action
         add: '["build", "dist"]'
+
     - name: Release
       uses: softprops/action-gh-release@v2
       if: startsWith(github.ref, 'refs/tags/')

.gitignore

@@ -4,3 +4,7 @@ build/*.a
 node_modules
 docs/*
 emscripten/build
+python-bindings/build
+python-bindings/*.so
+python-bindings/deps/libjpeg/*
+python-bindings/__pycache__

package.json

@@ -61,6 +61,7 @@
     "build-docker": "docker exec emscripten-jsartoolkitnft npm run build",
     "build-docker-no-libar": "docker exec emscripten-jsartoolkitnft npm run build-no-libar",
     "test-browser": "karma start --browsers Chrome,Firefox,ChromeHeadless,FirefoxHeadless",
+    "build-python-bindings": "cd python-bindings && python setup.py build_ext --inplace",
     "test": "karma start",
     "watch": "./node_modules/.bin/watch 'npm run build' ./js/",
     "format-check": "prettier --check .",