updating onboarding AWS Python examples

Author: skierkowski

aws-python-flask-api/README.md

@@ -1,20 +1,19 @@
 <!--
 title: 'Serverless Framework Python Flask API on AWS'
-description: 'This template demonstrates how to develop and deploy a simple Python Flask API running on AWS Lambda using the traditional Serverless Framework.'
+description: 'This template demonstrates how to develop and deploy a simple Python Flask API running on AWS Lambda using the Serverless Framework.'
 layout: Doc
-framework: v2
+framework: v4
 platform: AWS
 language: Python
 priority: 2
 authorLink: 'https://github.com/serverless'
-authorName: 'Serverless, inc.'
+authorName: 'Serverless, Inc.'
 authorAvatar: 'https://avatars1.githubusercontent.com/u/13742415?s=200&v=4'
 -->
 
 # Serverless Framework Python Flask API on AWS
 
-This template demonstrates how to develop and deploy a simple Python Flask API service running on AWS Lambda using the traditional Serverless Framework.
-
+This template demonstrates how to develop and deploy a simple Python Flask API service running on AWS Lambda using the Serverless Framework.
 
 ## Anatomy of the template
 
@@ -26,7 +25,7 @@ This template configures a single function, `api`, which is responsible for hand
 
 In order to package your dependencies locally with `serverless-python-requirements`, you need to have `Python3.8` installed locally. You can create and activate a dedicated virtual environment with the following command:
 
-```bash
+```
 python3.8 -m venv ./venv
 source ./venv/bin/activate
 ```
@@ -63,41 +62,21 @@ serverless deploy
 
 After running deploy, you should see output similar to:
 
-```bash
-erverless: Using Python specified in "runtime": python3.8
-Serverless: Packaging Python WSGI handler...
-Serverless: Generated requirements from /home/xxx/xxx/xxx/examples/aws-python-flask-api/requirements.txt in /home/xxx/xxx/xxx/examples/aws-python-flask-api/.serverless/requirements.txt...
-Serverless: Using static cache of requirements found at /home/xxx/.cache/serverless-python-requirements/62f10436f9a1bb8040df30ef2db5736c8015b18256bf0b6f1b0cbb2640030244_slspyc ...
-Serverless: Packaging service...
-Serverless: Excluding development dependencies...
-Serverless: Injecting required Python packages to package...
-Serverless: Creating Stack...
-Serverless: Checking Stack create progress...
-........
-Serverless: Stack create finished...
-Serverless: Uploading CloudFormation file to S3...
-Serverless: Uploading artifacts...
-Serverless: Uploading service aws-python-flask-api.zip file to S3 (1.3 MB)...
-Serverless: Validating template...
-Serverless: Updating Stack...
-Serverless: Checking Stack update progress...
-.................................
-Serverless: Stack update finished...
-Service Information
-service: aws-python-flask-api
-stage: dev
-region: us-east-1
-stack: aws-python-flask-api-dev
-resources: 12
-api keys:
-  None
+```
+Deploying "aws-python-flask-api" to stage "dev" (us-east-1)
+
+Using Python specified in "runtime": python3.12
+
+Packaging Python WSGI handler...
+
+✔ Service deployed to stack aws-python-flask-api-dev (104s)
+
 endpoints:
-  ANY - https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/
-  ANY - https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/{proxy+}
+  ANY - https://ce9zsxqh6e.execute-api.us-east-1.amazonaws.com/dev/
+  ANY - https://ce9zsxqh6e.execute-api.us-east-1.amazonaws.com/dev/{proxy+}
 functions:
-  api: aws-python-flask-api-dev-api
-layers:
-  None
+  api: aws-python-flask-api-dev-api (41 MB)
+
 ```
 
 _Note_: In current form, after deployment, your API is public and can be invoked by anyone. For production deployments, you might want to configure an authorizer. For details on how to do that, refer to [http event docs](https://www.serverless.com/framework/docs/providers/aws/events/apigateway/).
@@ -106,52 +85,40 @@ _Note_: In current form, after deployment, your API is public and can be invoked
 
 After successful deployment, you can call the created application via HTTP:
 
-```bash
+```
 curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/
 ```
 
 Which should result in the following response:
 
-```
-{"message":"Hello from root!"}
+```json
+{ "message": "Hello from root!" }
 ```
 
 Calling the `/hello` path with:
 
-```bash
+```
 curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/hello
 ```
 
 Should result in the following response:
 
-```bash
-{"message":"Hello from path!"}
-```
-
-If you try to invoke a path or method that does not have a configured handler, e.g. with:
-
-```bash
-curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/nonexistent
-```
-
-You should receive the following response:
-
-```bash
-{"error":"Not Found!"}
+```json
+{ "message": "Hello from path!" }
 ```
 
 ### Local development
 
 Thanks to capabilities of `serverless-wsgi`, it is also possible to run your application locally, however, in order to do that, you will need to first install `werkzeug` dependency, as well as all other dependencies listed in `requirements.txt`. It is recommended to use a dedicated virtual environment for that purpose. You can install all needed dependencies with the following commands:
 
-```bash
+```
 pip install werkzeug
 pip install -r requirements.txt
 ```
 
 At this point, you can run your application locally with the following command:
 
-```bash
+```
 serverless wsgi serve
 ```
 

aws-python-flask-api/package.json

@@ -4,7 +4,7 @@
   "description": "Example of a Python Flask API service with traditional Serverless Framework",
   "author": "",
   "devDependencies": {
-    "serverless-python-requirements": "^5.1.0",
-    "serverless-wsgi": "^1.7.6"
+    "serverless-python-requirements": "^6.1.0",
+    "serverless-wsgi": "^3.0.4"
   }
 }

