Python Flask Restful API Skeleton for Google App Engine

A skeleton for building Python applications on Google App Engine with the Flask micro framework.

Test API

$ curl http://127.0.0.1:8080/
> Hello World!

$ curl http://127.0.0.1:8080/todo
> {
    "tasks": [
      {
        "description": "Milk, Cheese, Pizza, Fruit, Tylenol",
        "done": false,
        "id": 1,
        "title": "Buy groceries"
      },
      {
        "description": "Need to find a good Python tutorial on the web",
        "done": false,
        "id": 2,
        "title": "Learn Python"
      }
    ]
  }

Run Locally

1. Install the App Engine Python SDK. See the README file for directions. You'll need python 2.7 and pip 1.4 or later installed too.

2. Clone this repo with

   git clone [email protected]:alyssaq/flask-restful-api-appengine.git

3. Install dependencies in the project's lib directory. Note: App Engine can only import libraries from inside your project directory.

   pip install -r requirements.txt -t lib

4. Run this project locally using Google App Launcher or from the command line (symlinks can be created from the launcher):

   dev_appserver.py . --skip_sdk_update_check=yes

Visit the application at: http://localhost:8080

See the development server documentation for options when running dev_appserver.

Deploy

To deploy the application:

1. Use the Admin Console to create a project/app id. (App id and project id are identical)
2. Deploy the application:

   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 to customize.

Relational Databases and Datastore

To add persistence to your models, use NDB for scale. Consider CloudSQL if you need a relational database.

Installing Libraries

See the Third party libraries page for libraries that are already included in the SDK. To include SDK libraries, add them in your app.yaml file. Other than libraries included in the SDK, only pure python libraries may be added to an App Engine project.

Contributing changes

Fork, make changes, submit pull request :D

License

MIT