From 627765412acaeeeb160bb6062374c792508266c4 Mon Sep 17 00:00:00 2001 From: Anthonios Partheniou Date: Sun, 14 Nov 2021 11:07:21 -0500 Subject: [PATCH] chore: add link to Client Library Documentation in README (#158) * chore: add link to Client Library Documentation in README * add links for enabling the api and setting up auth --- packages/google-cloud-trace/README.rst | 46 ++++++++++++++++++++++---- 1 file changed, 40 insertions(+), 6 deletions(-) diff --git a/packages/google-cloud-trace/README.rst b/packages/google-cloud-trace/README.rst index eee79bd643b2..abe0664d217f 100644 --- a/packages/google-cloud-trace/README.rst +++ b/packages/google-cloud-trace/README.rst @@ -1,5 +1,23 @@ Python Client for Google Cloud Trace API -================================================= +======================================== + +|GA| |pypi| |versions| + +`Google Cloud Trace`_: is a distributed tracing system for Google Cloud that collects latency data +from applications and displays it in near real-time in the Google Cloud Console. + +- `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/main/README.rst#general-availability +.. |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 + :target: https://pypi.org/project/google-cloud-trace/ +.. _Google Cloud Trace: https://cloud.google.com/trace +.. _Client Library Documentation: https://googleapis.dev/python/cloudtrace/latest +.. _Product Documentation: https://cloud.google.com/trace/docs Quick Start ----------- @@ -8,11 +26,12 @@ In order to use this library, you first need to go through the following steps: 1. `Select or create a Cloud Platform project.`_ 2. `Enable billing for your project.`_ -3. Enable the Google Cloud Trace API. +3. `Enable the Google Cloud Trace API.`_ 4. `Setup Authentication.`_ .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project .. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project +.. _Enable the Google Cloud Trace API.: https://console.cloud.google.com/flows/enableapi?apiid=cloudtrace.googleapis.com .. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html Installation @@ -34,9 +53,10 @@ Mac/Linux .. code-block:: console - python3 -m venv + pip install virtualenv + virtualenv source /bin/activate - /bin/pip install /path/to/library + /bin/pip install google-cloud-trace Windows @@ -44,6 +64,20 @@ Windows .. code-block:: console - python3 -m venv + pip install virtualenv + virtualenv \Scripts\activate - \Scripts\pip.exe install \path\to\library + \Scripts\pip.exe install google-cloud-trace + +Next Steps +~~~~~~~~~~ + +- Read the `Client Library Documentation`_ for Cloud Trace API + to see other available methods on the client. +- Read the `Cloud Trace Product documentation`_ to learn + more about the product and see How-to Guides. +- View this `README`_ to see the full list of Cloud + APIs that we cover. + +.. _Cloud Trace Product documentation: https://cloud.google.com/trace/docs +.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst