chore(deps): update from template

Author: helmut-hoffer-von-ankershoffen

.copier-answers.yml

@@ -1,4 +1,4 @@
-_commit: v0.8.7
+_commit: v0.8.11
 _src_path: gh:helmut-hoffer-von-ankershoffen/oe-python-template
 attestations_enabled: true
 author_email: helmuthva@gmail.com

.github/workflows/vercel-preview.yml

@@ -28,4 +28,4 @@ jobs:
           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 }}
+          vercel deploy --prebuilt --archive=tgz --token=${{ secrets.VERCEL_TOKEN }}

.github/workflows/vercel-production.yml

@@ -28,4 +28,4 @@ jobs:
           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 }}
+          vercel deploy --prebuilt --archive=tgz --prod --token=${{ secrets.VERCEL_TOKEN }}

ATTRIBUTIONS.md

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

VERCEL.md

@@ -12,23 +12,58 @@ You can host the API as a serverless function on Vercel
 pnpm i -g vercel
 ```
 
-## Generate, link and deploy Vercel Distribution
+Note:
+1. If `pnpm` is not available because you did not run `./install.sh`,
+you can install it manually with `brew install pnpm`.
+
+## Generate Vercel Distribution
 
 ```shell
 make dist_vercel
-vercel login
+```
+
+Notes:
+1. Builds and outputs a wheel of the project into vercel_dist/wheels/
+2. Generates a vercel_dist/requirements.txt from pyproject.toml including a reference to the wheel.
+
+
+## Link with Vercel project
+
+```shell
 vercel link --cwd dist_vercel --project oe-python-template-example --yes
