michilu/gae-tap repository overview

⁠A full stack framework for the Google App Engine -based

Let's finish the work quickly and go TAP BEER!

Looking for sponsors:

1. $120 - I will get 30L barrel beer!!!⁠
2. $60 - I will get 15L barrel beer!! ⁠
3. $12 - I will get 1 pint beer! ⁠
4. $6 - I will get 1/2 pint beer! ⁠

⁠Status

• Travis CI⁠
• Wercker CI⁠
• Code Health⁠

⁠Features

Supports:

• Google App Engine / Python 2.7⁠
  • Google Cloud Endpoints API⁠
  • NDB Asynchronous Operation⁠
    • Python NDB Datastore API⁠
  • Python Module Configuration⁠
• Google Analytics for feature phone⁠
• I18N / Python, HTML and JavaScript / babel⁠
• Japanese han-kaku characters / 半角 / zenhan-py⁠
• OAuth login / gae-simpleauth⁠
• Google OAuth 2.0⁠ authentication-based Users API (alternate of Google App Engine Users API⁠)
• generating sitemaps
• sessions⁠
• Google Cloud Endpoints API as a CRUD, avoid method naming conflict in implemented with multiple classes
• Endpoints Proto Datastore API⁠

Low cost operating:

• Google Drive Spreadsheets as a database via Google Visualization API
• Google Drive Form-based feedback system
• hosting as a proxy
  • DropBox
  • Google Drive
• hostname-based multitenancy
  • supports robots.txt
• just a few costs permanent caching and key-value store via taskqueue API
• minimum OAuth accounting
• redirecting to Google URL Shortener

Performance:

• pre-compiling jinja2 templates to Python byte code / jinja2precompiler⁠
• uglify-js⁠

Coding:

• CoffeeScript⁠
• HAML⁠
• SASS⁠ / compass⁠

Development:

• AngularJS⁠

• Appstats⁠

• Jinja2 2.6⁠

• Twitter bootstrap⁠

• webapp2⁠

• file system event-based automation building on Mac OS X 10.7+⁠

• Docker⁠

Testing:

• py.test⁠
• coverage of tests / pytest-cov⁠
• karma⁠

Utils:

• CORS
• CSRF guard
• HMAC
• e-mail reports of errors
• fanstatic
• handling taskqueue
• managing cache records
• memoize
• ring buffer
• token bucket

Continuous Integration Supports:

• Travis CI⁠
• Wercker CI⁠

⁠Set up

$ git clone --depth 1 https://github.com/MiCHiLU/gae-tap.git
$ cd gae-tap
$ bundle install
$ npm install
$ mkvirtualenv --python=`which python2.7` gae-tap
(gae-tap)$ pip install -r requirements.txt
(gae-tap)$ pip install -r requirements-gae.txt

⁠Set environ

It need the GOOGLE_APPENGINE environ args. Default GOOGLE_APPENGINE as below:

GOOGLE_APPENGINE=$HOME/google-cloud-sdk/platform/google_appengine

If you want to set other path, define GOOGLE_APPENGINE in environ as below:

$ GOOGLE_APPENGINE=<path to your gae> make

⁠Docker

or, Quickly set up environment via Docker:

$ docker pull michilu/gae-tap

⁠First time build

First, you must be build core library:

(gae-tap)$ (cd gae/tap && make release)

Then, if you want to add templates of gae-tap to git repository:

$ git add \
  gae/site-packages/tap_templates_compiled.zip \
  gae/tap/static/js/admin_response_cache.js \
  gae/tap/static/js/admin_response_cache.min.js \
  gae/tap/static/js/error_page.js \
  gae/tap/static/js/error_page.min.js \
  gae/tap/static/js/utils.js \
  gae/tap/static/js/utils.min.js

Or, update core library from releases:

1. Download gaetap-<release-number>.zip file from https://github.com/MiCHiLU/gae-tap/releases⁠
2. Then replace with files and directories in your repository.

If you want to start a new project with make scaffold, as below:

$ make scaffold
your project name, default 'gae-tap':     <type your project name>
your github user name, default 'MiCHiLU': <type your github user name>
your app-id, default 'gae-tap':           <type your app-id>

⁠Build and Test

(gae-tap)$ make

⁠Run development server

(gae-tap)$ make runserver

then access to:

• admin server: http://localhost:8000⁠
• instance server: http://localhost:8080⁠
• API Explorer: http://localhost:8080/_ah/api/explorer⁠

⁠iPython shell with the Google App Engine environment

First, you must be install iPython:

(gae-tap)$ pip install ipython

Then, type make shell command as below:

(gae-tap)$ make shell
Python 2.7.5 (default, Mar  9 2014, 22:15:05)
IPython 2.3.1 -- An enhanced Interactive Python.
Doctest mode is: ON
>>>

Access to the Datastore on the development environment in the iPython shell:

(gae-tap)$ make shell
>>> from google.appengine.ext import testbed
>>> tb = testbed.Testbed()
>>> tb.setup_env(app_id='dev~your-app-id')
>>> tb.activate()
>>> tb.init_datastore_v3_stub(datastore_file='../assets/tmp/datastore.db', use_sqlite=True)
>>> tb.init_memcache_stub()
>>> tb.init_taskqueue_stub()
>>> from your-app import model

⁠Deploy

(gae-tap)$ make deploy

Auto deploy via Wercker CI:

If you want to auto deploy to the Google App Engine, add a APP_ENGINE_TOKEN variable to Deploy pipeline of Deploy targets in your App on the Wercker CI.

then access to:

• Server: https://.appspot.com/⁠
• API Explorer: https://.appspot.com/_ah/api/explorer⁠
• Developers Console: https://console.developers.google.com/project/⁠

⁠Dependencies

• Python 2.7
  • pip 6.x⁠
• Google App Engine
  • Django 1.5.x⁠
  • Third-party Libraries in Python 2.7⁠ on Google App Engine
  • libxml2⁠
  • libxslt⁠
  • lxml⁠
• GNU Make
  • How to install Xcode Command Line Tools⁠
• Bundler⁠
• Node.js⁠

⁠Optionals

• virtualenvwrapper⁠

⁠Known issues

• The `gcloud app Python Extensions component on the Google Cloud SDK does not include the Django package.

You can run a script:

$ ./assets/fetch_django-1.5.x.sh

• content-length header of the error status response that generated by endpoints is wrong⁠

You can patching to Google App Engine SDK:

$ patch -d $GOOGLE_APPENGINE -p0 -i $PWD/gae/tap/endpoints.patch

⁠on GAE <1.9.27

• Google Cloud SDK - GAE 1.9.18 produces docker error⁠

You can patching to Google App Engine SDK:

$ patch -d $GOOGLE_APPENGINE -p0 -i $PWD/gae/tap/docker.patch

⁠LICENSE

Licensed under the terms of the MIT.

Copyright (c) 2013 ENDOH takanao