diff --git a/README.md b/README.md index 9b17340..821da16 100644 --- a/README.md +++ b/README.md @@ -13,18 +13,18 @@ products: This sample demonstrates a data cleaning pipeline with Azure Functions written in Python triggered off a HTTP event from Event Grid to perform some pandas cleaning and reconciliation of CSV files. Using this sample we demonstrate a real use case where this is used to perform cleaning tasks. -# Getting Started +## Getting Started -## Deploy to Azure +### Deploy to Azure -### Prerequisites +#### Prerequisites - Install Python 3.6+ - Install [Functions Core Tools](https://docs.microsoft.com/en-us/azure/azure-functions/functions-run-local#v2) - Install Docker - Note: If run on Windows, use Ubuntu WSL to run deploy script -### Steps +#### Steps - Deploy through Azure CLI - Open AZ CLI and run `az group create -l [region] -n [resourceGroupName]` to create a resource group in your Azure subscription (i.e. [region] could be westus2, eastus, etc.) @@ -34,7 +34,7 @@ Using this sample we demonstrate a real use case where this is used to perform c - [Create/Activate virtual environment](https://docs.microsoft.com/en-us/azure/azure-functions/functions-create-first-function-python#create-and-activate-a-virtual-environment) - Run `func azure functionapp publish [functionAppName] --build-native-deps` -## Test +### Test - Upload s1.csv file into c1raw container - Watch event grid trigger the CleanTrigger1 function and produce a "cleaned_s1_raw.csv" @@ -52,6 +52,6 @@ Using this sample we demonstrate a real use case where this is used to perform c - Watch it produce final.csv file - Can use a logic app to call the reconcile method with batch id's -# References +## References - [Create your first Python Function](https://docs.microsoft.com/en-us/azure/azure-functions/functions-create-first-function-python)