upd: README

Author: ai-mindset

README.md

@@ -10,19 +10,41 @@ Back up and restore NHP Azure Table Storage (ATS) via JSON snapshots in Blob Sto
 
 ## Configuration
 
-Create a `.env` file in the repo root:
+Create a `.env` file in the repo root by copying and filling in the values below:
 
 ```bash
-export AZURE_STORAGE_ACCOUNT_NAME=<storage_name>
-export PROD_TABLE_NAME=<ats_name>
-export BACKUP_CONTAINER_NAME=<backup_container_name>
-export DEV_TABLE_NAME=<ats_dev_name>
+# Azure resources
+AZURE_STORAGE_ACCOUNT_NAME=<storage-name>      # Globally unique, lowercase letters+numbers, 3-24 chars
+AZURE_RESOURCE_GROUP_NAME=<resource-group>     # Existing resource group where resources are created
+AZURE_LOCATION=<region>                        # e.g. australiaeast; pick one near your users
+
+# Storage configuration
+AZURE_SKU=Standard_LRS                         # Cheapest; fine for dev/test and small prod workloads
+AZURE_STORAGE_KIND=StorageV2                   # General-purpose v2; supports blobs, queues, tables
+
+# Backup targets
+PROD_TABLE_NAME=<ats-name>                     # Production Azure Table Storage table to back up
+BACKUP_CONTAINER_NAME=<backup-container-name>  # Blob container for JSON snapshots
+DEV_TABLE_NAME=<ats-dev-name>                  # Dev/test table for safe restore experiments
+
+# Function App
+AZURE_FUNCTION_APP_NAME=<function-app-name>    # Globally unique, used in URLs and deployment
+AZURE_PYTHON_VERSION=3.13                      # Max version supported by Azure Functions; 3.14 is still in preview
+AZURE_FUNCTION_INSTANCE_MEMORY=2048            # Flex Consumption memory in MB; 2048 is a good default
 ```
 
 Windows users should omit `export` or use `set` instead.
+Notice that `AZURE_SKU` and `AZURE_STORAGE_KIND` default to `Standard_LRS` and `StorageV2` if omitted.
 
 ## Quick deploy
 
+
+### Automated deploy
+
+Run `uv run deploy.py` to interactively create the resource group, storage account,
+Function App, backup container, app settings, and publish the functions.
+Add `--yes` to skip confirmation prompts.
+
 This project uses **Azure Functions on Flex Consumption** (Python 3.13).
 
 ### 1. Generate `requirements.txt`
@@ -33,7 +55,7 @@ Azure's remote build uses pip, not uv. Compile a lockfile before every deploy:
 uv pip compile pyproject.toml -o requirements.txt
 ```
 
-### 1.5. Prepare `.funcignore`
+### 2. Prepare `.funcignore`
 
 Ensure `.funcignore` exists so the publish step skips your local venv and build artefacts:
 
@@ -51,10 +73,64 @@ tests/
 .github/
 ```
 
-### 2. Publish
+### 3. Azure resources and app settings
+
+<details>
+<summary><b>Click to expand: create storage account, Function App, and configure app settings</b></summary>
+
+Create the storage account. The name must be globally unique, lowercase letters and numbers only, 3–24 characters.
+
+```bash
+az storage account create \
+  --name "$AZURE_STORAGE_ACCOUNT_NAME" \
+  --resource-group "$AZURE_RESOURCE_GROUP_NAME" \
+  --location "$AZURE_LOCATION" \
+  --sku "$AZURE_SKU" \
+  --kind "$AZURE_STORAGE_KIND"
+```
+
+Create the backup container:
 
 ```bash
-func azure functionapp publish <function-app-name>
+az storage container create \
+  --name "$BACKUP_CONTAINER_NAME" \
+  --account-name "$AZURE_STORAGE_ACCOUNT_NAME" \
+  --auth-mode login
+```
+
+Create the Function App:
+
+```bash
+az functionapp create \
+  --resource-group "$AZURE_RESOURCE_GROUP_NAME" \
+  --name "$AZURE_FUNCTION_APP_NAME" \
+  --storage-account "$AZURE_STORAGE_ACCOUNT_NAME" \
+  --flexconsumption-location "$AZURE_LOCATION" \
+  --runtime python \
+  --runtime-version "$AZURE_PYTHON_VERSION" \
+  --functions-version 4 \
+  --instance-memory "$AZURE_FUNCTION_INSTANCE_MEMORY"
+```
+
+Configure app settings:
+
+```bash
+az functionapp config appsettings set \
+  --name "$AZURE_FUNCTION_APP_NAME" \
+  --resource-group "$AZURE_RESOURCE_GROUP_NAME" \
+  --settings \
+    "AZURE_STORAGE_ACCOUNT_NAME=$AZURE_STORAGE_ACCOUNT_NAME" \
+    "PROD_TABLE_NAME=$PROD_TABLE_NAME" \
+    "BACKUP_CONTAINER_NAME=$BACKUP_CONTAINER_NAME" \
+    "DEV_TABLE_NAME=$DEV_TABLE_NAME"
+```
+
+</details>
+
+### 4. Publish
+
+```bash
+func azure functionapp publish "$AZURE_FUNCTION_APP_NAME"
 ```
 
 The app contains two functions:
