openstack/deb-python-oauth2client
Code Issues Proposed changes

Merge pull request #500 from jonparrott/fix-flask-docs

Browse Source 
Fix flask_util docstrings concerning GOOGLE_OAUTH2_CLIENT_SECRETS_FILE
This commit is contained in:
Jon Wayne Parrott
2016-04-14 12:53:23 -07:00
parent bf9b78f882 17d6230256
commit 421ae37073
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
oauth2client/contrib/flask_util.py
View File

@@ -35,7 +35,7 @@ apiui/credential>`__.
app.config['SECRET_KEY'] = 'your-secret-key' app.config['SECRET_KEY'] = 'your-secret-key'
app.config['GOOGLE_OAUTH2_CLIENT_SECRETS_JSON'] = 'client_secrets.json' app.config['GOOGLE_OAUTH2_CLIENT_SECRETS_FILE'] = 'client_secrets.json'
# or, specify the client id and secret separately # or, specify the client id and secret separately
app.config['GOOGLE_OAUTH2_CLIENT_ID'] = 'your-client-id' app.config['GOOGLE_OAUTH2_CLIENT_ID'] = 'your-client-id'
@@ -213,14 +213,14 @@ class UserOAuth2(object):
Configuration values: Configuration values:
* ``GOOGLE_OAUTH2_CLIENT_SECRETS_JSON`` path to a client secrets json * ``GOOGLE_OAUTH2_CLIENT_SECRETS_FILE`` path to a client secrets json
file, obtained from the credentials screen in the Google Developers file, obtained from the credentials screen in the Google Developers
console. console.
* ``GOOGLE_OAUTH2_CLIENT_ID`` the oauth2 credentials' client ID. This * ``GOOGLE_OAUTH2_CLIENT_ID`` the oauth2 credentials' client ID. This
is only needed if ``GOOGLE_OAUTH2_CLIENT_SECRETS_JSON`` is not is only needed if ``GOOGLE_OAUTH2_CLIENT_SECRETS_FILE`` is not
specified. specified.
* ``GOOGLE_OAUTH2_CLIENT_SECRET`` the oauth2 credentials' client * ``GOOGLE_OAUTH2_CLIENT_SECRET`` the oauth2 credentials' client
secret. This is only needed if ``GOOGLE_OAUTH2_CLIENT_SECRETS_JSON`` secret. This is only needed if ``GOOGLE_OAUTH2_CLIENT_SECRETS_FILE``
is not specified. is not specified.
If app is specified, all arguments will be passed along to init_app. If app is specified, all arguments will be passed along to init_app.
@@ -243,7 +243,7 @@ class UserOAuth2(object):
app: A Flask application. app: A Flask application.
scopes: Optional list of scopes to authorize. scopes: Optional list of scopes to authorize.
client_secrets_file: Path to a file containing client secrets. You client_secrets_file: Path to a file containing client secrets. You
can also specify the GOOGLE_OAUTH2_CLIENT_SECRETS_JSON config can also specify the GOOGLE_OAUTH2_CLIENT_SECRETS_FILE config
value. value.
client_id: If not specifying a client secrets file, specify the client_id: If not specifying a client secrets file, specify the
OAuth2 client id. You can also specify the OAuth2 client id. You can also specify the
@@ -307,8 +307,8 @@ class UserOAuth2(object):
except KeyError: except KeyError:
raise ValueError( raise ValueError(
'OAuth2 configuration could not be found. Either specify the ' 'OAuth2 configuration could not be found. Either specify the '
'client_secrets_file or client_id and client_secret or set the' 'client_secrets_file or client_id and client_secret or set '
'app configuration variables ' 'the app configuration variables '
'GOOGLE_OAUTH2_CLIENT_SECRETS_FILE or ' 'GOOGLE_OAUTH2_CLIENT_SECRETS_FILE or '
'GOOGLE_OAUTH2_CLIENT_ID and GOOGLE_OAUTH2_CLIENT_SECRET.') 'GOOGLE_OAUTH2_CLIENT_ID and GOOGLE_OAUTH2_CLIENT_SECRET.')