Merge branch 'main' of https://github.com/pamelafox/msdocs-flask-postgresql-sample-app-azd

Author: pamelafox

.env.sample

@@ -2,4 +2,5 @@ FLASK_DEBUG=True
 DBNAME=<database name>
 DBHOST=<database-hostname>
 DBUSER=<db-user-name>
-DBPASS=<db-password>
+DBPASS=<db-password>
+SECRET_KEY=<secret key>

.env.sample.devcontainer

@@ -3,3 +3,4 @@ DBNAME=app
 DBHOST=localhost
 DBUSER=app_user
 DBPASS=app_password
+SECRET_KEY=flask-insecure-secret-key

.gitattributes

@@ -0,0 +1,3 @@
+* text=auto eol=lf
+*.{cmd,[cC][mM][dD]} text eol=crlf
+*.{bat,[bB][aA][tT]} text eol=crlf

.github/workflows/python-test.yaml

@@ -51,3 +51,4 @@ jobs:
             DBHOST: localhost
             DBUSER: postgres
             DBPASS: postgres
+            SECRET_KEY: flask-insecure-key-${{ github.run_id }}-${{ github.run_attempt }}

README.md

@@ -23,29 +23,35 @@ which makes it easier to develop apps locally, deploy them to Azure, and monitor
 
 ### Local development
 
-This project has devcontainer support, so you can open it in Github Codespaces or local VS Code with the Dev Containers extension.
+This project has Dev Container support, so you can open it in Github Codespaces or local VS Code with the Dev Containers extension.
 
 🎥 [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 devcontainer, [create a Python virtual environment](https://docs.python.org/3/tutorial/venv.html#creating-virtual-environments) and activate that.
+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 that.
 
 2. Install the requirements:
 
     ```shell
     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 devcontainer, copy the values from `.env.sample.devcontainer`.
+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. Run the migrations:
+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
     python3 -m flask db upgrade
     ```
 
-5. Run the local server: (or use VS Code "Run" button and select "Run server")
+6. Run the local server: (or use VS Code "Run" button and select "Run server")
 
     ```shell
     python3 -m flask run
@@ -60,20 +66,28 @@ This repo is set up for deployment on Azure App Service (w/PostGreSQL server) us
 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 devcontainer, that part will be done for you.)
-3. Provision and deploy all the resources:
+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.)
+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.
+
+4. Provision and deploy all the resources:
 
     ```shell
     azd up
     ```
 
-    It will prompt you to login and to provide a name (like "flask-app") and location (like "eastus"). Then it will provision the resources in your account and deploy the latest code. If you get an error with deployment, changing the location (like to "centralus") can help, as there are availability constraints for some of the resources.
+    It will prompt you to login, pick a subscription, and provide a location (like "eastus"). Then it will provision the resources in your account and deploy the latest code. If you get an error with deployment, changing the location (like to "centralus") can help, as there may be availability constraints for some of the resources.
 
-4. When `azd` has finished deploying, you'll see an endpoint URI in the command output. Visit that URI, and you should see the front page of the restaurant review app! 🎉 If you see an error, open the Azure Portal from the URL in the command output, navigate to the App Service, select Logstream, and check the logs for any errors.
+5. When `azd` has finished deploying, you'll see an endpoint URI in the command output. Visit that URI, and you should see the front page of the restaurant review app! 🎉 If you see an error, open the Azure Portal from the URL in the command output, navigate to the App Service, select Logstream, and check the logs for any errors.
 
     ![Screenshot of Flask restaurants website](screenshot_website.png)
 
-5. When you've made any changes to the app code, you can just run:
+6. When you've made any changes to the app code, you can just run:
 
     ```shell
     azd deploy

azureproject/production.py

@@ -1,7 +1,7 @@
 import os
 
 # SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = os.getenv('SECRET_KEY', 'flask-insecure-7ppocbnx@w71dcuinn*t^_mzal(t@o01v3fee27g%rg18fc5d@')
+SECRET_KEY = os.getenv('SECRET_KEY')
 
 ALLOWED_HOSTS = [os.environ['WEBSITE_HOSTNAME']] if 'WEBSITE_HOSTNAME' in os.environ else []
 CSRF_TRUSTED_ORIGINS = ['https://' + os.environ['WEBSITE_HOSTNAME']] if 'WEBSITE_HOSTNAME' in os.environ else []