title | description | ms.topic | ms.date | ms.custom | robots |
---|---|---|---|---|---|
Quickstart: Create a Python app |
Get started with Azure App Service; deploy your first Python app to a Linux container in App Service. |
quickstart |
09/22/2020 |
seo-python-october2019, cli-validate, devx-track-python, mode-api |
noindex |
In this quickstart, you deploy a Python web app to App Service on Linux, Azure's highly scalable, self-patching web hosting service. You use the local Azure command-line interface (CLI) on a Mac, Linux, or Windows computer to deploy a sample with either the Flask or Django frameworks. The web app you configure uses a free App Service tier, so you incur no costs in the course of this article.
Tip
If you prefer using Visual Studio Code instead, follow our Visual Studio Code App Service quickstart.
- Have an Azure account with an active subscription. Create an account for free.
- Install Python 3.6 or higher.
- Install the Azure CLI 2.0.80 or higher, with which you run commands in any shell to provision and configure Azure resources.
Open a terminal window and check your Python version is 3.6 or higher:
python3 --version
py -3 --version
py -3 --version
Check that your Azure CLI version is 2.0.80 or higher:
az --version
Then sign in to Azure through the CLI:
az login
This command opens a browser to gather your credentials. When the command finishes, it shows JSON output containing information about your subscriptions.
Once signed in, you can run Azure commands with the Azure CLI to work with resources in your subscription.
Clone the sample repository using the following command and navigate into the sample folder. (Install git if you don't have git already.)
git clone https://github.com/Azure-Samples/python-docs-hello-world
Then navigate into that folder:
cd python-docs-hello-world
The sample contains framework-specific code that Azure App Service recognizes when starting the app. For more information, see Container startup process.
-
Make sure you're in the python-docs-hello-world folder.
-
Create a virtual environment and install dependencies:
[!include virtual environment setup]
If you encounter "[Errno 2] No such file or directory: 'requirements.txt'.", make sure you're in the python-docs-hello-world folder.
-
Run the development server.
flask run
By default, the server assumes that the app's entry module is in app.py, as used in the sample. (If you use a different module name, set the
FLASK_APP
environment variable to that name.) -
Open a web browser and go to the sample app at
http://localhost:5000/
. The app displays the message Hello, World!. -
In your terminal window, press Ctrl+C to exit the development server.
Deploy the code in your local folder (python-docs-hello-world) using the az webapp up
command:
az webapp up --sku F1 --name <app-name>
- If the
az
command isn't recognized, be sure you have the Azure CLI installed as described in Set up your initial environment. - If the
webapp
command isn't recognized, be sure that your Azure CLI version is 2.0.80 or higher. If it isn't, install the latest version. - Replace
<app_name>
with a name that's unique across all of Azure (valid characters area-z
,0-9
, and-
). A good pattern is to use a combination of your company name and an app identifier. - The
--sku F1
argument creates the web app on the Free pricing tier. Omit this argument to use a faster premium tier, which incurs an hourly cost. - You can optionally include the argument
--location <location-name>
where<location_name>
is an available Azure region. You can retrieve a list of allowable regions for your Azure account by running theaz account list-locations
command. - If you see the error, "Could not auto-detect the runtime stack of your app," make sure you're running the command in the python-docs-hello-world folder (Flask) or the python-docs-hello-django folder (Django) that contains the requirements.txt file. (See Troubleshooting auto-detect issues with az webapp up (GitHub).)
The command may take a few minutes to complete. While running, it provides messages about creating the resource group, the App Service plan and hosting app, configuring logging, then performing ZIP deployment. It then gives the message, "You can launch the app at http://<app-name>.azurewebsites.net", which is the app's URL on Azure.
[!include az webapp up command note]
Browse to the deployed application in your web browser at the URL http://<app-name>.azurewebsites.net
. It takes a few moments to start the app initially.
The Python sample code is running a Linux container in App Service using a built-in image.
Congratulations! You've deployed your Python app to App Service.
In this section, you make a small code change and then redeploy the code to Azure. The code change includes a print
statement to generate logging output that you work with in the next section.
Open app.py in an editor and update the hello
function to match the following code.
def hello():
print("Handling request to home page.")
return "Hello, Azure!"
Save your changes, then redeploy the app using the az webapp up
command again:
az webapp up
This command uses values that are cached locally in the .azure/config file, including the app name, resource group, and App Service plan.
Once deployment is complete, switch back to the browser window open to http://<app-name>.azurewebsites.net
. Refresh the page, which should display the modified message:
Tip
Visual Studio Code provides powerful extensions for Python and Azure App Service, which simplify the process of deploying Python web apps to App Service. For more information, see Deploy Python apps to App Service from Visual Studio Code.
You can access the console logs generated from inside the app and the container in which it runs. Logs include any output generated using print
statements.
To stream logs, run the az webapp log tail command:
az webapp log tail
You can also include the --logs
parameter with then az webapp up
command to automatically open the log stream on deployment.
Refresh the app in the browser to generate console logs, which include messages describing HTTP requests to the app. If no output appears immediately, try again in 30 seconds.
You can also inspect the log files from the browser at https://<app-name>.scm.azurewebsites.net/api/logs/docker
.
To stop log streaming at any time, press Ctrl+C in the terminal.
Go to the Azure portal to manage the app you created. Search for and select App Services.
Select the name of your Azure app.
Selecting the app opens its Overview page, where you can perform basic management tasks like browse, stop, start, restart, and delete.
The App Service menu provides different pages for configuring your app.
In the preceding steps, you created Azure resources in a resource group. The resource group has a name like "appsvc_rg_Linux_CentralUS" depending on your location. If you use an App Service SKU other than the free F1 tier, these resources incur ongoing costs (see App Service pricing).
If you don't expect to need these resources in the future, delete the resource group by running the following command:
az group delete --no-wait
The command uses the resource group name cached in the .azure/config file.
The --no-wait
argument allows the command to return before the operation is complete.
[!div class="nextstepaction"] Configure Python app
[!div class="nextstepaction"] Add user sign-in to a Python web app
[!div class="nextstepaction"] Tutorial: Run Python app in custom container