Merge pull request googlearchive#3 from proppy/master

simpler skeleton

Author: Logan

.gitignore

@@ -1,6 +1,5 @@
 *.pyc
-# don't include Flask and depedencies
-server/lib/*
-# include README so user doesn't have to create this dir
-!server/lib/README.txt
+# don't include third-party dependencies.
+lib/
+!lib/README.md
 .DS_Store

README.md

@@ -14,19 +14,19 @@ See the README file for directions. You'll need python 2.7 and [pip 1.4 or later
 2. Clone this repo with
 
    ```
-   git clone <project URL>
+   git clone https://github.com/GoogleCloudPlatform/appengine-python-flask-skeleton.git
    ```
-3. Install dependencies in the project's server/lib directory - App Engine
-   can only import libraries from inside your project directory.
+3. Install dependencies in the project's lib directory.
+   Note: App Engine can only import libraries from inside your project directory.
 
    ```
-   cd <project_directory>
-   pip install -r requirements.txt -t server/lib
+   cd appengine-python-flask-skeleton
+   pip install -r requirements.txt -t lib
    ```
 4. Run this project locally from the command line:
 
    ```
-   dev_appserver.py <projectDirectory>
+   dev_appserver.py .
    ```
 
 Visit the application [http://localhost:8080](http://localhost:8080)
@@ -43,12 +43,12 @@ To deploy the application:
    application](https://developers.google.com/appengine/docs/python/tools/uploadinganapp) with
 
    ```
-   appcfg.py -A <your-project-id> --oauth2 update [projectDirectory]
+   appcfg.py -A <your-project-id> --oauth2 update .
    ```
 1. Congratulations!  Your application is now live at your-app-id.appspot.com
 
 ## Next Steps
-This skeleton includes TODO markers to help you find basic areas you will want
+This skeleton includes `TODO` markers to help you find basic areas you will want
 to customize.
 
 ### Relational Databases and Datastore
@@ -76,4 +76,4 @@ See [CONTRIB.md](CONTRIB.md)
 See [LICENSE](LICENSE)
 
 ## Author
-Logan Henriquez
+Logan Henriquez and Johan Euphrosine

app.yaml

@@ -6,24 +6,19 @@
 # TODO: Enter your application id below. If you have signed up
 # using cloud.google.com/console use the "project id" for your application
 # id.
-application: your-app-or-project-id-here
+application: your-application-id-here
 version: 1
 runtime: python27
 api_version: 1
 threadsafe: yes
 
-# Handlers tell app engine how to route requests to your application.
+# Handlers define how to route requests to your application.
 handlers:
 
-# Route requests to static files (and subdirectories) in the listed
-# directories.
-- url: /static
-  static_dir: static
-
-# Make robots.txt accessible at the root URL.
-- url: /robots.txt
-  static_files: static/robots.txt
-  upload: static/robots.txt
+# App Engine serves and caches static files contained in the listed directories
+# (and subdirectories). Uncomment and set the directory as needed.
+#- url: /client
+#  static_dir: client
 
 # This handler tells app engine how to route requests to a WSGI application.
 # The script value is in the format <path.to.module>.<wsgi_application>
@@ -37,10 +32,7 @@ handlers:
 # a list of libraries included in the SDK.  Third party libs that are *not* part
 # of the App Engine SDK don't need to be listed here, instead add them to your
 # project directory, either as a git submodule or as a plain subdirectory.
-# Note that dependencies must be located in your project directory - packages
-# installed in the Python environment are not loaded by the App Engine development
-# server or deployment tools.
 # TODO: List any other App Engine SDK libs you may need here.
-# libraries:
-# - name: pycrypto
-#   version: latest
+#libraries:
+#- name: jinja2
+#  version: latest

appengine_config.py

@@ -1,8 +1,6 @@
-import os
+"""`appengine_config` gets loaded when starting a new application instance."""
 import sys
-
-# required to load libraries under server/lib that Flask depends on
-app_root_dir = os.path.dirname(__file__)
-server_lib_dir = os.path.join(app_root_dir, 'server/lib')
-if server_lib_dir not in sys.path:
-  sys.path.insert(0, server_lib_dir)
+import os.path
+# add `lib` subdirectory to `sys.path`, so our `main` module can load
+# third-party libraries.
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), 'lib'))

lib/README.md

@@ -0,0 +1 @@
+This directory contains third-party dependencies installed with `pip`.

main.py

@@ -1,21 +1,19 @@
-""" main.py is the top level script.
+"""`main` is the top level module for your Flask application."""
 
-Return "Hello World" at the root URL.
-"""
-
-import os
-import sys
-
-# sys.path includes 'server/lib' due to appengine_config.py
+# Import the Flask Framework
 from flask import Flask
-from flask import render_template
-app = Flask(__name__.split('.')[0])
+app = Flask(__name__)
+# Note: We don't need to call run() since our application is embedded within
+# the App Engine WSGI application server.
 
 
 @app.route('/')
-@app.route('/<name>')
-def hello(name=None):
-  """ Return hello template at application root URL."""
-  return render_template('hello.html', name=name)
+def hello():
+    """Return a friendly HTTP greeting."""
+    return 'Hello World!'
 
 
+@app.errorhandler(404)
+def page_not_found(e):
+    """Return a custom 404 error."""
+    return 'Sorry, Nothing at this URL.', 404

requirements.txt

@@ -1,4 +1,7 @@
-# This requirements file lists all dependecies for this project.
-# Run 'pip install -r requirements.txt -t server/lib' to install these dependencies
-# in this project's server/lib directory.
+# This requirements file lists all third-party dependencies for this project.
+#
+# Run 'pip install -r requirements.txt -t lib/' to install these dependencies
+# in `lib/` subdirectory.
+#
+# Note: The `lib` directory is added to `sys.path` by `appengine_config.py`.
 Flask==0.10