Setting Up Your Development Environment

Python 2.7/3 |Java 8/11 |PHP 5/7 |Ruby |Go 1.11 / 1.12+ |Node.js

To set up your environment for developing on Python 2:

1. Download and install the latest release of Python 2.

   See Python 2 Runtime Environment for a list of the supported versions.

2. Download, install, and then initialize the Cloud SDK. If you already have the Cloud SDK installed, run the gcloud components update command to update to the latest release.

   The Cloud SDK provides you the gcloud command-line tooling for deploying and managing your apps.

   By downloading, you agree to be bound by the Terms that govern use of the Cloud SDK for App Engine.

   Download and Install the Cloud SDK

   Note: Avoid using a package manager such as apt or yum to install the Cloud SDK.

3. Run the following command in your terminal to install the gcloud component that includes the App Engine extension for Python 2:

    gcloud components install app-engine-python
   

Installing optional tools

• For access to code, samples, libraries, and tools in GitHub, install Git:

  Download and install Git

• Install your preferred tooling or framework, for example you can use any of the following frameworks to develop your Python 2 app:

  • Flask
  • Django
  • Pyramid
  • Bottle
  • web.py
  • Tornado

• Run the following command to install the Extra Libraries component for Python 2, which includes the graphy and Django libraries:

    gcloud components install app-engine-python-extras
  

Installing support for appcfg

If you have previously used the original App Engine SDK and need to continue to use the deprecated appcfg command, you can download and install the original App Engine SDK by following the instructions below. Cloud SDK does not include the appcfg command.

Download and install the original App Engine SDK for Python 2.

Warning: The App Engine SDK, including the appcfg command, is now deprecated and you should move to Cloud SDK tooling, such as the gcloud command line.

To install the original local development server and the appcfg tooling, you can install the original App Engine SDK for Python 2.

Optional: Download and install the original App Engine SDK for Python

Linux

1. Download the App Engine SDK for Python:
   

   Download

   Version: 1.9.91 - 2020-05-11

   Size:

   53.8 MB

   SHA1 Checksum:

   36c802d46ccc7ea9b02bcaed40014f9ecbd1158c

2. To install on Linux:

   1. Unzip the google_appengine_1.9.91.zip file that you downloaded, for example:

      unzip google_appengine_1.9.91.zip

      There is no App Engine installation script that you need to run after unzipping the files.

   2. Add the google_appengine directory to your PATH:

      export PATH=$PATH:DIRECTORY_PATH/google_appengine/

   3. Make sure Python 2.7 is installed on your machine using the following command:

      /usr/bin/env python -V

      The output should look like this: Python 2.7.[NUMBER]. If Python 2.7 isn't installed, install it now using the installation instructions for your Linux distribution.

macOS

1. Download the App Engine SDK for Python:
   

   Download

   Version: 1.9.91 - 2020-05-11

   Size:

   70.3 MB

   SHA1 Checksum:

   dbd97e591b894d6906171a3d9f8ff263bce4f295

2. To install the SDK on macOS:

   1. In the Finder, click Go > Applications to open the Applications folder.
   2. Double click the GoogleAppEngineLauncher-1.9.91.dmg file that you downloaded to open it, then drag the GoogleAppEngineLauncher icon over to the Applications folder.
   3. Double-click GoogleAppEngineLauncher in the Application folder.
   4. When prompted to Make command symlinks, click OK. The symlinks allow you to run important SDK command-line tools in any terminal window.

      Important: The GoogleAppEngineLauncher is a convenient UI-based tool for running and deploying App Engine apps, but it does not provide all the features you'll need. You can use the equivalent gcloud command-line tool, for many of the tasks that you'll want to perform.

   5. Notice that the installation process above unpacks the contents of the App Engine SDK at the location:

      /usr/local/google_appengine

   6. The App Engine SDK requires Python 2.7, which is installed by default on Mac OS X 10.6 (Snow Leopard) or later. Verify your Mac's Python installation using the following command:

      /usr/bin/env python -V

      If the output looks like Python 2.7.[NUMBER] then you already have the correct Python version installed. Otherwise you can download and install Python 2.7 from the Python web site.

Windows

1. Download the App Engine SDK for Python:
   

   Download

   Version: 1.9.91 - 2020-05-11

   Size:

   59.9 MB

   SHA1 Checksum:

   6762df3e091c97d5961262c469af50ac2dc35be6

2. To install the SDK on Windows:

   1. Double-click the SDK file you downloaded (GoogleAppEngine-1.9.91.msi) and follow the prompts to install the SDK.
   2. You will need Python 2.7 to use the App Engine SDK, because the Development Server is a Python application. Download Python 2.7.X (don't use a higher version) from the Python web site.