-vercel deploy --cwd dist_vercel
+```
+
+Notes:
+1. Creates the Vercel project if not yet existing.
+2. Links the dist_vercel/ directory with that project
+
+## Run function locally
+
+```shell
+vercel dev --cwd dist_vercel
+```
+
+Notes:
+1. Runs a local server on port 3000
+
+## Deploy distribution to production on Vercel
+
+```shell
+vercel deploy --cwd dist_vercel --archive=tgz --prod
 ```
 
 Visit the [production deployment](https://oe-python-template-example.vercel.app/)
 
-## Wire the CI/CD
+## Wire Vercel with GitHub for Continuous Deployment
 
 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
+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.

docs/source/_static/openapi_v1.yaml

@@ -90,10 +90,8 @@ openapi: 3.1.0
 paths:
   /echo/{text}:
     get:
-      description: "Echo back the provided text.\n\nArgs:\n    text (str): The 
-text\
-        \ to echo.\n\nReturns:\n    Echo: The echo.\n\nRaises:\n    422 
-Unprocessable\
+      description: "Echo back the provided text.\n\nArgs:\n    text (str): The text\
+        \ to echo.\n\nReturns:\n    Echo: The echo.\n\nRaises:\n    422 Unprocessable\
         \ Entity: If text is not provided or empty."
       operationId: echo_echo__text__get
       parameters:
@@ -121,18 +119,12 @@ Unprocessable\
       - Basics
   /health:
     get:
-      description: "Check the health of the service.\n\nThis endpoint returns 
-the\
-        \ health status of the service.\nThe health status can be either UP or 
-DOWN.\n\
-        If the service is healthy, the status will be UP.\nIf the service is 
-unhealthy,\
-        \ the status will be DOWN and a reason will be provided.\nThe response 
-will\
-        \ have a 200 OK status code if the service is healthy,\nand a 500 
-Internal\
-        \ Server Error status code if the service is unhealthy.\n\nReturns:\n   
-Health:\
+      description: "Check the health of the service.\n\nThis endpoint returns the\
+        \ health status of the service.\nThe health status can be either UP or DOWN.\n\
+        If the service is healthy, the status will be UP.\nIf the service is unhealthy,\
+        \ the status will be DOWN and a reason will be provided.\nThe response will\
+        \ have a 200 OK status code if the service is healthy,\nand a 500 Internal\
+        \ Server Error status code if the service is unhealthy.\n\nReturns:\n    Health:\
         \ The health status of the service."
       operationId: health_health_get
       responses:
@@ -147,18 +139,12 @@ Health:\
       - Observability
   /healthz:
     get:
-      description: "Check the health of the service.\n\nThis endpoint returns 
-the\
-        \ health status of the service.\nThe health status can be either UP or 
-DOWN.\n\
-        If the service is healthy, the status will be UP.\nIf the service is 
-unhealthy,\
-        \ the status will be DOWN and a reason will be provided.\nThe response 
-will\
-        \ have a 200 OK status code if the service is healthy,\nand a 500 
-Internal\
-        \ Server Error status code if the service is unhealthy.\n\nReturns:\n   
-Health:\
+      description: "Check the health of the service.\n\nThis endpoint returns the\
+        \ health status of the service.\nThe health status can be either UP or DOWN.\n\
+        If the service is healthy, the status will be UP.\nIf the service is unhealthy,\
+        \ the status will be DOWN and a reason will be provided.\nThe response will\
+        \ have a 200 OK status code if the service is healthy,\nand a 500 Internal\
+        \ Server Error status code if the service is unhealthy.\n\nReturns:\n    Health:\
         \ The health status of the service."
       operationId: health_healthz_get
       responses:
@@ -173,8 +159,7 @@ Health:\
       - Observability
   /hello-world:
     get:
-      description: "Return a hello world message.\n\nReturns:\n    
-_HelloWorldResponse:\
+      description: "Return a hello world message.\n\nReturns:\n    _HelloWorldResponse:\
         \ A response containing the hello world message."
       operationId: hello_world_hello_world_get
       responses:

docs/source/_static/openapi_v2.yaml

@@ -104,10 +104,8 @@ openapi: 3.1.0
 paths:
   /echo:
     post:
-      description: "Echo back the provided utterance.\n\nArgs:\n    request 
-(Utterance):\
-        \ The utterance to echo back.\n\nReturns:\n    Echo: The 
-echo.\n\nRaises:\n\
+      description: "Echo back the provided utterance.\n\nArgs:\n    request (Utterance):\
+        \ The utterance to echo back.\n\nReturns:\n    Echo: The echo.\n\nRaises:\n\
         \    422 Unprocessable Entity: If utterance is not provided or empty."
       operationId: echo_v2_echo_post
       requestBody:
@@ -134,18 +132,12 @@ echo.\n\nRaises:\n\
       - Basics
   /health:
     get:
-      description: "Check the health of the service.\n\nThis endpoint returns 
-the\
-        \ health status of the service.\nThe health status can be either UP or 
-DOWN.\n\
-        If the service is healthy, the status will be UP.\nIf the service is 
-unhealthy,\
-        \ the status will be DOWN and a reason will be provided.\nThe response 
-will\
-        \ have a 200 OK status code if the service is healthy,\nand a 500 
-Internal\
-        \ Server Error status code if the service is unhealthy.\n\nReturns:\n   
-Health:\
+      description: "Check the health of the service.\n\nThis endpoint returns the\
+        \ health status of the service.\nThe health status can be either UP or DOWN.\n\
+        If the service is healthy, the status will be UP.\nIf the service is unhealthy,\
+        \ the status will be DOWN and a reason will be provided.\nThe response will\
+        \ have a 200 OK status code if the service is healthy,\nand a 500 Internal\
+        \ Server Error status code if the service is unhealthy.\n\nReturns:\n    Health:\
         \ The health status of the service."
       operationId: health_health_get
       responses:
@@ -160,18 +152,12 @@ Health:\
       - Observability
   /healthz:
     get:
-      description: "Check the health of the service.\n\nThis endpoint returns 
-the\
-        \ health status of the service.\nThe health status can be either UP or 
-DOWN.\n\
-        If the service is healthy, the status will be UP.\nIf the service is 
-unhealthy,\
-        \ the status will be DOWN and a reason will be provided.\nThe response 
-will\
-        \ have a 200 OK status code if the service is healthy,\nand a 500 
-Internal\
-        \ Server Error status code if the service is unhealthy.\n\nReturns:\n   
-Health:\
+      description: "Check the health of the service.\n\nThis endpoint returns the\
+        \ health status of the service.\nThe health status can be either UP or DOWN.\n\
+        If the service is healthy, the status will be UP.\nIf the service is unhealthy,\
+        \ the status will be DOWN and a reason will be provided.\nThe response will\
+        \ have a 200 OK status code if the service is healthy,\nand a 500 Internal\
+        \ Server Error status code if the service is unhealthy.\n\nReturns:\n    Health:\
         \ The health status of the service."
       operationId: health_healthz_get
       responses:
@@ -186,8 +172,7 @@ Health:\
       - Observability
   /hello-world:
     get:
-      description: "Return a hello world message.\n\nReturns:\n    
-_HelloWorldResponse:\
+      description: "Return a hello world message.\n\nReturns:\n    _HelloWorldResponse:\
         \ A response containing the hello world message."
       operationId: hello_world_hello_world_get
       responses:

install.sh

@@ -17,6 +17,7 @@ BREW_TOOLS=(
     "act;act;https://nektosact.com/"
     "pinact;pinact;https://github.com/suzuki-shunsuke/pinact"
     "trivy;trivy;https://trivy.dev/latest/"
+    "pnpm;pnpm;https://pnpm.io/"
 )
 
 MAC_BREW_TOOLS=(