From ca71e4b1325e5add1438817bcf070211ce5095f2 Mon Sep 17 00:00:00 2001 From: Tres Seaver Date: Wed, 17 Oct 2018 12:51:09 -0400 Subject: [PATCH] Docs: normalize use of support level badges (#6159) * Remove badges for deprecated umbrella 'google-cloud' package. * Clarify support levels. - Add explicit section to support linking from sub-package README badges. - Move explanatory text for a support level above the list of packages at that level. * Normalize use of support-level badges in READMEs. - Note that 'error_reporting/README.rst' and 'monitoring/README.rst' are undergoing other edits; they are left out here to avoid conflicts. * Use 'General Avaialblity' for support level. Fix linkx in related API READMEs. * Fix links for alpha support in API READMEs. * Fix links for beta support in API READMEs. --- README.rst | 72 +++++++++++++++++--------------- asset/README.rst | 9 ++-- automl/README.rst | 9 ++-- bigquery/README.rst | 4 +- bigquery_datatransfer/README.rst | 9 ++-- bigtable/README.rst | 10 ++--- container/README.rst | 9 ++-- dataproc/README.rst | 9 ++-- datastore/README.rst | 4 +- dlp/README.rst | 9 ++-- dns/README.rst | 4 +- firestore/README.rst | 4 +- iot/README.rst | 9 ++-- kms/README.rst | 9 ++-- language/README.rst | 4 +- pubsub/README.rst | 4 +- redis/README.rst | 9 ++-- resource_manager/README.rst | 4 +- runtimeconfig/README.rst | 3 +- spanner/README.rst | 5 ++- speech/README.rst | 9 ++-- storage/README.rst | 4 +- tasks/README.rst | 9 ++-- texttospeech/README.rst | 9 ++-- trace/README.rst | 8 ++-- translate/README.rst | 5 ++- videointelligence/README.rst | 4 +- vision/README.rst | 4 +- websecurityscanner/README.rst | 9 ++-- 29 files changed, 151 insertions(+), 109 deletions(-) diff --git a/README.rst b/README.rst index 36c1d1352724..773b4d8b9084 100644 --- a/README.rst +++ b/README.rst @@ -1,12 +1,10 @@ Google Cloud Python Client ========================== - Python idiomatic client for `Google Cloud Platform`_ services. +Python idiomatic clients for `Google Cloud Platform`_ services. .. _Google Cloud Platform: https://cloud.google.com/ -|circleci| |appveyor| |coverage| - - `Homepage`_ - `API Documentation`_ - `Read The Docs Documentation`_ @@ -20,8 +18,25 @@ Google Cloud Python Client .. _Python 3 runtime: https://cloud.google.com/appengine/docs/standard/python3 .. _Python 2 runtime: https://cloud.google.com/appengine/docs/standard/python +General Availability +-------------------- + +**GA** (general availability) indicates that the client library for a +particular service is stable, and that the code surface will not change in +backwards-incompatible ways unless either absolutely necessary (e.g. because +of critical security issues) or with an extensive deprecation period. +Issues and requests against GA libraries are addressed with the highest +priority. + +.. note:: + + Sub-components of GA libraries explicitly marked as beta in the + import path (e.g. ``google.cloud.language_v1beta2``) should be considered + to be beta. + The following client libraries have **GA** support: +- `Google BigQuery`_ (`BigQuery README`_) - `Google Cloud Datastore`_ (`Datastore README`_) - `Google Cloud Natural Language`_ (`Natural Language README`_) - `Google Cloud Spanner`_ (`Spanner README`_) @@ -29,6 +44,8 @@ The following client libraries have **GA** support: - `Google Cloud Translation`_ (`Translation README`_) - `Stackdriver Logging`_ (`Logging README`_) +.. _Google BigQuery: https://pypi.org/project/google-cloud-bigquery/ +.. _BigQuery README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/bigquery .. _Google Cloud Datastore: https://pypi.org/project/google-cloud-datastore/ .. _Datastore README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/datastore .. _Google Cloud Natural Language: https://pypi.org/project/google-cloud-language/ @@ -42,22 +59,15 @@ The following client libraries have **GA** support: .. _Stackdriver Logging: https://pypi.org/project/google-cloud-logging/ .. _Logging README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/logging -**GA** (general availability) indicates that the client library for a -particular service is stable, and that the code surface will not change in -backwards-incompatible ways unless either absolutely necessary (e.g. because -of critical security issues) or with an extensive deprecation period. -Issues and requests against GA libraries are addressed with the highest -priority. - -.. note:: +Beta Support +------------ - Sub-components of GA libraries explicitly marked as beta in the - import path (e.g. ``google.cloud.language_v1beta2``) should be considered - to be beta. +**Beta** indicates that the client library for a particular service is +mostly stable and is being prepared for release. Issues and requests +against beta libraries are addressed with a higher priority. The following client libraries have **beta** support: -- `Google BigQuery`_ (`BigQuery README`_) - `Google Cloud Bigtable`_ (`Bigtable README`_) - `Google Cloud Firestore`_ (`Firestore README`_) - `Google Cloud Pub/Sub`_ (`Pub/Sub README`_) @@ -65,12 +75,6 @@ The following client libraries have **beta** support: - `Google Cloud Video Intelligence`_ (`Video Intelligence README`_) - `Google Cloud Vision`_ (`Vision README`_) -**Beta** indicates that the client library for a particular service is -mostly stable and is being prepared for release. Issues and requests -against beta libraries are addressed with a higher priority. - -.. _Google BigQuery: https://pypi.org/project/google-cloud-bigquery/ -.. _BigQuery README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/bigquery .. _Google Cloud Bigtable: https://pypi.org/project/google-cloud-bigtable/ .. _Bigtable README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/bigtable .. _Google Cloud Firestore: https://pypi.org/project/google-cloud-firestore/ @@ -84,8 +88,17 @@ against beta libraries are addressed with a higher priority. .. _Google Cloud Vision: https://pypi.org/project/google-cloud-vision/ .. _Vision README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/vision + +Alpha Support +------------- + +**Alpha** indicates that the client library for a particular service is +still a work-in-progress and is more likely to get backwards-incompatible +updates. See `versioning`_ for more details. + The following client libraries have **alpha** support: +- `Google Cloud Asset`_ (`Asset README`_) - `Google Cloud AutoML`_ (`AutoML README`_) - `Google BigQuery Data Transfer`_ (`BigQuery Data Transfer README`_) - `Google Cloud Bigtable - HappyBase`_ (`HappyBase README`_) @@ -105,10 +118,8 @@ The following client libraries have **alpha** support: - `Stackdriver Error Reporting`_ (`Error Reporting README`_) - `Stackdriver Monitoring`_ (`Monitoring README`_) -**Alpha** indicates that the client library for a particular service is -still a work-in-progress and is more likely to get backwards-incompatible -updates. See `versioning`_ for more details. - +.. _Google Cloud Asset: https://pypi.org/project/google-cloud-asset/ +.. _Asset README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/asset .. _Google Cloud AutoML: https://pypi.org/project/google-cloud-automl/ .. _AutoML README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/automl .. _Google BigQuery Data Transfer: https://pypi.org/project/google-cloud-bigquery-datatransfer/ @@ -164,6 +175,7 @@ Example Applications .. _tutorial: https://cloud.google.com/python .. _google-cloud-python-expenses-demo: https://github.com/GoogleCloudPlatform/google-cloud-python-expenses-demo + Authentication -------------- @@ -184,26 +196,20 @@ See the `CONTRIBUTING doc`_ for more information on how to get started. .. _CONTRIBUTING doc: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/CONTRIBUTING.rst + Community --------- Google Cloud Platform Python developers hang out in `Slack`_ in the ``#python`` channel, click here to `get an invitation`_. - .. _Slack: https://googlecloud-community.slack.com .. _get an invitation: https://gcp-slack.appspot.com/ + License ------- Apache 2.0 - See `the LICENSE`_ for more information. .. _the LICENSE: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/LICENSE - -.. |circleci| image:: https://circleci.com/gh/GoogleCloudPlatform/google-cloud-python.svg?style=shield - :target: https://circleci.com/gh/GoogleCloudPlatform/google-cloud-python -.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/github/googlecloudplatform/google-cloud-python?branch=master&svg=true - :target: https://ci.appveyor.com/project/GoogleCloudPlatform/google-cloud-python -.. |coverage| image:: https://coveralls.io/repos/GoogleCloudPlatform/google-cloud-python/badge.svg?branch=master - :target: https://coveralls.io/r/GoogleCloudPlatform/google-cloud-python?branch=master diff --git a/asset/README.rst b/asset/README.rst index 27669f3373ea..ffd60dec9231 100644 --- a/asset/README.rst +++ b/asset/README.rst @@ -1,14 +1,15 @@ -Python Client for Cloud Asset API (`Alpha`_) -============================================ +Python Client for Cloud Asset API +================================= -|pypi| |versions| +|alpha| |pypi| |versions| `Cloud Asset API`_: The cloud asset API manages the history and inventory of cloud resources. - `Client Library Documentation`_ - `Product Documentation`_ -.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst +.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-asset.svg :target: https://pypi.org/project/google-cloud-asset/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-asset.svg diff --git a/automl/README.rst b/automl/README.rst index 147ad02d36e3..638ad90c5624 100644 --- a/automl/README.rst +++ b/automl/README.rst @@ -1,7 +1,7 @@ -Python Client for Cloud AutoML API (`Alpha`_) -============================================= +Python Client for Cloud AutoML API +================================== -|pypi| |versions| +|alpha| |pypi| |versions| The `Cloud AutoML API`_ is a suite of machine learning products that enables developers with limited machine learning expertise to train high-quality models @@ -11,7 +11,8 @@ transfer learning, and Neural Architecture Search technology. - `Client Library Documentation`_ - `Product Documentation`_ -.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst +.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-automl.svg :target: https://pypi.org/project/google-cloud-automl/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-automl.svg diff --git a/bigquery/README.rst b/bigquery/README.rst index 7f9d2d8213e9..0e0110136eb4 100644 --- a/bigquery/README.rst +++ b/bigquery/README.rst @@ -1,7 +1,7 @@ Python Client for Google BigQuery ================================= -|pypi| |versions| +|GA| |pypi| |versions| Querying massive datasets can be time consuming and expensive without the right hardware and infrastructure. Google `BigQuery`_ solves this problem by @@ -11,6 +11,8 @@ processing power of Google's infrastructure. - `Client Library Documentation`_ - `Product Documentation`_ +.. |GA| image:: https://img.shields.io/badge/support-GA-gold.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#general-availability .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-bigquery.svg :target: https://pypi.org/project/google-cloud-bigquery/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-bigquery.svg diff --git a/bigquery_datatransfer/README.rst b/bigquery_datatransfer/README.rst index 256a4561a6bb..9d6199227a7a 100644 --- a/bigquery_datatransfer/README.rst +++ b/bigquery_datatransfer/README.rst @@ -1,7 +1,7 @@ -Python Client for BigQuery Data Transfer API (`Alpha`_) -======================================================= +Python Client for BigQuery Data Transfer API +============================================ -|pypi| |versions| +|alpha| |pypi| |versions| The `BigQuery Data Transfer API`_ allows users to transfer data from partner SaaS applications to Google BigQuery on a scheduled, managed basis. @@ -9,7 +9,8 @@ SaaS applications to Google BigQuery on a scheduled, managed basis. - `Client Library Documentation`_ - `Product Documentation`_ -.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst +.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-bigquery-datatransfer.svg :target: https://pypi.org/project/google-cloud-bigquery-datatransfer/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-bigquery-datatransfer.svg diff --git a/bigtable/README.rst b/bigtable/README.rst index 76ddbb35c076..24632069f1f6 100644 --- a/bigtable/README.rst +++ b/bigtable/README.rst @@ -1,8 +1,7 @@ -Python Client for Google Cloud Bigtable (`Beta`_) -================================================== - -|pypi| |versions| +Python Client for Google Cloud Bigtable +======================================= +|beta| |pypi| |versions| `Google Cloud Bigtable`_ is Google's NoSQL Big Data database service. It's the same database that powers many core Google services, including Search, @@ -11,7 +10,8 @@ Analytics, Maps, and Gmail. - `Client Library Documentation`_ - `Product Documentation`_ -.. _Beta: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst +.. |beta| image:: https://img.shields.io/badge/support-beta-silver.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#beta-support .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-bigtable.svg :target: https://pypi.org/project/google-cloud-bigtable/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-bigtable.svg diff --git a/container/README.rst b/container/README.rst index 5d82163e1f2b..a07e796e9cfb 100644 --- a/container/README.rst +++ b/container/README.rst @@ -1,7 +1,7 @@ -Python Client for Google Container Engine API (`Alpha`_) -======================================================== +Python Client for Google Container Engine API +============================================= -|pypi| |versions| +|alpha| |pypi| |versions| `Google Container Engine API`_: The Google Kubernetes Engine API is used for building and managing container based applications, powered by the open source Kubernetes technology. @@ -9,7 +9,8 @@ based applications, powered by the open source Kubernetes technology. - `Client Library Documentation`_ - `Product Documentation`_ -.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst +.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-container.svg :target: https://pypi.org/project/google-cloud-container/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-container.svg diff --git a/dataproc/README.rst b/dataproc/README.rst index ced39d553076..5a650778e972 100644 --- a/dataproc/README.rst +++ b/dataproc/README.rst @@ -1,14 +1,15 @@ -Python Client for Google Cloud Dataproc API (`Alpha`_) -====================================================== +Python Client for Google Cloud Dataproc API +=========================================== -|pypi| |versions| +|alpha| |pypi| |versions| `Google Cloud Dataproc API`_: Manages Hadoop-based clusters and jobs on Google Cloud Platform. - `Client Library Documentation`_ - `Product Documentation`_ -.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst +.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-dataproc.svg :target: https://pypi.org/project/google-cloud-dataproc/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-dataproc.svg diff --git a/datastore/README.rst b/datastore/README.rst index 869bd2d3e176..575585f756e9 100644 --- a/datastore/README.rst +++ b/datastore/README.rst @@ -1,7 +1,7 @@ Python Client for Google Cloud Datastore ======================================== -|pypi| |versions| +|GA| |pypi| |versions| `Google Cloud Datastore API`_ is a fully managed, schemaless database for storing non-relational data. Cloud Datastore automatically scales with your @@ -12,6 +12,8 @@ all other queries. - `Client Library Documentation`_ - `Product Documentation`_ +.. |GA| image:: https://img.shields.io/badge/support-GA-gold.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#general-availability .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-datastore.svg :target: https://pypi.org/project/google-cloud-datastore/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-datastore.svg diff --git a/dlp/README.rst b/dlp/README.rst index d5c35a11c73f..af5a7009d530 100644 --- a/dlp/README.rst +++ b/dlp/README.rst @@ -1,7 +1,7 @@ -Python Client for Cloud Data Loss Prevention (DLP) API (`Alpha`_) -================================================================= +Python Client for Cloud Data Loss Prevention (DLP) API +====================================================== -|pypi| |versions| +|alpha| |pypi| |versions| `Cloud Data Loss Prevention (DLP) API`_: Provides methods for detection, risk analysis, and de-identification of privacy-sensitive fragments in text, images, and Google Cloud Platform @@ -10,7 +10,8 @@ storage repositories. - `Client Library Documentation`_ - `Product Documentation`_ -.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst +.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-dlp.svg :target: https://pypi.org/project/google-cloud-dlp/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-dlp.svg diff --git a/dns/README.rst b/dns/README.rst index 7f3920f29bec..9cb646046fb7 100644 --- a/dns/README.rst +++ b/dns/README.rst @@ -1,7 +1,7 @@ Python Client for Google Cloud DNS ================================== -|pypi| |versions| +|alpha| |pypi| |versions| The `Google Cloud DNS`_ API provides methods that you can use to manage DNS for your applications. @@ -9,6 +9,8 @@ manage DNS for your applications. - `Client Library Documentation`_ - `Product Documentation`_ +.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-dns.svg :target: https://pypi.org/project/google-cloud-dns/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-dns.svg diff --git a/firestore/README.rst b/firestore/README.rst index 021e6b34db56..d7e3756eaeea 100644 --- a/firestore/README.rst +++ b/firestore/README.rst @@ -1,7 +1,7 @@ Python Client for Google Cloud Firestore ======================================== -|pypi| |versions| +|beta| |pypi| |versions| The `Google Cloud Firestore`_ API is a flexible, scalable database for mobile, web, and server development from Firebase and Google @@ -15,6 +15,8 @@ including Cloud Functions. - `Product Documentation`_ - `Client Library Documentation`_ +.. |beta| image:: https://img.shields.io/badge/support-beta-silver.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#beta-support .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-firestore.svg :target: https://pypi.org/project/google-cloud-firestore/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-firestore.svg diff --git a/iot/README.rst b/iot/README.rst index 3cdbf205b678..1796e442bc72 100644 --- a/iot/README.rst +++ b/iot/README.rst @@ -1,7 +1,7 @@ -Python Client for Cloud IoT API (`Alpha`_) -========================================== +Python Client for Cloud IoT API +=============================== -|pypi| |versions| +|alpha| |pypi| |versions| `Cloud IoT API`_: Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform. @@ -9,7 +9,8 @@ connect to the Google Cloud Platform. - `Client Library Documentation`_ - `Product Documentation`_ -.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst +.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-iot.svg :target: https://pypi.org/project/google-cloud-iot/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-iot.svg diff --git a/kms/README.rst b/kms/README.rst index 2b023c50246f..bf4df277795b 100644 --- a/kms/README.rst +++ b/kms/README.rst @@ -1,7 +1,7 @@ -Python Client for Cloud Key Management Service (KMS) API (`Alpha`_) -=================================================================== +Python Client for Cloud Key Management Service (KMS) API +======================================================== -|pypi| |versions| +|alpha| |pypi| |versions| `Cloud Key Management Service (KMS) API`_: Manages keys and performs cryptographic operations in a central cloud service, for direct use by other @@ -10,7 +10,8 @@ cloud resources and applications. - `Client Library Documentation`_ - `Product Documentation`_ -.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst +.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-kms.svg :target: https://pypi.org/project/google-cloud-kms/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-kms.svg diff --git a/language/README.rst b/language/README.rst index d4a971b65a67..65dd6687cf8d 100644 --- a/language/README.rst +++ b/language/README.rst @@ -1,7 +1,7 @@ Python Client for Google Cloud Natural Language =============================================== -|pypi| |versions| +|GA| |pypi| |versions| The `Google Cloud Natural Language`_ API can be used to reveal the structure and meaning of text via powerful machine @@ -16,6 +16,8 @@ with your document storage on Google Cloud Storage. - `Client Library Documentation`_ - `Product Documentation`_ +.. |GA| image:: https://img.shields.io/badge/support-GA-gold.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#general-availability .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-language.svg :target: https://pypi.org/project/google-cloud-language/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-language.svg diff --git a/pubsub/README.rst b/pubsub/README.rst index c2d14aba6c5a..c0ef2a2f4034 100644 --- a/pubsub/README.rst +++ b/pubsub/README.rst @@ -1,7 +1,7 @@ Python Client for Google Cloud Pub / Sub ======================================== -|pypi| |versions| +|beta| |pypi| |versions| `Google Cloud Pub / Sub`_ is a fully-managed real-time messaging service that allows you to send and receive messages between independent applications. You @@ -19,6 +19,8 @@ independently written applications. - `Product Documentation`_ - `Client Library Documentation`_ +.. |beta| image:: https://img.shields.io/badge/support-beta-silver.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#beta-support .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-pubsub.svg :target: https://pypi.org/project/google-cloud-pubsub/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-pubsub.svg diff --git a/redis/README.rst b/redis/README.rst index ff6fe55766f1..4df28b243905 100644 --- a/redis/README.rst +++ b/redis/README.rst @@ -1,7 +1,7 @@ -Python Client for Google Cloud Memorystore for Redis API (`Alpha`_) -=================================================================== +Python Client for Google Cloud Memorystore for Redis API +======================================================== -|pypi| |versions| +|alpha| |pypi| |versions| `Google Cloud Memorystore for Redis API`_: The Google Cloud Memorystore for Redis API is used for creating and managing Redis instances on the Google @@ -10,7 +10,8 @@ Cloud Platform. - `Client Library Documentation`_ - `Product Documentation`_ -.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst +.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-redis.svg :target: https://pypi.org/project/google-cloud-redis/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-redis.svg diff --git a/resource_manager/README.rst b/resource_manager/README.rst index bd029498cfb1..61cbdeaaa0c3 100644 --- a/resource_manager/README.rst +++ b/resource_manager/README.rst @@ -1,7 +1,7 @@ Python Client for Google Cloud Resource Manager =============================================== -|pypi| |versions| +|alpha| |pypi| |versions| `Google Cloud Resource Manager`_ API provides methods that you can use to programmatically manage your projects in the Google Cloud Platform. @@ -17,6 +17,8 @@ With this API, you can do the following: - `Product Documentation`_ +.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-resource-manager.svg :target: https://pypi.org/project/google-cloud-resource-manager/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-resource-manager.svg diff --git a/runtimeconfig/README.rst b/runtimeconfig/README.rst index f732b0ae0af1..73276270b388 100644 --- a/runtimeconfig/README.rst +++ b/runtimeconfig/README.rst @@ -11,7 +11,8 @@ return based on certain conditions. - `Client Library Documentation`_ - `Product Documentation`_ -.. |alpha| image:: https://img.shields.io/badge/status-alpha-orange.svg +.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-runtimeconfig.svg :target: https://pypi.org/project/google-cloud-runtimeconfig/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-runtimeconfig.svg diff --git a/spanner/README.rst b/spanner/README.rst index a596b827a801..d7f86d6aae65 100644 --- a/spanner/README.rst +++ b/spanner/README.rst @@ -1,7 +1,7 @@ Python Client for Cloud Spanner =============================== -|pypi| |versions| +|GA| |pypi| |versions| `Cloud Spanner`_ is the world's first fully managed relational database service to offer both strong consistency and horizontal scalability for @@ -15,7 +15,8 @@ workloads. - `Client Library Documentation`_ - `Product Documentation`_ - +.. |GA| image:: https://img.shields.io/badge/support-GA-gold.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#general-availability .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-spanner.svg :target: https://pypi.org/project/google-cloud-spanner/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-spanner.svg diff --git a/speech/README.rst b/speech/README.rst index 3c2357b07bb1..f0d20c4c608b 100644 --- a/speech/README.rst +++ b/speech/README.rst @@ -1,7 +1,7 @@ -Python Client for Cloud Speech API (`Beta`_) -============================================= +Python Client for Cloud Speech API +================================== -|pypi| |versions| +|beta| |pypi| |versions| The `Cloud Speech API`_ enables developers to convert audio to text by applying powerful neural network models. The API recognizes over 80 languages and @@ -10,7 +10,8 @@ variants, to support your global user base. - `Client Library Documentation`_ - `Product Documentation`_ -.. _Beta: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst +.. |beta| image:: https://img.shields.io/badge/support-beta-silver.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#beta-support .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-speech.svg :target: https://pypi.org/project/google-cloud-speech/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-speech.svg diff --git a/storage/README.rst b/storage/README.rst index e7e93d5ccbdc..22e3e989fef3 100644 --- a/storage/README.rst +++ b/storage/README.rst @@ -1,7 +1,7 @@ Python Client for Google Cloud Storage ====================================== -|pypi| |versions| +|GA| |pypi| |versions| `Google Cloud Storage`_ allows you to store data on Google infrastructure with very high reliability, performance and @@ -11,6 +11,8 @@ via direct download. - `Client Library Documentation`_ - `Storage API docs`_ +.. |GA| image:: https://img.shields.io/badge/support-GA-gold.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#general-availability .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-storage.svg :target: https://pypi.org/project/google-cloud-storage .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-storage.svg diff --git a/tasks/README.rst b/tasks/README.rst index d2a47ce08dbb..29fe34091e3f 100644 --- a/tasks/README.rst +++ b/tasks/README.rst @@ -1,7 +1,7 @@ -Python Client for Cloud Tasks API (`Alpha`_) -============================================ +Python Client for Cloud Tasks API +================================= -|pypi| |versions| +|alpha| |pypi| |versions| `Cloud Tasks API`_: Manages the execution of large numbers of distributed requests. @@ -9,7 +9,8 @@ requests. - `Client Library Documentation`_ - `Product Documentation`_ -.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst +.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-tasks.svg :target: https://pypi.org/project/google-cloud-tasks/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-tasks.svg diff --git a/texttospeech/README.rst b/texttospeech/README.rst index f6885c1e1c90..d20deb8e990a 100644 --- a/texttospeech/README.rst +++ b/texttospeech/README.rst @@ -1,7 +1,7 @@ -Python Client for Cloud Text-to-Speech API (`Alpha`_) -===================================================== +Python Client for Cloud Text-to-Speech API +========================================== -|pypi| |versions| +|alpha| |pypi| |versions| `Cloud Text-to-Speech API`_: Synthesizes natural-sounding speech by applying powerful neural network models. @@ -9,7 +9,8 @@ powerful neural network models. - `Client Library Documentation`_ - `Product Documentation`_ -.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst +.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-texttospeech.svg :target: https://pypi.org/project/google-cloud-texttospeech/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-texttospeech.svg diff --git a/trace/README.rst b/trace/README.rst index 614f6917f2bf..cc6d0bf661fd 100644 --- a/trace/README.rst +++ b/trace/README.rst @@ -1,5 +1,5 @@ -Python Client for Stackdriver Trace API (`Alpha`_) -================================================== +Python Client for Stackdriver Trace API +======================================= |alpha| |pypi| |versions| @@ -10,8 +10,8 @@ default. Trace data from other applications can be provided using this API. - `Client Library Documentation`_ - `Product Documentation`_ -.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst -.. |alpha| image:: https://img.shields.io/badge/status-alpha-orange.svg +.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-trace.svg :target: https://pypi.org/project/google-cloud-trace/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-trace.svg diff --git a/translate/README.rst b/translate/README.rst index e5de25d152cc..0bc43ee60782 100644 --- a/translate/README.rst +++ b/translate/README.rst @@ -1,7 +1,7 @@ Python Client for Google Cloud Translation ========================================== -|pypi| |versions| +|GA| |pypi| |versions| With `Google Cloud Translation`_, you can dynamically translate text between thousands of language pairs. The Google Cloud Translation API lets websites @@ -12,7 +12,8 @@ Cloud Translation is available as a paid service. See the `Pricing`_ and - `Client Library Documentation`_ - `Product Documentation`_ - +.. |GA| image:: https://img.shields.io/badge/support-GA-gold.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#general-availability .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-translate.svg :target: https://pypi.org/project/google-cloud-translate/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-translate.svg diff --git a/videointelligence/README.rst b/videointelligence/README.rst index 71cf0b1cc406..7bd4ebe1c890 100644 --- a/videointelligence/README.rst +++ b/videointelligence/README.rst @@ -1,7 +1,7 @@ Python Client for Google Cloud Video Intelligence ================================================= -|pypi| |versions| +|beta| |pypi| |versions| `Google Cloud Video Intelligence`_ API makes videos searchable, and discoverable, by extracting metadata with an easy to use API. @@ -15,6 +15,8 @@ relevant information at the video, shot or per frame. - `Client Library Documentation`_ - `Product Documentation`_ +.. |beta| image:: https://img.shields.io/badge/support-beta-silver.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#beta-support .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-videointelligence.svg :target: https://pypi.org/project/google-cloud-videointelligence/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-videointelligence.svg diff --git a/vision/README.rst b/vision/README.rst index 5c18d313b014..697a56f26fcb 100644 --- a/vision/README.rst +++ b/vision/README.rst @@ -1,7 +1,7 @@ Python Client for Google Cloud Vision ===================================== -|pypi| |versions| +|beta| |pypi| |versions| The `Google Cloud Vision`_ API enables developers to understand the content of an image by encapsulating powerful machine @@ -17,6 +17,8 @@ Storage. - `Client Library Documentation`_ - `Product Documentation`_ +.. |beta| image:: https://img.shields.io/badge/support-beta-silver.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#beta-support .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-vision.svg :target: https://pypi.org/project/google-cloud-vision/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-vision.svg diff --git a/websecurityscanner/README.rst b/websecurityscanner/README.rst index 65b1cae174de..f51f4cf0cb54 100644 --- a/websecurityscanner/README.rst +++ b/websecurityscanner/README.rst @@ -1,18 +1,19 @@ -Python Client for Web Security Scanner API (`Alpha`_) -===================================================== +Python Client for Web Security Scanner API +========================================== -|pypi| |versions| +|alpha| |pypi| |versions| `Web Security Scanner API`_: Web Security Scanner API (under development). - `Client Library Documentation`_ - `Product Documentation`_ +.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-websecurityscanner.svg :target: https://pypi.org/project/google-cloud-websecurityscanner/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-websecurityscanner.svg :target: https://pypi.org/project/google-cloud-websecurityscanner/ -.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst .. _Web Security Scanner API: https://cloud.google.com/security-scanner .. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/websecurityscanner/index.html .. _Product Documentation: https://cloud.google.com/security-scanner