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