Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarify ADC pre-auth in a non-interactive environment #348

Merged
merged 7 commits into from
Feb 8, 2024
14 changes: 7 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,13 @@ 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
<https://cloud.google.com/sdk/gcloud/reference/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, see
`how to set up application default credentials <https://cloud.google.com/docs/authentication/provide-credentials-adc>`_
for various environments. For example, to pre-authenticate on your laptop you can
`install and initialize the gcloud CLI <https://cloud.google.com/sdk/docs/install>`_,
and then generate the application default credentials by doing
`gcloud auth application-default login <https://cloud.google.com/sdk/gcloud/reference/auth/application-default/login>`_.

Code sample
^^^^^^^^^^^
Expand Down Expand Up @@ -286,9 +289,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)
Expand Down