python/README

   1 Copyright 2008 Google Inc.
   2 All rights reserved.
   3
   4 App Engine SDK - Development tools for Google App Engine
   5
   6 CONTENTS
   7 ========
   8
   9    * Installing on Mac OSX
  10    * Installing on Windows
  11    * Installing on Linux and other platforms
  12    * Running the SDK
  13    * Using the SDK
  14    * Using the App Engine Launcher
  15
  16
  17 INSTALLING ON Mac OSX
  18 =====================
  19 1) Download and install Python 2.5 from http://www.python.org/download/
  20 2) Download the SDK installer from http://code.google.com/appengine/downloads
  21 3) Install the SDK by double-clicking on the GoogleAppEngine.dmg file and
  22 running the installer.
  23
  24
  25 INSTALLING ON WINDOWS
  26 =====================
  27 1) Download and install Python 2.5 from http://www.python.org/download/
  28 2) Download the SDK installer from http://code.google.com/appengine/downloads
  29 3) Install the SDK by double-clicking on the GoogleAppEngine.msi file and
  30 running the installer.
  31
  32
  33 INSTALLING ON LINUX AND OTHER PLATFORMS
  34 ===============================
  35 1) Download and install Python 2.5 from http://www.python.org/download/
  36 2) Download the SDK zip file from http://code.google.com/appengine/downloads
  37 3) Unpack the zip file.
  38
  39
  40 RUNNING THE SDK
  41 =========================
  42 You can run the SDK with the following command:
  43
  44 dev_appserver.py [options] <application root>
  45
  46 Application root must be the path to the application to run in this server.
  47 Must contain a valid app.yaml or app.yml file.
  48
  49 Options:
  50   --address=ADDRESS, -a ADDRESS
  51                              Address to which this server should bind. (Default
  52                              localhost).
  53   --clear_datastore, -c      Clear the Datastore on startup. (Default false)
  54   --debug, -d                Use debug logging. (Default false)
  55   --help, -h                 View this helpful message.
  56   --port=PORT, -p PORT       Port for the server to run on. (Default 8080)
  57
  58   --allow_skipped_files      Allow access to files matched by app.yaml's
  59                              skipped_files (default False)
  60   --auth_domain              Authorization domain that this app runs in.
  61                              (Default gmail.com)
  62   --backends                 Run the dev_appserver with backends support
  63                              (multiprocess mode).
  64   --blobstore_path=DIR       Path to directory to use for storing Blobstore
  65                              file stub data.
  66   --clear_prospective_search Clear the Prospective Search subscription index
  67                              (Default false).
  68   --datastore_path=DS_FILE   Path to file to use for storing Datastore file
  69                              stub data.
  70                              (Default /tmp/dev_appserver.datastore)
  71   --debug_imports            Enables debug logging for module imports, showing
  72                              search paths used for finding modules and any
  73                              errors encountered during the import process.
  74   --default_partition        Default partition to use in the APPLICATION_ID.
  75                              (Default dev)
  76   --disable_static_caching   Never allow the browser to cache static files.
  77                              (Default enable if expiration set in app.yaml)
  78   --disable_task_running     When supplied, tasks will not be automatically
  79                              run after submission and must be run manually
  80                              in the local admin console.
  81   --enable_sendmail          Enable sendmail when SMTP not configured.
  82                              (Default false)
  83   --high_replication         Use the high replication datastore consistency
  84                              model. (Default false).
  85   --history_path=PATH        Path to use for storing Datastore history.
  86                              (Default /tmp/dev_appserver.datastore.history)
  87   --multiprocess_min_port    When running in multiprocess mode, specifies the
  88                              lowest port value to use when choosing ports. If
  89                              set to 0, select random ports.
  90                              (Default 9000)
  91   --mysql_host=HOSTNAME      MySQL database host that the rdbms API will use.
  92                              (Default localhost)
  93   --mysql_port=PORT          MySQL port to connect to.
  94                              (Default 3306)
  95   --mysql_user=USER          MySQL user to connect as.
  96                              (Default '')
  97   --mysql_password=PASSWORD  MySQL password to use.
  98                              (Default '')
  99   --mysql_socket=PATH        MySQL Unix socket file path.
 100                              (Default '%(mysql_socket)s')
 101   --require_indexes          Disallows queries that require composite indexes
 102                              not defined in index.yaml.
 103   --show_mail_body           Log the body of emails in mail stub.
 104                              (Default false)
 105   --skip_sdk_update_check    Skip checking for SDK updates. If false, fall back
 106                              to opt_in setting specified in .appcfg_nag
 107                              (Default false)
 108   --smtp_host=HOSTNAME       SMTP host to send test mail to.  Leaving this
 109                              unset will disable SMTP mail sending.
 110                              (Default '')
 111   --smtp_port=PORT           SMTP port to send test mail to.
 112                              (Default 25)
 113   --smtp_user=USER           SMTP user to connect as.  Stub will only attempt
 114                              to login if this field is non-empty.
 115                              (Default '').
 116   --smtp_password=PASSWORD   Password for SMTP server.
 117                              (Default '')
 118   --task_retry_seconds       How long to wait in seconds before retrying a
 119                              task after it fails during execution.
 120                              (Default '30')
 121   --use_sqlite               Use the new, SQLite based datastore stub.
 122                              (Default false)
 123
 124
 125
 126 USING THE SDK
 127 =======================
 128 For instructions on getting started with Google App Engine, please see the
 129 Google App Engine Getting Started Guide
 130
 131 http://code.google.com/appengine/docs/gettingstarted
 132
 133
 134 USING THE APP ENGINE LAUNCHER
 135 =============================
 136 The Windows and Mac OSX Python SDKs include an additional development tool
 137 called the App Engine Launcher.  This tool provides a simple graphical
 138 interface to create projects, run them locally, and deploy them to Google's App
 139 Engine servers. It can be used in place of the dev_appserver and appcfg
 140 command-line tools.
 141
 142 The Windows SDK can optionally install a desktop short-cut during
 143 installation. If you are missing the short-cut, you can find the launcher in
 144 the launcher subdirectory of your App Engine installation. The default
 145 location is
 146 C:\Program Files\Google\google_appengine\launcher\GoogleAppEngineLauncher.exe
 147
 148 In Mac OSX, the Launcher is installed by dragging it out of the .dmg to a
 149 location specified by the user. The Launcher contains the SDK inside of it.
 150 A typical drag-install destination for the Launcher and SDK is
 151 /Applications/GoogleAppEngineLauncher.app