DOC: add version tags for new auth_local_webserver params.

Author: tswast

ci/requirements-2.7-0.19.2.pip

@@ -1,7 +1,7 @@
-google-api-python-client
-google-auth
-google-auth-httplib2
-google-auth-oauthlib
+google-api-python-client==1.6.0
+google-auth==1.0.0
+google-auth-httplib2==0.0.1
+google-auth-oauthlib==0.0.1
 PyCrypto
 python-gflags==2.0
 mock

docs/source/changelog.rst

@@ -6,7 +6,7 @@ Changelog
 
 - Drop support for Python 3.4 (:issue:`40`)
 - Use the `google-auth <https://google-auth.readthedocs.io/en/latest/>`__ library for authentication because oauth2client is deprecated. (:issue:`39`)
-- ``read_gbq`` now has a ``auth_local_webserver`` boolean argument for controlling whether to use web server or console flow when getting user credentials.
+- ``read_gbq`` now has a ``auth_local_webserver`` boolean argument for controlling whether to use web server or console flow when getting user credentials. Replaces `--noauth_local_webserver` command line argument (:issue:`35`)
 
 0.1.6 / 2017-05-03
 ------------------

pandas_gbq/gbq.py

@@ -41,14 +41,28 @@ def _test_google_api_imports():
 
     try:
         import httplib2  # noqa
-        from googleapiclient.discovery import build  # noqa
-        from googleapiclient.errors import HttpError  # noqa
-        import google.auth  # noqa
         from google_auth_oauthlib.flow import InstalledAppFlow  # noqa
         import google_auth_httplib2  # noqa
-    except ImportError as e:
+    except ImportError as ex:
         raise ImportError("Missing module required for Google BigQuery "
-                          "support: {0}".format(str(e)))
+                          "support: {0}".format(str(ex)))
+
+    try:
+        from googleapiclient.discovery import build  # noqa
+        from googleapiclient.errors import HttpError  # noqa
+    except ImportError as ex:
+        raise ImportError(
+            "pandas requires google-api-python-client for Google  BigQuery "
+            "support: {0}".format(str(ex)))
+
+    try:
+        import google.auth  # noqa
+    except ImportError as ex:
+        raise ImportError(
+            "pandas requires google-auth for Google  BigQuery support: "
+            "{0}".format(str(ex)))
+
+    _check_google_client_version()
 
 
 def _try_credentials(project_id, credentials):
@@ -218,6 +232,8 @@ def load_user_account_credentials(self):
         """
         Loads user account credentials from a local file.
 
+        .. versionadded 0.2.0
+
         Parameters
         ----------
         None
@@ -261,6 +277,8 @@ def load_user_account_credentials(self):
     def save_user_account_credentials(self, credentials):
         """
         Saves user account credentials to a local file.
+
+        .. versionadded 0.2.0
         """
         try:
             with open('bigquery_credentials.dat', 'w') as credentials_file:
@@ -750,9 +768,15 @@ def read_gbq(query, project_id=None, index_col=None, col_order=None,
         Service account private key in JSON format. Can be file path
         or string contents. This is useful for remote server
         authentication (eg. jupyter iPython notebook on remote host)
-    auth_local_webserver : boolean (default False)
-        Use a local webserver when getting user credentials to handle
-        OAuth authorization flow redirects.
+    auth_local_webserver : boolean, default False
+        Use the [local webserver flow] instead of the [console flow] when
+        getting user credentials.
+
+        .. [local webserver flow]
+            http://google-auth-oauthlib.readthedocs.io/en/latest/reference/google_auth_oauthlib.flow.html#google_auth_oauthlib.flow.InstalledAppFlow.run_local_server
+        .. [console flow]
+            http://google-auth-oauthlib.readthedocs.io/en/latest/reference/google_auth_oauthlib.flow.html#google_auth_oauthlib.flow.InstalledAppFlow.run_console
+        .. versionadded:: 0.2.0
 
     dialect : {'legacy', 'standard'}, default 'legacy'
         'legacy' : Use BigQuery's legacy SQL dialect.
@@ -777,6 +801,8 @@ def read_gbq(query, project_id=None, index_col=None, col_order=None,
 
     """
 
+    _test_google_api_imports()
+
     if not project_id:
         raise TypeError("Missing required parameter: project_id")
 
@@ -883,11 +909,19 @@ def to_gbq(dataframe, destination_table, project_id, chunksize=10000,
         Service account private key in JSON format. Can be file path
         or string contents. This is useful for remote server
         authentication (eg. jupyter iPython notebook on remote host)
-    auth_local_webserver : boolean (default False)
-        Use a local webserver when getting user credentials to handle
-        OAuth authorization flow redirects.
+    auth_local_webserver : boolean, default False
+        Use the [local webserver flow] instead of the [console flow] when
+        getting user credentials.
+
+        .. [local webserver flow]
+            http://google-auth-oauthlib.readthedocs.io/en/latest/reference/google_auth_oauthlib.flow.html#google_auth_oauthlib.flow.InstalledAppFlow.run_local_server
+        .. [console flow]
+            http://google-auth-oauthlib.readthedocs.io/en/latest/reference/google_auth_oauthlib.flow.html#google_auth_oauthlib.flow.InstalledAppFlow.run_console
+        .. versionadded:: 0.2.0
     """
 
+    _test_google_api_imports()
+
     if if_exists not in ('fail', 'replace', 'append'):
         raise ValueError("'{0}' is not valid for if_exists".format(if_exists))
 

setup.py

@@ -22,8 +22,8 @@ def readme():
     'httplib2>=0.9.2',
     'google-api-python-client>=1.6.0',
     'google-auth>=1.0.0',
-    'google-auth-httplib2>=0.0.2',
-    'google-auth-oauthlib>=0.1.0',
+    'google-auth-httplib2>=0.0.1',
+    'google-auth-oauthlib>=0.0.1',
 ]