New readme

This commit is contained in:
Kenneth Reitz
2012-03-04 11:28:20 -05:00
parent 269c71ccb7
commit 98d32bf1ab
2 changed files with 41 additions and 0 deletions
View File
+41
View File
@@ -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.