added API docs and demo

.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,110 @@
+name: Publish Python Package to PyPI
+
+# This workflow uses GitHub's OIDC trusted publishing to authenticate with PyPI.
+# For this to work, you must configure trusted publishers on PyPI/TestPyPI:
+# 1. Go to https://test.pypi.org/ or https://pypi.org/
+# 2. Navigate to your project settings → Publishing
+# 3. Add a new publisher with these details:
+#    - Owner: alexlib
+#    - Repository: openptv-python
+#    - Workflow: publish-to-pypi.yml
+#    - Environment: testpypi (for TestPyPI) or pypi (for PyPI)
+#
+# TROUBLESHOOTING:
+# If you see "invalid-publisher" error, it means the trusted publisher is not configured
+# correctly on PyPI/TestPyPI. The configuration MUST match these exact values:
+# - Repository owner: alexlib
+# - Repository name: openptv-python
+# - Workflow filename: publish-to-pypi.yml (must be exact match)
+# - Environment name: testpypi or pypi (must match exactly)
+#
+# For detailed setup instructions, see DEPLOYMENT.md
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      deploy_target:
+        description: 'Deploy to PyPI or TestPyPI'
+        required: true
+        default: 'testpypi'
+        type: choice
+        options:
+          - pypi
+          - testpypi
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Check distribution
+        run: twine check dist/*
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-to-pypi:
+    name: Publish to PyPI
+    if: github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && github.event.inputs.deploy_target == 'pypi')
+    needs: [build]
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi  # This must match the environment name in PyPI's trusted publisher config
+      url: https://pypi.org/p/openptv-python
+    permissions:
+      id-token: write  # Required for trusted publishing via OIDC
+
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  publish-to-testpypi:
+    name: Publish to TestPyPI
+    if: github.event_name == 'workflow_dispatch' && github.event.inputs.deploy_target == 'testpypi'
+    needs: [build]
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi  # This must match the environment name in TestPyPI's trusted publisher config
+      url: https://test.pypi.org/p/openptv-python
+    permissions:
+      id-token: write  # Required for trusted publishing via OIDC
+
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+

.github/workflows/python-app.yml

@@ -0,0 +1,24 @@
+name: Python application
+
+on:
+  push:
+    branches: [ main, simple_yaml_with_tests ]
+  pull_request:
+    branches: [ main, simple_yaml_with_tests ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install -e ".[dev]"
+    - name: Run tests
+      run: |
+        make unit-tests

.gitignore

@@ -4,6 +4,7 @@ version.py
 # Sphinx automatic generation of API
 docs/README.md
 docs/_api/
+docs/_generated/
 
 # Combined environments
 ci/combined-environment-*.yml
@@ -473,3 +474,67 @@ $RECYCLE.BIN/
 .cruft.json
 /.tmp
 /tmp
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+*.pyc
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+
+tests/testing_folder/test_cavity/res/*

Makefile

@@ -1,6 +1,8 @@
 PROJECT := openptv_python
 CONDA := conda
 CONDAFLAGS :=
+UV := uv
+UVFLAGS := --extra dev --upgrade
 COV_REPORT := html
 PYTHON ?= python
 
@@ -15,11 +17,16 @@ unit-tests:
 type-check:
 	$(PYTHON) -m mypy .
 
+env-update: uv-env-update
+
 conda-env-update:
 	$(CONDA) install -y -c conda-forge conda-merge
 	$(CONDA) run conda-merge environment.yml ci/environment-ci.yml > ci/combined-environment-ci.yml
 	$(CONDA) env update $(CONDAFLAGS) -f ci/combined-environment-ci.yml
 
+uv-env-update:
+	$(UV) sync $(UVFLAGS)
+
 docker-build:
 	docker build -t $(PROJECT) .
 
@@ -30,6 +37,6 @@ template-update:
 	pre-commit run --all-files cruft -c .pre-commit-config-cruft.yaml
 
 docs-build:
-	cp README.md docs/. && cd docs && rm -fr _api && make clean && make html
+	cp README.md docs/. && $(PYTHON) docs/render_native_stress_demo_include.py && cd docs && rm -fr _api && make clean && make html
 
 # DO NOT EDIT ABOVE THIS LINE, ADD COMMANDS BELOW