Skip to content

Commit 8e19538

Browse files
committed
docs: Update README to promote cloud client libraries
1 parent 6137c8c commit 8e19538

File tree

2 files changed

+36
-5
lines changed

2 files changed

+36
-5
lines changed

README.md

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,49 @@
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](docs/README.md).
5+
This is the legacy Python client library for Google's discovery based APIs.
6+
To get started, please see the [docs folder](docs/README.md).
67

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.
8+
The libraries are considered complete and are in maintenance mode. This means
9+
that we will address critical bugs and security issues but will not add any
10+
new features.
11+
12+
This library is officially supported by Google. However, the maintainers of
13+
this repository recommend using [Cloud Client Libraries for Python](https://github.com/googleapis/google-cloud-python),
14+
where possible, for new code development.
815

916
## Version 2.0 Release
1017
The 2.0 release of `google-api-python-client` is a significant upgrade compared
11-
to v1. Please see the [Migration Guide](UPGRADING.md) for more information.
18+
to v1. Please see the [Migration Guide](UPGRADING.md) for more information. As
19+
a result of caching the discovery documents, the size of this package is at
20+
least 50 MB larger compared to the previous version.
1221

1322
## Documentation
1423

1524
See the [docs folder](docs/README.md) for more detailed instructions and additional documentation.
1625

1726
## Other Google API libraries
1827

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).
28+
The maintainers of this repository recommend using
29+
[Cloud Client Libraries for Python](https://github.com/googleapis/google-cloud-python),
30+
where possible, for new code development due to the following reasons:
31+
32+
With [Cloud Client Libraries for Python](https://github.com/googleapis/google-cloud-python):
33+
- There is a separate client library for each API, so you can choose
34+
which client libraries to download. Whereas, `google-api-python-client` is a
35+
single client library for all APIs. As a result, the total package size for
36+
`google-api-python-client` exceeds 50MB.
37+
- There are stricter controls for breaking changes to the underlying APIs
38+
as each client library is focused on a specific API.
39+
- There are more features in these Cloud Client Libraries as each library is
40+
focused on a specific API, and in some cases, the libraries are owned by team
41+
who specialized in that API.
42+
- Developers will benefit from intellisense.
43+
44+
Although there are many benefits to moving to
45+
[Cloud Client Libraries for Python](https://github.com/googleapis/google-cloud-python),
46+
the maintainers want to emphasize that `google-api-python-client` will continue
47+
to be supported.
2048

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

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)