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.

Sign up for GitHub

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

Improvement: Allow users to provide a custom credentials file to oauth() #891

Merged
merged 1 commit into from
Jul 11, 2021
Merged

Improvement: Allow users to provide a custom credentials file to oauth() #891

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/oauth2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,9 +169,12 @@ When you run this code, it launches a browser asking you for authentication. Fol
You only need to do authorization in the browser once, following runs will reuse stored credentials.

.. NOTE::
If you want to store the credentials file somewhere else, specify the path to `authorized_user.json` in :meth:`~gspread.oauth`:
If you want to store the credentials file somewhere else, specify the path to `credentials.json` and `authorized_user.json` in :meth:`~gspread.oauth`:
::
gc = gspread.oauth(authorized_user_filename='path/to/the/downloaded/file.json')
gc = gspread.oauth(
credentials_filename='path/to/the/credentials.json',
authorized_user_filename='path/to/the/authorized_user.json'
)

Make sure you store the credentials file in a safe place.

Expand Down
29 changes: 15 additions & 14 deletions gspread/auth.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,7 @@ def get_config_dir(config_dir_name='gspread', os_is_windows=os.name == 'nt'):
)


def _create_installed_app_flow(scopes):
return InstalledAppFlow.from_client_secrets_file(
DEFAULT_CREDENTIALS_FILENAME, scopes
)


def local_server_flow(scopes, port=0):
def local_server_flow(scopes, port=0, filename=DEFAULT_CREDENTIALS_FILENAME):
"""Run an OAuth flow using a local server strategy.

Creates an OAuth flow and runs `google_auth_oauthlib.flow.InstalledAppFlow.run_local_server <https://google-auth-oauthlib.readthedocs.io/en/latest/reference/google_auth_oauthlib.flow.html#google_auth_oauthlib.flow.InstalledAppFlow.run_local_server>`_.
Expand All @@ -73,20 +67,19 @@ def local_server_flow(scopes, port=0):
Pass this function to ``flow`` parameter of :meth:`~gspread.oauth` to run
a local server flow.
"""

flow = _create_installed_app_flow(scopes)
flow = InstalledAppFlow.from_client_secrets_file(filename, scopes)
return flow.run_local_server(port=port)


def console_flow(scopes):
def console_flow(scopes, filename=DEFAULT_CREDENTIALS_FILENAME):
"""Run an OAuth flow using a console strategy.

Creates an OAuth flow and runs `google_auth_oauthlib.flow.InstalledAppFlow.run_console <https://google-auth-oauthlib.readthedocs.io/en/latest/reference/google_auth_oauthlib.flow.html#google_auth_oauthlib.flow.InstalledAppFlow.run_console>`_.

Pass this function to ``flow`` parameter of :meth:`~gspread.oauth` to run
a console strategy.
"""
flow = _create_installed_app_flow(scopes)
flow = InstalledAppFlow.from_client_secrets_file(filename, scopes)
return flow.run_console()


Expand All @@ -107,6 +100,7 @@ def store_credentials(
def oauth(
scopes=DEFAULT_SCOPES,
flow=local_server_flow,
credentials_filename=DEFAULT_CREDENTIALS_FILENAME,
authorized_user_filename=DEFAULT_AUTHORIZED_USER_FILENAME,
):
"""Authenticate with OAuth Client ID.
Expand Down Expand Up @@ -145,12 +139,19 @@ def oauth(
If you're storing your user credentials in a place other than the
default, you may provide a path to that file like so::

gc = gspread.oauth(authorized_user_filename='/alternative/path/authorized_user.json')

gc = gspread.oauth(
credentials_filename='/alternative/path/credentials.json',
authorized_user_filename='/alternative/path/authorized_user.json',
)

:param list scopes: The scopes used to obtain authorization.
:param function flow: OAuth flow to use for authentication.
Defaults to :meth:`~gspread.auth.local_server_flow`
:param str credentials_filename: Filepath (including name) pointing to a
credentials `.json` file.
Defaults to DEFAULT_CREDENTIALS_FILENAME:
* `%APPDATA%\gspread\credentials.json` on Windows
* `~/.config/gspread/credentials.json` everywhere else
:param str authorized_user_filename: Filepath (including name) pointing to
an authorized user `.json` file.
Defaults to DEFAULT_AUTHORIZED_USER_FILENAME:
Expand All @@ -162,7 +163,7 @@ def oauth(
creds = load_credentials(filename=authorized_user_filename)

if not creds:
creds = flow(scopes=scopes)
creds = flow(filename=credentials_filename, scopes=scopes)
store_credentials(creds, filename=authorized_user_filename)

client = Client(auth=creds)
Expand Down