Skip to content

Commit c314169

Browse files
ylil93tseaver
ylil93
authored and
tseaver
committed
Add compatibility check badges to READMEs. (googleapis#8288)
1 parent 49e7ce3 commit c314169

File tree

44 files changed

+234
-41
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+234
-41
lines changed

‎api_core/README.rst‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Core Library for Google Client Libraries
22
========================================
33

4-
|pypi| |versions|
4+
|pypi| |versions| |compat_check_pypi| |compat_check_github|
55

66
This library is not meant to stand-alone. Instead it defines
77
common helpers used by all Google API clients. For more information, see the
@@ -12,6 +12,10 @@ common helpers used by all Google API clients. For more information, see the
1212
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-api_core.svg
1313
:target: https://pypi.org/project/google-api_core/
1414
.. _documentation: https://googleapis.github.io/google-cloud-python/latest/core/
15+
.. |compat_check_pypi| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=google-api-core
16+
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=google-api-core
17+
.. |compat_check_github| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dapi_core
18+
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dapi_core
1519

1620

1721
Supported Python Versions
@@ -20,4 +24,4 @@ Python >= 3.5
2024

2125
Deprecated Python Versions
2226
--------------------------
23-
Python == 2.7. Python 2.7 support will be removed on January 1, 2020.
27+
Python == 2.7. Python 2.7 support will be removed on January 1, 2020.

‎asset/README.rst‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Python Client for Cloud Asset API
22
=================================
33

4-
|alpha| |pypi| |versions|
4+
|alpha| |pypi| |versions| |compat_check_pypi| |compat_check_github|
55

66
`Cloud Asset API`_: The cloud asset API manages the history and inventory of cloud resources.
77

@@ -14,6 +14,10 @@ Python Client for Cloud Asset API
1414
:target: https://pypi.org/project/google-cloud-asset/
1515
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-asset.svg
1616
:target: https://pypi.org/project/google-cloud-asset/
17+
.. |compat_check_pypi| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=google-cloud-asset
18+
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=google-cloud-asset
19+
.. |compat_check_github| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dasset
20+
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dasset
1721
.. _Cloud Asset API: https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/reference/rest/
1822
.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/asset/index.html
1923
.. _Product Documentation: https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview

‎automl/README.rst‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Python Client for Cloud AutoML API
22
==================================
33

4-
|alpha| |pypi| |versions|
4+
|alpha| |pypi| |versions| |compat_check_pypi| |compat_check_github|
55

66
The `Cloud AutoML API`_ is a suite of machine learning products that enables
77
developers with limited machine learning expertise to train high-quality models
@@ -17,6 +17,10 @@ transfer learning, and Neural Architecture Search technology.
1717
:target: https://pypi.org/project/google-cloud-automl/
1818
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-automl.svg
1919
:target: https://pypi.org/project/google-cloud-automl/
20+
.. |compat_check_pypi| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=google-cloud-automl
21+
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=google-cloud-automl
22+
.. |compat_check_github| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dautoml
23+
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dautoml
2024
.. _Cloud AutoML API: https://cloud.google.com/automl
2125
.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/automl/index.html
2226
.. _Product Documentation: https://cloud.google.com/automl

‎bigquery/README.rst‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Python Client for Google BigQuery
22
=================================
33

4-
|GA| |pypi| |versions|
4+
|GA| |pypi| |versions| |compat_check_pypi| |compat_check_github|
55

66
Querying massive datasets can be time consuming and expensive without the
77
right hardware and infrastructure. Google `BigQuery`_ solves this problem by
@@ -17,6 +17,10 @@ processing power of Google's infrastructure.
1717
:target: https://pypi.org/project/google-cloud-bigquery/
1818
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-bigquery.svg
1919
:target: https://pypi.org/project/google-cloud-bigquery/
20+
.. |compat_check_pypi| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=google-cloud-bigquery
21+
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=google-cloud-bigquery
22+
.. |compat_check_github| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dbigquery
23+
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dbigquery
2024
.. _BigQuery: https://cloud.google.com/bigquery/what-is-bigquery
2125
.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/bigquery/index.html
2226
.. _Product Documentation: https://cloud.google.com/bigquery/docs/reference/v2/

‎bigquery_datatransfer/README.rst‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Python Client for BigQuery Data Transfer API
22
============================================
33

4-
|alpha| |pypi| |versions|
4+
|alpha| |pypi| |versions| |compat_check_pypi| |compat_check_github|
55

66
The `BigQuery Data Transfer API`_ allows users to transfer data from partner
77
SaaS applications to Google BigQuery on a scheduled, managed basis.
@@ -15,6 +15,10 @@ SaaS applications to Google BigQuery on a scheduled, managed basis.
1515
:target: https://pypi.org/project/google-cloud-bigquery-datatransfer/
1616
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-bigquery-datatransfer.svg
1717
:target: https://pypi.org/project/google-cloud-bigquery-datatransfer/
18+
.. |compat_check_pypi| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=google-cloud-bigquery-datatransfer
19+
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=google-cloud-bigquery-datatransfer
20+
.. |compat_check_github| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dbigquery_datatransfer
21+
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dbigquery_datatransfer
1822
.. _BigQuery Data Transfer API: https://cloud.google.com/bigquery/transfer
1923
.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/bigquery_datatransfer/index.html
2024
.. _Product Documentation: https://cloud.google.com/bigquery/docs/transfer-service-overview

‎bigquery_storage/README.rst‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
Python Client for BigQuery Storage API (`Beta`_)
22
=================================================
33

4+
|compat_check_pypi| |compat_check_github|
5+
46
`BigQuery Storage API`_:
57

68
- `Client Library Documentation`_
79
- `Product Documentation`_
810

11+
.. |compat_check_pypi| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=google-cloud-bigquery-storage
12+
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=google-cloud-bigquery-storage
13+
.. |compat_check_github| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dbigquery_storage
14+
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dbigquery_storage
915
.. _Beta: https://github.com/googleapis/google-cloud-python/blob/master/README.rst
1016
.. _BigQuery Storage API: https://cloud.google.com/bigquery/docs/reference/storage/
1117
.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/bigquery_storage/index.html
@@ -97,4 +103,4 @@ Next Steps
97103
APIs that we cover.
98104

99105
.. _BigQuery Storage API Product documentation: https://cloud.google.com/bigquery/docs/reference/storage/
100-
.. _repository’s main README: https://github.com/googleapis/google-cloud-python/blob/master/README.rst
106+
.. _repository’s main README: https://github.com/googleapis/google-cloud-python/blob/master/README.rst

‎bigtable/README.rst‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Python Client for Google Cloud Bigtable
22
=======================================
33

4-
|beta| |pypi| |versions|
4+
|beta| |pypi| |versions| |compat_check_pypi| |compat_check_github|
55

66
`Google Cloud Bigtable`_ is Google's NoSQL Big Data database service. It's the
77
same database that powers many core Google services, including Search,
@@ -16,6 +16,10 @@ Analytics, Maps, and Gmail.
1616
:target: https://pypi.org/project/google-cloud-bigtable/
1717
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-bigtable.svg
1818
:target: https://pypi.org/project/google-cloud-bigtable/
19+
.. |compat_check_pypi| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=google-cloud-bigtable
20+
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=google-cloud-bigtable
21+
.. |compat_check_github| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dbigtable
22+
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dbigtable
1923
.. _Google Cloud Bigtable: https://cloud.google.com/bigtable
2024
.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/bigtable/usage.html
2125
.. _Product Documentation: https://cloud.google.com/bigtable/docs

‎container/README.rst‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Python Client for Google Kubernetes Engine API
22
==============================================
33

4-
|alpha| |pypi| |versions|
4+
|alpha| |pypi| |versions| |compat_check_pypi| |compat_check_github|
55

66
`Google Kubernetes Engine API`_: The Google Kubernetes Engine API is used for
77
building and managing container based applications, powered by the open source
@@ -16,6 +16,10 @@ Kubernetes technology.
1616
:target: https://pypi.org/project/google-cloud-container/
1717
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-container.svg
1818
:target: https://pypi.org/project/google-cloud-container/
19+
.. |compat_check_pypi| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=google-cloud-container
20+
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=google-cloud-container
21+
.. |compat_check_github| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dcontainer
22+
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dcontainer
1923
.. _Google Kubernetes Engine API: https://cloud.google.com/kubernetes-engine
2024
.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/container/index.html
2125
.. _Product Documentation: https://cloud.google.com/kubernetes-engine

‎core/README.rst‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Core Helpers for Google Cloud Python Client Library
22
===================================================
33

4-
|pypi| |versions|
4+
|pypi| |versions| |compat_check_pypi| |compat_check_github|
55

66
This library is not meant to stand-alone. Instead it defines
77
common helpers (e.g. base ``Client`` classes) used by all of the
@@ -14,6 +14,10 @@ common helpers (e.g. base ``Client`` classes) used by all of the
1414
:target: https://pypi.org/project/google-cloud-core/
1515
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-core.svg
1616
:target: https://pypi.org/project/google-cloud-core/
17+
.. |compat_check_pypi| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=google-cloud-core
18+
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=google-cloud-core
19+
.. |compat_check_github| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dcore
20+
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dcore
1721
.. _Documentation: https://googleapis.github.io/google-cloud-python/latest/core/index.html
1822

1923
Quick Start

‎datacatalog/README.rst‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
11
Python Client for Google Cloud Data Catalog API (`Alpha`_)
22
==========================================================
33

4+
|compat_check_pypi| |compat_check_github|
5+
46
`Google Cloud Data Catalog API`_: Google Cloud Data Catalog API provides features to attach metadata to
57
Google Cloud Platform resources like BigQuery Tables. Key critical resources
68
include: Entries (Data Catalog representation of a cloud resource).
79

810
- `Client Library Documentation`_
911
- `Product Documentation`_
1012

13+
.. |compat_check_pypi| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=google-cloud-datacatalog
14+
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=google-cloud-datacatalog
15+
.. |compat_check_github| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Ddatacatalog
16+
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Ddatacatalog
1117
.. _Alpha: https://github.com/googleapis/google-cloud-python/blob/master/README.rst
1218
.. _Google Cloud Data Catalog API: https://cloud.google.com/data-catalog
1319
.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/datacatalog/index.html
@@ -74,4 +80,4 @@ Next Steps
7480
APIs that we cover.
7581

7682
.. _Google Cloud Data Catalog API Product documentation: https://cloud.google.com/data-catalog
77-
.. _repository’s main README: https://github.com/googleapis/google-cloud-python/blob/master/README.rst
83+
.. _repository’s main README: https://github.com/googleapis/google-cloud-python/blob/master/README.rst

0 commit comments

Comments
 (0)