@@ -107,54 +183,45 @@ az storage blob download --account-name "$AZURE_STORAGE_ACCOUNT_NAME" \
 uv run --env-file .env python -m backup.core --restore snapshot.json --target-table <table_name>
 ```
 
-## Details
-
-<details>
-<summary><b>Azure Function setup (first time)</b></summary>
-
-```bash
-az functionapp create \
-  --resource-group <your-rg> \
-  --name <new-app-name> \
-  --storage-account <your-storage> \
-  --flexconsumption-location <region> \
-  --runtime python \
-  --runtime-version 3.13 \
-  --functions-version 4 \
-  --instance-memory 2048
-
-az functionapp config appsettings set \
-  --name <your-app-name> \
-  --resource-group <your-rg> \
-  --settings \
-    'AZURE_STORAGE_ACCOUNT_NAME=<your-account>' \
-    'PROD_TABLE_NAME=<your-table>' \
-    'BACKUP_CONTAINER_NAME=<backup-container-name>' \
-    'DEV_TABLE_NAME=<your-dev-table>'
-```
-
-</details>
+## Local testing
 
 <details>
-<summary><b>Local testing</b></summary>
+<summary><b>Click to expand</b></summary>
 
 Create `local.settings.json`:
 
-```json
-{
-  "IsEncrypted": false,
-  "Values": {
-    "AzureWebJobsStorage": "UseDevelopmentStorage=true",
-    "FUNCTIONS_WORKER_RUNTIME": "python",
-    "AZURE_FUNCTIONS_ENVIRONMENT": "Development",
-    "AZURE_STORAGE_ACCOUNT_NAME": "<your-account>",
-    "PROD_TABLE_NAME": "<your-table>",
-    "BACKUP_CONTAINER_NAME": "<your-container>",
-    "DEV_TABLE_NAME": "<your-dev-table>"
-  }
+```python
+import json
+import re
+
+env = {}
+with open(".env") as f:
+    for line in f:
+        line = line.strip()
+        if line and not line.startswith("#"):
+            key, _, value = line.partition("=")
+            env[key.strip()] = value.strip().strip("'\"")
+
+settings = {
+    "IsEncrypted": False,
+    "Values": {
+        "AzureWebJobsStorage": "UseDevelopmentStorage=true",
+        "FUNCTIONS_WORKER_RUNTIME": "python",
+        "AZURE_FUNCTIONS_ENVIRONMENT": "Development",
+        "AZURE_STORAGE_ACCOUNT_NAME": env["AZURE_STORAGE_ACCOUNT_NAME"],
+        "PROD_TABLE_NAME": env["PROD_TABLE_NAME"],
+        "BACKUP_CONTAINER_NAME": env["BACKUP_CONTAINER_NAME"],
+        "DEV_TABLE_NAME": env["DEV_TABLE_NAME"],
+    }
 }
+
+with open("local.settings.json", "w") as f:
+    json.dump(settings, f, indent=2)
+    f.write("\n")
 ```
 
+Save the above Python code in `local_settings.py` and run it: `uv run local_settings.py`
+
 Run the host:
 
 ```bash
@@ -169,8 +236,10 @@ curl http://localhost:7071/admin/functions/nhp_ats_backup -X POST -d '{}'
 
 </details>
 
+## Developer notes
+
 <details>
-<summary><b>Developer notes</b></summary>
+<summary><b>Click to expand</b></summary>
 
 - `backup/core.py` — library functions and non-interactive backup/restore
 - `backup/cli.py` — interactive workflow and snapshot resolution