From 180b6a3db00f13e2c2cf1f30d2e59849a5b064df Mon Sep 17 00:00:00 2001 From: Anthonios Partheniou Date: Thu, 11 Nov 2021 11:39:06 +0000 Subject: [PATCH] chore: add link to Client Library Documentation in README --- README.rst | 43 ++++++++++++++++++++++++++++++++++++++----- 1 file changed, 38 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 6b6ed6b..0e957de 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,23 @@ Python Client for Google Cloud Bigquery Migration API ===================================================== +|GA| |pypi| |versions| + +Python client for `Google Cloud Bigquery Migration API`_. + +- `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-bigquery-migration.svg + :target: https://pypi.org/project/google-cloud-bigquery-migration/ +.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-bigquery-migration.svg + :target: https://pypi.org/project/google-cloud-bigquery-migration/ +.. _Google Cloud Bigquery Migration API: https://cloud.google.com/bigquery/docs/reference/migration/ +.. _Client Library Documentation: https://googleapis.dev/python/bigquerymigration/latest +.. _Product Documentation: https://cloud.google.com/bigquery/docs/reference/migration/ + Quick Start ----------- @@ -8,11 +25,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 Bigquery Migration API. +3. `Enable the Google Cloud Bigquery Migration 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 Bigquery Migration API.: https://console.cloud.google.com/apis/library/bigquerymigration.googleapis.com .. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html Installation @@ -34,9 +52,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-bigquery-migration Windows @@ -44,6 +63,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-bigquery-migration + +Next Steps +~~~~~~~~~~ + +- Read the `Client Library Documentation`_ for Google Cloud Bigquery + Migration API to see other available methods on the client. +- Read the `Bigquery Migration API 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. + +.. _Bigquery Migration API Product documentation: https://cloud.google.com/bigquery/docs/reference/migration/ +.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst \ No newline at end of file