aws-python-flask-api/requirements.txt

@@ -1,3 +1 @@
-Flask==1.1.4
-Werkzeug==1.0.1
-markupsafe==2.0.1
+Flask==3.0.3

aws-python-flask-api/serverless.template.yml

@@ -1,6 +1,6 @@
 service: aws-python-flask-api
 
-frameworkVersion: '4'
+frameworkVersion: "4"
 
 custom:
   wsgi:
@@ -9,6 +9,7 @@ custom:
 provider:
   name: aws
   runtime: python3.12
+
 functions:
   api:
     handler: wsgi_handler.handler

aws-python-flask-api/serverless.yml

@@ -1,22 +1,19 @@
 <!--
 title: 'Serverless Framework Python Flask API backed by DynamoDB on AWS'
-description: 'This template demonstrates how to develop and deploy a simple Python Flask API service backed by DynamoDB running on AWS Lambda using the traditional Serverless Framework.'
+description: 'This template demonstrates how to develop and deploy a simple Python Flask API service backed by DynamoDB running on AWS Lambda using the Serverless Framework.'
 layout: Doc
-framework: v2
+framework: v4
 platform: AWS
 language: Python
 priority: 2
 authorLink: 'https://github.com/serverless'
-authorName: 'Serverless, inc.'
+authorName: 'Serverless, Inc.'
 authorAvatar: 'https://avatars1.githubusercontent.com/u/13742415?s=200&v=4'
 -->
 
 # Serverless Framework Python Flask API service backed by DynamoDB on AWS
 
