From 455645cd2ad5143ab81f4dd3b50711ab3a048aa2 Mon Sep 17 00:00:00 2001 From: Shobhit Singh Date: Thu, 25 Jan 2024 00:19:31 +0000 Subject: [PATCH 1/3] docs: clarify ADC pre-auth in a non-interactive environment --- README.rst | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 38f7d0ab7a..198d173449 100644 --- a/README.rst +++ b/README.rst @@ -27,10 +27,12 @@ Prerequisites * Install the ``bigframes`` package. * Create a Google Cloud project and billing account. -* When running locally, authenticate with application default credentials. See - the `gcloud auth application-default login - `_ - reference. +* In an interactive environment (like Notebook, Python REPL or command line), + ``bigframes`` will do the authentication on-the-fly if needed. Otherwise, + pre-authenticate by + `Installing and initializing the gcloud CLI `_, + then generating the application default credentials by doing + `gcloud auth application-default login `_. Code sample ^^^^^^^^^^^ @@ -284,9 +286,6 @@ created by BigQuery DataFrames are prefixed by ``bigframes``. **Requirements** -BigQuery DataFrames uses the ``gcloud`` command-line interface internally, -so you must run ``gcloud auth login`` before using remote functions. - To use BigQuery DataFrames remote functions, you must enable the following APIs: * The BigQuery API (bigquery.googleapis.com) From 01764765a490d0c55354447fe7e74acd94524c22 Mon Sep 17 00:00:00 2001 From: Shobhit Singh Date: Thu, 25 Jan 2024 00:39:19 +0000 Subject: [PATCH 2/3] fix typo --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 198d173449..dc8fad8fb5 100644 --- a/README.rst +++ b/README.rst @@ -28,7 +28,7 @@ Prerequisites * Install the ``bigframes`` package. * Create a Google Cloud project and billing account. * In an interactive environment (like Notebook, Python REPL or command line), - ``bigframes`` will do the authentication on-the-fly if needed. Otherwise, + ``bigframes`` will do the authentication on-the-fly if needed. Otherwise, pre-authenticate by `Installing and initializing the gcloud CLI `_, then generating the application default credentials by doing From 60af6f5519fd7d9b7e10f8846560accdfaed15c2 Mon Sep 17 00:00:00 2001 From: Shobhit Singh Date: Sat, 27 Jan 2024 02:01:47 +0000 Subject: [PATCH 3/3] include generic ADC link --- README.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index dc8fad8fb5..d1bb4abb51 100644 --- a/README.rst +++ b/README.rst @@ -28,10 +28,11 @@ Prerequisites * Install the ``bigframes`` package. * Create a Google Cloud project and billing account. * In an interactive environment (like Notebook, Python REPL or command line), - ``bigframes`` will do the authentication on-the-fly if needed. Otherwise, - pre-authenticate by - `Installing and initializing the gcloud CLI `_, - then generating the application default credentials by doing + ``bigframes`` will do the authentication on-the-fly if needed. Otherwise, see + `how to set up application default credentials `_ + for various environments. For example, to pre-authenticate on your laptop you can + `install and initialize the gcloud CLI `_, + and then generate the application default credentials by doing `gcloud auth application-default login `_. Code sample