Skip to content

Commit 22807c9

Browse files
authored
docs: Update README to promote cloud client libraries (#1252)
Update README to promote [cloud client libraries](https://github.com/googleapis/google-cloud-python) for new code development for the following reasons: - There is a separate client library for each API, so you can choose which client libraries to download. Whereas, `google-api-python-client` is a single client library for all APIs. As a result, the total package size for `google-api-python-client` exceeds 50MB. - There are stricter controls for breaking changes to the underlying APIs as each client library is focused on a specific API. - There are more features in these Cloud Client Libraries as each library is focused on a specific API, and in some cases, the libraries are owned by team who specialized in that API. - Developers will benefit from intellisense. Fixes #1239 🦕
1 parent 8278537 commit 22807c9

File tree

2 files changed

+40
-4
lines changed

2 files changed

+40
-4
lines changed

README.md

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,54 @@
22

33
[![PyPI version](https://badge.fury.io/py/google-api-python-client.svg)](https://badge.fury.io/py/google-api-python-client)
44

5-
This is the Python client library for Google's discovery based APIs. To get started, please see the [docs folder](https://github.com/googleapis/google-api-python-client/blob/master/docs/README.md).
5+
This is the [Google API Python client library](https://cloud.google.com/apis/docs/client-libraries-explained#google_api_client_libraries)
6+
for Google's discovery based APIs. To get started, please see the
7+
[docs folder](https://github.com/googleapis/google-api-python-client/blob/master/docs/README.md).
68

7-
These client libraries are officially supported by Google. However, the libraries are considered complete and are in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.
9+
This library is considered complete and is in maintenance mode. This means
10+
that we will address critical bugs and security issues but will not add any
11+
new features.
12+
13+
This library is officially supported by Google. However, the maintainers of
14+
this repository recommend using [Cloud Client Libraries for Python](https://github.com/googleapis/google-cloud-python),
15+
where possible, for new code development. For more information, please visit
16+
[Client Libraries Explained](https://cloud.google.com/apis/docs/client-libraries-explained).
817

918
## Version 2.0 Release
1019
The 2.0 release of `google-api-python-client` is a significant upgrade compared
1120
to v1. Please see the [Migration Guide](https://github.com/googleapis/google-api-python-client/blob/master/UPGRADING.md) for more information.
21+
As a result of caching the discovery documents, the size of this package is at
22+
least 50 MB larger compared to the previous version.
1223

1324
## Documentation
1425

1526
See the [docs folder](https://github.com/googleapis/google-api-python-client/blob/master/docs/README.md) for more detailed instructions and additional documentation.
1627

1728
## Other Google API libraries
1829

19-
For Google Cloud Platform APIs such as Datastore, Cloud Storage or Pub/Sub, we recommend using [Cloud Client Libraries for Python](https://github.com/GoogleCloudPlatform/google-cloud-python).
30+
The maintainers of this repository recommend using
31+
[Cloud Client Libraries for Python](https://github.com/googleapis/google-cloud-python),
32+
where possible, for new code development due to the following reasons:
33+
34+
With [Cloud Client Libraries for Python](https://github.com/googleapis/google-cloud-python):
35+
- There is a separate client library for each API, so you can choose
36+
which client libraries to download. Whereas, `google-api-python-client` is a
37+
single client library for all APIs. As a result, the total package size for
38+
`google-api-python-client` exceeds 50MB.
39+
- There are stricter controls for breaking changes to the underlying APIs
40+
as each client library is focused on a specific API.
41+
- There are more features in these Cloud Client Libraries as each library is
42+
focused on a specific API, and in some cases, the libraries are owned by team
43+
who specialized in that API.
44+
- Developers will benefit from intellisense.
45+
46+
For more information, please visit
47+
[Client Libraries Explained](https://cloud.google.com/apis/docs/client-libraries-explained).
48+
49+
Although there are many benefits to moving to
50+
[Cloud Client Libraries for Python](https://github.com/googleapis/google-cloud-python),
51+
the maintainers want to emphasize that `google-api-python-client` will continue
52+
to be supported.
2053

2154
For Google Ads API, we recommend using [Google Ads API Client Library for Python](https://github.com/googleads/google-ads-python/).
2255

UPGRADING.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@ please continue to use version 1.x as we will continue supporting python 2.7+ in
77

88
In addition, discovery documents will no longer be retrieved dynamically when
99
you call `discovery.build()`. The discovery documents will instead be retrieved
10-
from the client library directly.
10+
from the client library directly. As a result of caching the discovery
11+
documents, the size of this package is at least 50 MB larger compared to the
12+
previous version.
13+
1114

1215
For users of public APIs
1316
------------------------

0 commit comments

Comments
 (0)