chore(deps): update from template

Author: helmut-hoffer-von-ankershoffen

.copier-answers.yml

@@ -1,4 +1,4 @@
-_commit: v0.8.2
+_commit: v0.8.4
 _src_path: gh:helmut-hoffer-von-ankershoffen/oe-python-template
 attestations_enabled: true
 author_email: helmuthva@gmail.com
@@ -25,3 +25,4 @@ readthedocs_domain: readthedocs.org
 readthedocs_project_key: oe-python-template-example
 sonarqube_key: helmut-hoffer-von-ankershoffen_oe-python-template-example
 streamlit_project_key: oe-python-template-example
+vercel_function_enabled: true

.github/workflows/test-and-report.yml

@@ -30,7 +30,7 @@ jobs:
 
       - name: Install project specific dependencies
         run: |
-          sudo apt-get install -y libcairo2
+          # sudo apt-get install -y YOUR_PROJECT_DEPENDENCIES
 
       - name: Install uv (python package manager)
         uses: astral-sh/setup-uv@f94ec6bedd8674c4426838e6b50417d36b6ab231 # v5.3.1
@@ -48,7 +48,6 @@ jobs:
         run: |
           TAG_VERSION=${GITHUB_REF#refs/tags/v}
           TOML_VERSION=$(uv run python -c "import tomli; print(tomli.load(open('pyproject.toml', 'rb'))['project']['version'])")
-
           if [ "$TAG_VERSION" != "$TOML_VERSION" ]; then
             echo "Release version mismatch: Tag $TAG_VERSION != pyproject.toml $TOML_VERSION"
             exit 1
@@ -68,19 +67,19 @@ jobs:
 
       - name: Validate installation
         run: |
-            OUTPUT=$(uv run oe-python-template-example --help)
+            OUTPUT=$(uv run --no-dev oe-python-template-example --help)
             if [[ "$OUTPUT" != *"built with love in Berlin"* ]]; then
             echo "Output does not contain 'built with love in Berlin'"
             exit 1
             fi
 
       - name: Smoke tests
         run: |
-          uv run oe-python-template-example hello-world
+          uv run --no-dev oe-python-template-example hello-world
 
       - name: Run unit tests, measure coverage, lint, and check vulnerabilities
         run: |
-          uv run nox
+          uv run --all-extras nox
 
       - name: Upload test results
         uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
@@ -108,6 +107,7 @@ jobs:
         uses: codecov/test-results-action@f2dba722c67b86c6caa034178c6e4d35335f6706 # v1.1.0
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
+
       - name: SonarQube Scan
         if: ${{ !cancelled() && (env.GITHUB_WORKFLOW_RUNTIME != 'ACT') }}
         uses: SonarSource/sonarqube-scan-action@0303d6b62e310685c0e34d0b9cde218036885c4d # v5.0.0

.github/workflows/vercel-preview.yml

@@ -0,0 +1,27 @@
+name: Vercel Preview Deployment
+env:
+  VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
+  VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
+on:
+  push:
+    branches-ignore:
+      - main
+jobs:
+  Deploy-Preview:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install Vercel CLI
+        run: npm install --global vercel@latest
+
+      - name: Install Vercel CLI
+        run: npm install --global vercel@latest
+
+      - name: Package and Deploy to Preview Environment
+        run: |
+          make dist_vercel
+          cd dist_vercel
+          vercel pull --yes --environment=preview --token=${{ secrets.VERCEL_TOKEN }}
+          vercel build --prod --token=${{ secrets.VERCEL_TOKEN }}
+          vercel deploy --prebuilt --token=${{ secrets.VERCEL_TOKEN }}

.github/workflows/vercel-production.yml

@@ -0,0 +1,27 @@
+name: Vercel Production Deployment
+env:
+  VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
+  VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
+on:
+  push:
+    branches:
+      - main
+jobs:
+  Deploy-Production:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install Vercel CLI
+        run: npm install --global vercel@latest
+
+      - name: Install Vercel CLI
+        run: npm install --global vercel@latest
+
+      - name: Package and Deploy to Production
+        run: |
+          make dist_vercel
+          cd dist_vercel
+          vercel pull --yes --environment=production --token=${{ secrets.VERCEL_TOKEN }}
+          vercel build --prod --token=${{ secrets.VERCEL_TOKEN }}
+          vercel deploy --prebuilt --prod --token=${{ secrets.VERCEL_TOKEN }}

.gitignore

@@ -75,4 +75,9 @@ node_modules/
 # Copier
 *.rej
 
+
+# Vercel
+.vercel
+
+
 # Application specific

.pre-commit-config.yaml

@@ -64,7 +64,7 @@ repos:
         args: ['--baseline', '.secrets.baseline']
         additional_dependencies: ["gibberish-detector"]
   - repo: https://github.com/astral-sh/uv-pre-commit
-    rev: 0.6.5
+    rev: 0.6.10
     hooks:
       - id: uv-lock
   - repo: local

ATTRIBUTIONS.md

@@ -9984,7 +9984,7 @@ License: LGPL-2.1-or-later
 
 ```
 
-## oe-python-template-example (0.2.10) - MIT License
+## oe-python-template-example (0.2.11) - MIT License
 
 🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
 

Makefile

@@ -1,13 +1,14 @@
 # Makefile for running common development tasks
 
 # Define all PHONY targets
-.PHONY: all act audit bump clean dist docs docker_build lint setup setup test update_from_template
+.PHONY: all act audit bump clean dist dist_vercel docs docker_build lint setup setup test update_from_template
 
 # Main target i.e. default sessions defined in noxfile.py
 all:
 	uv run nox
 
 # Nox targets
+
 ## Call nox sessions passing parameters
 nox-cmd = @if [ "$@" = "test" ]; then \
 	if [ -n "$(filter 3.%,$(MAKECMDGOALS))" ]; then \
@@ -23,8 +24,8 @@ else \
 	uv run nox -s $@; \
 fi
 
-# Individual Nox sessions
-act audit bump clean dist docs docker_build lint setup test update_from_template:
+## Individual Nox sessions
+act audit bump dist dist_vercel docs lint setup test update_from_template:
 	$(nox-cmd)
 
 # Standalone targets
@@ -45,14 +46,13 @@ clean:
 docker_build:
 	docker build -t oe-python-template-example .
 
-
 # Special rule to catch any arguments (like patch, minor, major, pdf, Python versions, or x.y.z)
 # This prevents "No rule to make target" errors when passing arguments to make commands
 .PHONY: %
 %:
 	@:
 
-# Help text
+# Help
 help:
 	@echo "🧠 Available targets for OE Python Template Example (v$(shell test -f VERSION && cat VERSION || echo 'unknown version'))"
 	@echo ""
@@ -61,7 +61,8 @@ help:
 	@echo "  audit               - Run security and license compliance audit"
 	@echo "  bump patch|minor|major|x.y.z - Bump version"
 	@echo "  clean               - Clean build artifacts and caches"
-	@echo "  dist               - Build wheel package with uv"
+	@echo "  dist                - Build wheel and sdist into dist/"
+	@echo "  dist_vercel         - Package as Vercel Function into dist_vercel/"
 	@echo "  docs [pdf]          - Build documentation (add pdf for PDF format)"
 	@echo "  docker_build        - Build Docker image oe-python-template-example"
 	@echo "  lint                - Run linting and formatting checks"

README.md

@@ -92,6 +92,7 @@ Beyond development tooling, projects generated with this template include the co
 6. Simple Web UI with [Streamlit](https://streamlit.io/)
 7. Configuration to run the CLI and API in a Docker container including setup for [Docker Compose](https://docs.docker.com/get-started/docker-concepts/the-basics/what-is-docker-compose/)
 8. Documentation including badges, setup instructions, contribution guide and security policy
+9. Preparation to deploy API as serverless function to Vercel
 
 Explore [here](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example) for what's generated out of the box.
 
@@ -242,6 +243,11 @@ uv sync --all-extras                                # Install streamlit dependen
 uv run streamlit run examples/streamlit.py          # Serve on localhost:8501, opens browser
 ```
 
+### Vercel Serverless Function
+
+Serve the API as a [serverless function on Vercel](https://oe-python-template-example.vercel.app/)
+
+
 ## Notebooks
 
 ### Jupyter

VERCEL.md

@@ -0,0 +1,34 @@
+# Vercel
+
+You can host the API as a serverless function on Vercel
+
+## Register at Vercel
+
+[Sign-Up](https://vercel.com/signup) and create a "Hobby" account - it's free.
+
+## Install Vercel CLI
+
+```shell
+pnpm i -g vercel
+```
+
+## Generate, link and deploy Vercel Distribution
+
+```shell
+make dist_vercel
+vercel login
+vercel link --cwd dist_vercel --project oe-python-template-example --yes
+vercel deploy --cwd dist_vercel
+```
+
+Visit the [production deployment](https://oe-python-template-example.vercel.app/)
+
+## Wire the CI/CD
+
+1. Show organisation and project id by executing `cat dist_vercel/.vercel/project.json`
+2. [Create secret](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/settings/secrets/actions/new) called `VERCEL_PROJECT_ID` with the value of `projectId` from step 1
+3. [Create secret](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/settings/secrets/actions/new) called `VERCEL_ORG_ID` with the value of `orgId` from step 1
+4. Goto [Vercel Account Settings](https://vercel.com/account/settings/tokens) and create a new token with project scope, copy the token to clipboard.
+5. [Create secret](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/settings/secrets/actions/new) called `VERCEL_TOKEN` with the value of `projectId` from the previous command
+
+That's it. The rest is automatic, deploy happening on build of main.