Skip to content

Commit d25b38f

Browse files
committed
Shorten Google credential provider names
1 parent 566cad3 commit d25b38f

File tree

3 files changed

+14
-14
lines changed

3 files changed

+14
-14
lines changed

docs/api/auth/google.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Google Auth
22

3-
::: obstore.auth.google.GoogleAuthCredentialProvider
4-
::: obstore.auth.google.GoogleAuthAsyncCredentialProvider
3+
::: obstore.auth.google.GoogleCredentialProvider
4+
::: obstore.auth.google.GoogleAsyncCredentialProvider

docs/authentication.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -77,13 +77,13 @@ Refer to [`obstore.auth.boto3`](api/auth/boto3.md).
7777

7878
#### google.auth
7979

80-
You can use the [`GoogleAuthCredentialProvider`][obstore.auth.google.GoogleAuthCredentialProvider] to use [`google.auth`][] to handle credentials.
80+
You can use the [`GoogleCredentialProvider`][obstore.auth.google.GoogleCredentialProvider] to use [`google.auth`][] to handle credentials.
8181

8282
```py
83-
from obstore.auth.google import GoogleAuthCredentialProvider
83+
from obstore.auth.google import GoogleCredentialProvider
8484
from obstore.store import GCSStore
8585

86-
credential_provider = GoogleAuthCredentialProvider(credentials=...)
86+
credential_provider = GoogleCredentialProvider(credentials=...)
8787
store = GCSStore("bucket_name", credential_provider=credential_provider)
8888
```
8989

obstore/python/obstore/auth/google.py

+9-9
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
from obstore.store import GCSCredential
1818

1919

20-
class GoogleAuthCredentialProvider:
20+
class GoogleCredentialProvider:
2121
"""A CredentialProvider for [GCSStore][obstore.store.GCSStore] that uses [`google.auth`][].
2222
2323
This credential provider uses `google-auth` and `requests`, and will error if those
@@ -26,10 +26,10 @@ class GoogleAuthCredentialProvider:
2626
**Example:**
2727
2828
```py
29-
from obstore.auth.google import GoogleAuthCredentialProvider
29+
from obstore.auth.google import GoogleCredentialProvider
3030
from obstore.store import GCSStore
3131
32-
credential_provider = GoogleAuthCredentialProvider(credentials=...)
32+
credential_provider = GoogleCredentialProvider(credentials=...)
3333
store = GCSStore("bucket_name", credential_provider=credential_provider)
3434
```
3535
""" # noqa: E501
@@ -45,7 +45,7 @@ def __init__(
4545
# https://github.com/googleapis/google-auth-library-python/blob/446c8e79b20b7c063d6aa142857a126a7efa1fc3/google/auth/_helpers.py#L26-L28
4646
refresh_threshold: timedelta = timedelta(minutes=3, seconds=45),
4747
) -> None:
48-
"""Create a new GoogleAuthCredentialProvider.
48+
"""Create a new GoogleCredentialProvider.
4949
5050
Args:
5151
credentials: Credentials to use for this provider. Defaults to `None`, in
@@ -81,11 +81,11 @@ def __call__(self) -> GCSCredential:
8181
}
8282

8383

84-
class GoogleAuthAsyncCredentialProvider:
84+
class GoogleAsyncCredentialProvider:
8585
"""An async CredentialProvider for [GCSStore][obstore.store.GCSStore] that uses [`google.auth`][].
8686
8787
This credential provider should be preferred over the synchronous
88-
[GoogleAuthCredentialProvider][obstore.auth.google.GoogleAuthCredentialProvider]
88+
[GoogleCredentialProvider][obstore.auth.google.GoogleCredentialProvider]
8989
whenever you're using async obstore methods.
9090
9191
This credential provider uses `google-auth` and `aiohttp`, and will error if those
@@ -94,10 +94,10 @@ class GoogleAuthAsyncCredentialProvider:
9494
**Example:**
9595
9696
```py
97-
from obstore.auth.google import GoogleAuthAsyncCredentialProvider
97+
from obstore.auth.google import GoogleAsyncCredentialProvider
9898
from obstore.store import GCSStore
9999
100-
credential_provider = GoogleAuthAsyncCredentialProvider(credentials=...)
100+
credential_provider = GoogleAsyncCredentialProvider(credentials=...)
101101
store = GCSStore("bucket_name", credential_provider=credential_provider)
102102
```
103103
@@ -114,7 +114,7 @@ def __init__(
114114
# https://github.com/googleapis/google-auth-library-python/blob/446c8e79b20b7c063d6aa142857a126a7efa1fc3/google/auth/_helpers.py#L26-L28
115115
refresh_threshold: timedelta = timedelta(minutes=3, seconds=45),
116116
) -> None:
117-
"""Create a new GoogleAuthCredentialProvider.
117+
"""Create a new GoogleCredentialProvider.
118118
119119
Args:
120120
credentials: Credentials to use for this provider. Defaults to `None`, in

0 commit comments

Comments
 (0)