Quickstart for Python 3 in the App Engine Standard Environment

This quickstart shows how to deploy a sample app on App Engine. If you want to learn about coding an app for App Engine, see Building an App.

Costs

There are no costs associated with running this guide. Running this sample app alone does not exceed your free quota.

Before you begin

Before running and deploying this sample, take the following steps:

  1. Use the GCP Console to create a new GCP project, create an App Engine app, and enable billing:
    Go to App Engine

    When prompted, select the region where you want your App Engine app located and then enable billing.

  2. Install the following prerequisites locally:
    1. Download and install git.
    2. Prepare your environment for Python development.
    3. Download and install the Cloud SDK. Follow the instructions in the Cloud SDK page to initialize and set your GCP project ID in the gcloud command-line tool:
      Download the SDK
  3. Alternatively: You can use Google Cloud Shell, which comes with git and Cloud SDK already installed, and many other features, such as language support and code editors.

    After Cloud Shell is launched, you can proceed with the rest of this tutorial and execute your commands within Cloud Shell.

App Engine locations

App Engine is regional, which means the infrastructure that runs your apps is located in a specific region and is managed by Google to be redundantly available across all the zones within that region.

Meeting your latency, availability, or durability requirements are primary factors for selecting the region where your apps are run. You can generally select the region nearest to your app's users but you should consider the location of the other GCP products and services that are used by your app. Using services across multiple locations can affect your app's latency as well as pricing.

App Engine is available in the following regions:

  • northamerica-northeast1 (Montréal)
  • us-central (Iowa)
  • us-west2 (Los Angeles)
  • us-east1 (South Carolina)
  • us-east4 (Northern Virginia)
  • southamerica-east1 (São Paulo) *
  • europe-west (Belgium)
  • europe-west2 (London)
  • europe-west3 (Frankfurt)
  • asia-northeast1 (Tokyo)
  • asia-east2 (Hong Kong)
  • asia-south1 (Mumbai)
  • australia-southeast1 (Sydney)

* For customers using the São Paulo region, all regional product SLAs remain in force. However, multi-region and cross-region functionality that span across North America and South America might temporarily have reduced availability or performance.

You cannot change an app's region after you set it.

If you already created an App Engine application, you can view the region by running the gcloud app describe command or opening the App Engine Dashboard in the GCP Console. The region of your App Engine application is listed under http://[YOUR_PROJECT_ID].appspot.com.

This quickstart demonstrates a simple Python app written with the Flask web framework that can be deployed to App Engine. Although this sample uses Flask, you can use any web framework that satisfies the requirements above. Alternative frameworks include Django, Pyramid, Bottle, and web.py.

Download the Hello World app

We've created a simple Hello World app for Python 3.7 so you can quickly get a feel for deploying an app to the App Engine standard environment. Follow these steps from a command line to download Hello World to your local machine.

Download the sample app and navigate into the app directory:

  1. Clone the Hello World sample app repository to your local machine.

    git clone https://github.com/GoogleCloudPlatform/python-docs-samples
    

    Alternatively, you can download the sample as a zip file and extract it.

  2. Change to the directory that contains the sample code.

    cd python-docs-samples/appengine/standard_python37/hello_world
    

Run Hello World on your local machine

To run the Hello World app on your local computer:

Mac OS / Linux

  1. Create an isolated Python environment in a directory external to your project and activate it:
    virtualenv env
    source env/bin/activate
  2. Navigate to your project directory and install dependencies:
    cd YOUR_PROJECT
    pip install  -r requirements.txt
  3. Run the application:
    python main.py
  4. In your web browser, enter the following address:
    http://localhost:8080

Windows

Use Powershell to run your Python packages.

  1. Locate your installation of Powershell.
  2. Right-click on the shortcut to Powershell and start it as an administrator.
  3. Create an isolated Python environment in a directory external to your project and activate it:
    virtualenv env
    env\Scripts\activate
  4. Navigate to your project directory and install dependencies:
    cd YOUR_PROJECT
    pip install -r requirements.txt
  5. Run the application:
    python main.py
  6. In your web browser, enter the following address:
    http://localhost:8080

You can see the Hello World message from the sample app displayed in the page.

In your terminal window, press Ctrl+C to exit the web server.

Deploy and run Hello World on App Engine

To deploy your app to the App Engine standard environment:

  1. Deploy the Hello World app by running the following command from the standard_python37/hello_world directory:
    gcloud app deploy
    Learn about the optional flags.

    Common gcloud command flags

    • Include the --version flag to specify an ID that uniquely identifies that version of your app, otherwise one is generated for you. Example: --version [YOUR_VERSION_ID]
    • Include the --project flag to specify an alternate GCP project ID to what you initialized as the default in the gcloud tool. Example: --project [YOUR_PROJECT_ID]

    Example:

    gcloud app deploy --version pre-prod-5 --project my-sample-app

    To learn more about deploying your app from the command line, see Testing and Deploying Your App . For a list of all the command flags, see the gcloud app deploy reference.

  2. Launch your browser and view the app at http://YOUR_PROJECT_ID.appspot.com.
    gcloud app browse
This time, the page that displays the Hello World message is delivered by a web server running on an App Engine instance.

Congratulations! You've deployed your first Python 3.7 app to App Engine standard environment!

See the following sections for information about cleaning up as well as links to the possible next steps that you can take.

Clean up

To avoid incurring charges, you can delete your GCP project to stop billing for all the resources used within that project.

  1. In the GCP Console, go to the Projects page.

    Go to the Projects page

  2. In the project list, select the project you want to delete and click Delete project. After selecting the checkbox next to the project name, click
      Delete project
  3. In the dialog, type the project ID, and then click Shut down to delete the project.

What's next

Learn the whole platform

Now that you know what it's like to develop and deploy App Engine apps, you can stretch out and see the rest of GCP. You already have the Cloud SDK installed and that gives you the tools to interact with products like Cloud SQL, Cloud Storage, Cloud Datastore, and more.

Learn about the App Engine standard environment

Here are some topics to help continue your learning about App Engine.

Was this page helpful? Let us know how we did:

Send feedback about...

App Engine standard environment for Python 3 docs