The Djangae Scaffold Project

This is a barebones Django project configured for use on App Engine using Djangae

To get started:

• Clone this repo (don't forget to change the origin to your own repo!)
• Run ./install_deps (this will pip install requirements, and download the App Engine SDK)
• Run ./rename_scaffold_app my_new_app_name to rename the 'scaffold' app (and all references to it)
• python manage.py checksecure --settings=scaffold.settings_live
• python manage.py runserver

The install_deps helper script will install dependencies into a 'sitepackages' folder which is added to the path. Each time you run it your sitepackages will be wiped out and reinstalled with pip. The SDK will only be downloaded the first time (as it's a large download).

Deployment

Create a Google App Engine project. Edit app.yaml and change application: djangae-scaffold to application: your-app-id. Then, if you're in the djangae-scaffold directory, run:

$ appcfg.py update ./

If you have two-factor authentication enabled in your Google account, run:

$ appcfg.py --oauth2 update ./

Custom Domains

There is currently a bug in App Engine which means that HSTS headers are stripped from responses served from a custom domain. If you're using HTTPS on a custom domain then you should make a request to Google to get your domain whitelisted for HSTS.

Troubleshooting

If you are on OS X and using Homebrew-ed Python, you might get the following error when running ./install_deps:

error: must supply either home or prefix/exec-prefix -- not both

This is a known issue and a possible workaround is to make an "empty prefix" by default by adding a ~/.pydistutils.cfg file with the following contents:

[install]
prefix=

For Windows

Comments some codes for install_deps

Sometimes the below command in install_deps does not work well, so you can comment them

for command in REQUIREMENTS:
    try:
        subprocess.check_output([where, command])
    except subprocess.CalledProcessError:
        raise RuntimeError("You must install the '%s' command" % command) 

pip and git settings

You need to insall pip and git first. Though you have already installed the pip, it's better to upgrade your pip with the command.

pip insatll --upgrae setuptools

Then, set Git path on your %PATH%, for example

set path=%path%;c:\Program Files (x86)\Git\bin

Do others

Now, do the following things

• Run ./install_deps (this will pip install requirements, and download the App Engine SDK)
• Run ./rename_scaffold_app.py my_new_app_name to rename the 'scaffold' app (and all references to it)