Add Python bindings for jsartoolkitNFT

.github/codeql/codeql-config.yml

@@ -0,0 +1,10 @@
+# Source - https://stackoverflow.com/a/78835420
+# Posted by sclarson
+# Retrieved 2025-11-09, License - CC BY-SA 4.0
+
+paths:
+ - 'src'
+ - 'js'
+paths-ignore:
+ - 'dist'
+ - 'build'

.github/workflows/build-python.yml

@@ -0,0 +1,119 @@
+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@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+
+    - 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 pytest pillow
+
+    - name: Update submodules
+      run: git submodule update --init
+
+    - name: Build the Python bindings
+      run: |
+        cd python-bindings
+        python setup.py bdist_wheel && pip install dist/*.whl
+
+    - name: Test the build
+      run: |
+        cd python-bindings
+        python example.py
+
+    - name: Run unit tests
+      run: npm run python-tests
+
+  build-windows:
+    runs-on: windows-2022
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+
+    - 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 pytest pillow
+
+    - name: Update submodules
+      run: git submodule update --init
+
+    - name: Build the Python bindings
+      shell: pwsh
+      run: |
+        cd python-bindings
+        python setup.py bdist_wheel
+        $version = (python setup.py --version).Trim()
+        pip install dist/artoolkitnft-0.0.10-cp311-cp311-win_amd64.whl
+
+    - name: Test the build
+      run: |
+        cd python-bindings
+        python example.py
+
+    - name: Run unit tests
+      run: npm run python-tests

.github/workflows/codeql.yml

@@ -65,6 +65,7 @@ jobs:
       with:
         languages: ${{ matrix.language }}
         build-mode: ${{ matrix.build-mode }}
+        config-file: ./.github/codeql/codeql-config.yml
         # If you wish to specify custom queries, you can do so here or in a config file.
         # By default, queries listed here will override any specified in a config file.
         # Prefix the list here with "+" to use these queries and those in the config file.

.github/workflows/publish.yml

@@ -0,0 +1,54 @@
+name: Publish to npm
+
+on:
+  push:
+    tags:
+      - '*.*.*'    # e.g. 1.2.3
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: Existing tag to publish (e.g. 1.2.3)
+        required: true
+
+permissions:
+  contents: read
+  id-token: write   # required for npm provenance
+
+jobs:
+  publish:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.15.1
+          registry-url: https://registry.npmjs.org
+          cache: npm
+
+      - name: Install
+        run: npm ci
+
+      - name: Test
+        run: npm test
+        env:
+          CI: true
+
+      - name: Build
+        run: npm run build --if-present
+
+      - name: Verify npm auth
+        run: npm whoami
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Publish
+        run: |
+          # For public scoped packages add --access public
+          # For private packages omit --access or use --access restricted
+          npm publish --provenance --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+

.gitignore

@@ -4,5 +4,13 @@ build/*.a
 node_modules
 docs/*
 emscripten/build
+python-bindings/build
+python-bindings/dist
+python-bindings/emscripten
+python-bindings/*.so
+python-bindings/deps/libjpeg/*
+python-bindings/__pycache__
+python-bindings/*.egg-info
+python-bindings/src/*.egg-info
 .vscode
 .idea

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webarkit/jsartoolkit-nft",
-  "version": "1.7.6",
+  "version": "1.7.2",
   "main": "dist/ARToolkitNFT.js",
   "types": "types/src/index.d.ts",
   "description": "Emscripten port of ARToolKit5 to JavaScript. It is a lighter version of Jsartoolkit5 with only NFT markerless support",
@@ -72,6 +72,8 @@
     "test:es6": "cross-env BUILD_TARGET_ES6=artoolkitNFT_ES6_wasm.js karma start karma-es6.conf.js",
     "test:es6-simd": "cross-env BUILD_TARGET_ES6=artoolkitNFT_ES6_wasm.simd.js karma start karma-es6.conf.js",
     "test:all": "npm run test:min && npm run test:debug && npm run test:wasm && npm run test:simd && npm run test:embed-es6 && npm run test:es6 && npm run test:es6-simd",
+    "build-python-bindings": "cd python-bindings && python setup.py build_ext --inplace",
+    "python-tests": "cd python-bindings && pytest test_arcontrollerNFT.py",
     "watch": "./node_modules/.bin/watch 'npm run build' ./js/",
     "format-check": "prettier --check .",
     "format": "prettier --write .",