sync with main

Author: cephalin

.devcontainer/README.md

@@ -1,5 +1,10 @@
-# Dev container
+# .devcontainer directory
 
-This `.devcontainer` directory contains the configuration for a [dev container](https://docs.github.com/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers). It lets you open the repository in a [GitHub codespace](https://docs.github.com/codespaces/overview).
+This `.devcontainer` directory contains the configuration for a [dev container](https://docs.github.com/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers) and isn't used by the sample application.
 
-The dev container is configured to have the [Azure Developer CLI](https://learn.microsoft.com/azure/developer/azure-developer-cli/overview), so you can run `azd` commands directly.
+The dev container configuration lets you open the repository in a [GitHub codespace](https://docs.github.com/codespaces/overview) or a dev container in Visual Studio Code. For your convenience, the dev container is configured with the following:
+
+- Python
+- PostgreSQL
+- Redis
+- [Azure Developer CLI](https://learn.microsoft.com/azure/developer/azure-developer-cli/overview) (so you can run `azd` commands directly).

.devcontainer/devcontainer.json

@@ -1,11 +1,11 @@
 {
-	"name": "msdocs-flask-postgresql-sample-app",
+	"name": "python-app-service-postgresql-redis-infra",
 	"dockerComposeFile": "docker-compose.yml",
 	"service": "app",
 	"workspaceFolder": "/workspace",
 	"features": {
 		"ghcr.io/azure/azure-dev/azd:latest": {}
-	},
+    },
 	"customizations": {
 		"vscode": {
 			// Add the IDs of extensions you want installed when the container is created.
@@ -51,9 +51,9 @@
 			}
 		}
 	},
-	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// Use 'forwardPorts' to make a list of ports inside the container available locally. 5000 is for Flask, 8000 is for Django, and 5432 is for PostgreSQL.
 	"forwardPorts": [
-		5000, 5432
+		8000, 5000, 5432
 	],
 	// Use 'postCreateCommand' to run commands after the container is created.
 	// "postCreateCommand": "",

.devcontainer/docker-compose.yml

@@ -28,5 +28,9 @@ services:
     # Add "forwardPorts": ["5432"] to **devcontainer.json** to forward PostgreSQL locally.
     # (Adding the "ports" property to this file will not forward from a Codespace.)
 
+  redis:
+    image: redis
+    restart: unless-stopped
+
 volumes:
   postgres-data:

.env.sample

@@ -1,6 +1,6 @@
 FLASK_DEBUG=True
-DBNAME=<database name>
+DBNAME=<database-name>
 DBHOST=<database-hostname>
 DBUSER=<db-user-name>
 DBPASS=<db-password>
-SECRET_KEY=<secret key>
+CACHELOCATION=<redis-cache-url>

.env.sample.devcontainer

@@ -3,4 +3,4 @@ DBNAME=app
 DBHOST=localhost
 DBUSER=app_user
 DBPASS=app_password
-SECRET_KEY=flask-insecure-secret-key
+CACHELOCATION=redis://redis:6379/0

.github/workflows/python-test.yaml

@@ -17,7 +17,7 @@ jobs:
         python_version: ["3.8", "3.9", "3.10", "3.11"]
     services:
       postgres:
-        image: postgres:11
+        image: postgres:12
         env:
           POSTGRES_PASSWORD: postgres
         ports:

.gitignore

@@ -128,4 +128,4 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
-.azure
+.azure

README.md

@@ -16,64 +16,47 @@ The [requirements.txt](./requirements.txt) has the following packages, all used
 | [python-dotenv](https://pypi.org/project/python-dotenv/) | Read key-value pairs from .env file and set them as environment variables. In this sample app, those variables describe how to connect to the database locally. <br><br> Flask's [dotenv support](https://flask.palletsprojects.com/en/2.1.x/cli/#environment-variables-from-dotenv) sets environment variables automatically from an `.env` file. |
 | [flask_wtf](https://pypi.org/project/Flask-WTF/) | Form rendering, validation, and CSRF protection for Flask with WTForms. Uses CSRFProtect extension. |
 
-## Using this project with the Azure Developer CLI (azd)
+## Run the sample
 
-This project is designed to work well with the [Azure Developer CLI](https://learn.microsoft.com/azure/developer/azure-developer-cli/overview),
-which makes it easier to develop apps locally, deploy them to Azure, and monitor them.
+This project has a [dev container configuration](.devcontainer/), which makes it easier to develop apps locally, deploy them to Azure, and monitor them. The easiest way to run this sample application is inside a GitHub codespace. Follow these steps:
 
-### Local development
+1. Fork this repository to your account. For instructions, see [Fork a repo](https://docs.github.com/get-started/quickstart/fork-a-repo).
 
-This project has Dev Container support, so you can open it in Github Codespaces or local VS Code with the Dev Containers extension.
+1. From the repository root of your fork, select **Code** > **Codespaces** > **+**.
 
-🎥 [Watch a screencast of running the app in Github Codespaces.](https://www.youtube.com/watch?v=r6Hnp9RXUpY)
-
-Steps for running the server:
-
-1. (Optional) If you're unable to open the Dev Container, [create a Python virtual environment](https://docs.python.org/3/tutorial/venv.html#creating-virtual-environments) and activate the virtual environment.
-
-2. Install the requirements:
+1. In the codespace terminal, run the following commands:
 
     ```shell
+    # Install requirements
     python3 -m pip install -r requirements.txt
-    ```
-
-3. Create an `.env` file using `.env.sample` as a guide. Set the value of `DBNAME` to the name of an existing database in your local PostgreSQL instance. Set the values of `DBHOST`, `DBUSER`, and `DBPASS` as appropriate for your local PostgreSQL instance. If you're in the Dev Container, copy the values from `.env.sample.devcontainer`.
-
-4. In the `.env` file, fill in a secret value for `SECRET_KEY`. You can use this command to generate an appropriate value:
-
-    ```shell
-    python -c 'import secrets; print(secrets.token_hex())'
-    ```
-
-5. Run the migrations:
-
-    ```shell
+    # Create .env with environment variables
+    cp .env.sample.devcontainer .env
+    # Run database migrations
     python3 -m flask db upgrade
-    ```
-
-6. Run the local server: (or use VS Code "Run" button and select "Run server")
-
-    ```shell
+    # Start the development server
     python3 -m flask run
     ```
 
-### Deployment
+1. When you see the message `Your application running on port 8000 is available.`, click **Open in Browser**.
+
+### Quick deploy
 
-This repo is set up for deployment on Azure App Service (w/PostGreSQL server) using the configuration files in the `infra` folder.
+This project is designed to work well with the [Azure Developer CLI](https://learn.microsoft.com/azure/developer/azure-developer-cli/overview), which makes it easier to develop apps locally, deploy them to Azure, and monitor them. 
 
-🎥 [Watch a screencast of deploying and re-deploying the app.](https://www.youtube.com/watch?v=r6Hnp9RXUpY)
+🎥 Watch a deployment of the code in [this screencast](https://www
+.youtube.com/watch?v=JDlZ4TgPKYc).
 
 Steps for deployment:
 
 1. Sign up for a [free Azure account](https://azure.microsoft.com/free/)
-2. Install the [Azure Dev CLI](https://learn.microsoft.com/azure/developer/azure-developer-cli/install-azd). (If you opened this repository in a Dev Container, that part will be done for you.)
+2. Install the [Azure Dev CLI](https://learn.microsoft.com/azure/developer/azure-developer-cli/install-azd). (If you opened this repository in a Dev Container, it's already installed for you.)
 3. Initialize a new `azd` environment:
 
     ```shell
     azd init
     ```
 
-    It will prompt you to provide a name (like "flask-app") that will later be used in the name of the deployed resources.
+    It will prompt you to provide a name (like "flask-app"), which will later be used in the name of the deployed resources.
 
 4. Provision and deploy all the resources:
 
@@ -93,25 +76,6 @@ Steps for deployment:
     azd deploy
     ```
 
-### CI/CD pipeline
-
-This project includes a Github workflow for deploying the resources to Azure
-on every push. That workflow requires several Azure-related authentication secrets to be stored as Github action secrets. To set that up, run:
-
-```shell
-azd pipeline config
-```
-
-### Monitoring
-
-The deployed resources include a Log Analytics workspace with an Application Insights dashboard to measure metrics like server response time.
-
-To open that dashboard, just run:
-
-```shell
-azd monitor --overview
-```
-
 ## Getting help
 
 If you're working with this project and running into issues, please post in [Issues](/issues).