-This template demonstrates how to develop and deploy a simple Python Flask API service, backed by DynamoDB, running on AWS Lambda using the traditional Serverless Framework.
-
-
-## Anatomy of the template
+This template demonstrates how to develop and deploy a simple Python Flask API service, backed by DynamoDB, running on AWS Lambda using the Serverless Framework.
 
 This template configures a single function, `api`, which is responsible for handling all incoming requests thanks to configured `http` events. To learn more about `http` event configuration options, please refer to [http event docs](https://www.serverless.com/framework/docs/providers/aws/events/apigateway/). As the events are configured in a way to accept all incoming requests, `Flask` framework is responsible for routing and handling requests internally. The implementation takes advantage of `serverless-wsgi`, which allows you to wrap WSGI applications such as Flask apps. To learn more about `serverless-wsgi`, please refer to corresponding [GitHub repository](https://github.com/logandk/serverless-wsgi). The template also relies on `serverless-python-requirements` plugin for packaging dependencies from `requirements.txt` file. For more details about `serverless-python-requirements` configuration, please refer to corresponding [GitHub repository](https://github.com/UnitedIncome/serverless-python-requirements).
 
@@ -28,7 +25,7 @@ Additionally, the template also handles provisioning of a DynamoDB database that
 
 In order to package your dependencies locally with `serverless-python-requirements`, you need to have `Python3.8` installed locally. You can create and activate a dedicated virtual environment with the following command:
 
-```bash
+```
 python3.8 -m venv ./venv
 source ./venv/bin/activate
 ```
@@ -37,14 +34,6 @@ Alternatively, you can also use `dockerizePip` configuration from `serverless-py
 
 ### Deployment
 
-This example is made to work with the Serverless Framework dashboard, which includes advanced features such as CI/CD, monitoring, metrics, etc.
-
-In order to deploy with dashboard, you need to first login with:
-
-```
-serverless login
-```
-
 install dependencies with:
 
 ```
@@ -59,41 +48,20 @@ serverless deploy
 
 After running deploy, you should see output similar to:
 
-```bash
-Serverless: Using Python specified in "runtime": python3.8
-Serverless: Packaging Python WSGI handler...
-Serverless: Generated requirements from /home/xxx/xxx/xxx/examples/aws-python-flask-dynamodb-api/requirements.txt in /home/xxx/xxx/xxx/examples/aws-python-flask-dynamodb-api/.serverless/requirements.txt...
-Serverless: Using static cache of requirements found at /home/xxx/.cache/serverless-python-requirements/62f10436f9a1bb8040df30ef2db5736c8015b18256bf0b6f1b0cbb2640030244_slspyc ...
-Serverless: Packaging service...
-Serverless: Excluding development dependencies...
-Serverless: Injecting required Python packages to package...
-Serverless: Creating Stack...
-Serverless: Checking Stack create progress...
-........
-Serverless: Stack create finished...
-Serverless: Uploading CloudFormation file to S3...
-Serverless: Uploading artifacts...
-Serverless: Uploading service aws-python-flask-dynamodb-api.zip file to S3 (1.3 MB)...
-Serverless: Validating template...
-Serverless: Updating Stack...
-Serverless: Checking Stack update progress...
-.................................
-Serverless: Stack update finished...
-Service Information
-service: aws-python-flask-dynamodb-api
-stage: dev
-region: us-east-1
-stack: aws-python-flask-dynamodb-api-dev
-resources: 12
-api keys:
-  None
+```
+Deploying "aws-python-flask-dynamodb-api" to stage "dev" (us-east-1)
+
+Using Python specified in "runtime": python3.12
+
+Packaging Python WSGI handler...
+
+✔ Service deployed to stack aws-python-flask-dynamodb-api-dev (123s)
+
 endpoints:
-  ANY - https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/
-  ANY - https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/{proxy+}
+  ANY - https://r9a04q5it7.execute-api.us-east-1.amazonaws.com/dev/
+  ANY - https://r9a04q5it7.execute-api.us-east-1.amazonaws.com/dev/{proxy+}
 functions:
-  api: aws-python-flask-dynamodb-api-dev-api
-layers:
-  None
+  api: aws-python-flask-dynamodb-api-dev-api (41 MB)
 ```
 
 _Note_: In current form, after deployment, your API is public and can be invoked by anyone. For production deployments, you might want to configure an authorizer. For details on how to do that, refer to [http event docs](https://www.serverless.com/framework/docs/providers/aws/events/apigateway/).
@@ -102,46 +70,40 @@ _Note_: In current form, after deployment, your API is public and can be invoked
 
 After successful deployment, you can create a new user by calling the corresponding endpoint:
 
-```bash
+```
 curl --request POST 'https://xxxxxx.execute-api.us-east-1.amazonaws.com/dev/users' --header 'Content-Type: application/json' --data-raw '{"name": "John", "userId": "someUserId"}'
 ```
 
 Which should result in the following response:
 
-```bash
-{"userId":"someUserId","name":"John"}
+```json
+{ "userId": "someUserId", "name": "John" }
 ```
 
 You can later retrieve the user by `userId` by calling the following endpoint:
 
-```bash
+```
 curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/users/someUserId
 ```
 
 Which should result in the following response:
 
-```bash
-{"userId":"someUserId","name":"John"}
-```
-
-If you try to retrieve user that does not exist, you should receive the following response:
-
-```bash
-{"error":"Could not find user with provided \"userId\""}
+```json
+{ "userId": "someUserId", "name": "John" }
 ```
 
 ### Local development
 
 Thanks to capabilities of `serverless-wsgi`, it is also possible to run your application locally, however, in order to do that, you will need to first install `werkzeug`, `boto3` dependencies, as well as all other dependencies listed in `requirements.txt`. It is recommended to use a dedicated virtual environment for that purpose. You can install all needed dependencies with the following commands:
 
-```bash
+```
 pip install werkzeug boto3
 pip install -r requirements.txt
 ```
 
 Additionally, you will need to emulate DynamoDB locally, which can be done by using `serverless-dynamodb-local` plugin. In order to do that, execute the following commands:
 
-```bash
+```
 serverless plugin install -n serverless-dynamodb-local
 serverless dynamodb install
 ```
@@ -150,7 +112,6 @@ It will add the plugin to `devDependencies` in `package.json` file as well as to
 
 You should also add the following config to `custom` section in `serverless.yml`:
 
-
 ```yml
 custom:
   (...)
@@ -163,7 +124,6 @@ custom:
 
 Additionally, we need to reconfigure DynamoDB Client to connect to our local instance of DynamoDB. We can take advantage of `IS_OFFLINE` environment variable set by `serverless-wsgi` plugin and replace:
 
-
 ```python
 dynamodb_client = boto3.client('dynamodb')
 ```
@@ -179,16 +139,17 @@ if os.environ.get('IS_OFFLINE'):
 
 Now you can start DynamoDB local with the following command:
 
-```bash
+```
 serverless dynamodb start
 ```
 
 At this point, you can run your application locally with the following command:
 
-```bash
+```
 serverless wsgi serve
 ```
 
 For additional local development capabilities of `serverless-wsgi` and `serverless-dynamodb-local` plugins, please refer to corresponding GitHub repositories:
-- https://github.com/logandk/serverless-wsgi 
+
+- https://github.com/logandk/serverless-wsgi
 - https://github.com/99x/serverless-dynamodb-local

aws-python-flask-dynamodb-api/README.md

@@ -4,7 +4,7 @@
   "description": "Example of a Python Flask API service backed by DynamoDB with traditional Serverless Framework",
   "author": "",
   "devDependencies": {
-    "serverless-python-requirements": "^6.0.1",
-    "serverless-wsgi": "^3.0.3"
+    "serverless-python-requirements": "^6.1.0",
+    "serverless-wsgi": "^3.0.4"
   }
 }