Skip to content

Commit 99a9e6e

Browse files
authored
docs: clarify ADC pre-auth in a non-interactive environment (#348)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly: - [ ] Make sure to open an issue as a [bug/issue](https://togithub.com/googleapis/python-bigquery-dataframes/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [ ] Ensure the tests and linter pass - [ ] Code coverage does not decrease (if any source code was changed) - [ ] Appropriate docs were updated (if necessary) Fixes internal issue 321859738 🦕
1 parent 930cf6b commit 99a9e6e

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,13 @@ Prerequisites
2727

2828
* Install the ``bigframes`` package.
2929
* Create a Google Cloud project and billing account.
30-
* When running locally, authenticate with application default credentials. See
31-
the `gcloud auth application-default login
32-
<https://cloud.google.com/sdk/gcloud/reference/auth/application-default/login>`_
33-
reference.
30+
* In an interactive environment (like Notebook, Python REPL or command line),
31+
``bigframes`` will do the authentication on-the-fly if needed. Otherwise, see
32+
`how to set up application default credentials <https://cloud.google.com/docs/authentication/provide-credentials-adc>`_
33+
for various environments. For example, to pre-authenticate on your laptop you can
34+
`install and initialize the gcloud CLI <https://cloud.google.com/sdk/docs/install>`_,
35+
and then generate the application default credentials by doing
36+
`gcloud auth application-default login <https://cloud.google.com/sdk/gcloud/reference/auth/application-default/login>`_.
3437

3538
Code sample
3639
^^^^^^^^^^^
@@ -286,9 +289,6 @@ created by BigQuery DataFrames are prefixed by ``bigframes``.
286289

287290
**Requirements**
288291

289-
BigQuery DataFrames uses the ``gcloud`` command-line interface internally,
290-
so you must run ``gcloud auth login`` before using remote functions.
291-
292292
To use BigQuery DataFrames remote functions, you must enable the following APIs:
293293

294294
* The BigQuery API (bigquery.googleapis.com)

0 commit comments

Comments
 (0)