diff --git a/README b/README deleted file mode 100644 index e69de29..0000000 diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..79a41c1 --- /dev/null +++ b/README.rst @@ -0,0 +1,41 @@ +Google Federated Auth for Flask +=============================== + +Require an account from a given Google Apps domain for your Flasks apps. + +Great for internal apps on public-facing servers. + +Usage +----- + +Setup is super simple:: + + from flask import Flask + from flaskext.googlefed import GoogleAuth + + app = Flask(__name__) + app.config['GOOGLE_DOMAIN'] = 'heroku.com' + app.config['SECRET_KEY'] = 'ssssshhhhh' + + auth = GoogleAuth(app) + + @app.route('/') + @auth.required + def secret(): + return 'ssssshhhhh' + +Install +------- + +:: + + $ pip install flask-googlefed + + +TODO +---- + +Be forewarned, there's work to be done: + +- ``g.user`` is always ``None`` +- More generic Google auth would be nice.