Skip to content

Commit

Permalink
docs: clarify ADC pre-auth in a non-interactive environment (#348)
Browse files Browse the repository at this point in the history
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 🦕
  • Loading branch information
shobsi authored Feb 8, 2024
1 parent 930cf6b commit 99a9e6e
Showing 1 changed file with 7 additions and 7 deletions.
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

0 comments on commit 99a9e6e

Please sign in to comment.