Skip to content

Commit df4ca17

Browse files
authored
chore: add link to Client Library Documentation in README (#20)
1 parent 8a4d17b commit df4ca17

File tree

1 file changed

+38
-5
lines changed
  • packages/google-cloud-bigquery-migration

1 file changed

+38
-5
lines changed

packages/google-cloud-bigquery-migration/README.rst

Lines changed: 38 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,36 @@
11
Python Client for Google Cloud Bigquery Migration API
22
=====================================================
33

4+
|GA| |pypi| |versions|
5+
6+
Python client for `Google Cloud Bigquery Migration API`_.
7+
8+
- `Client Library Documentation`_
9+
- `Product Documentation`_
10+
11+
.. |GA| image:: https://img.shields.io/badge/support-ga-gold.svg
12+
:target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#general-availability
13+
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-bigquery-migration.svg
14+
:target: https://pypi.org/project/google-cloud-bigquery-migration/
15+
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-bigquery-migration.svg
16+
:target: https://pypi.org/project/google-cloud-bigquery-migration/
17+
.. _Google Cloud Bigquery Migration API: https://cloud.google.com/bigquery/docs/reference/migration/
18+
.. _Client Library Documentation: https://googleapis.dev/python/bigquerymigration/latest
19+
.. _Product Documentation: https://cloud.google.com/bigquery/docs/reference/migration/
20+
421
Quick Start
522
-----------
623

724
In order to use this library, you first need to go through the following steps:
825

926
1. `Select or create a Cloud Platform project.`_
1027
2. `Enable billing for your project.`_
11-
3. Enable the Google Cloud Bigquery Migration API.
28+
3. `Enable the Google Cloud Bigquery Migration API.`_
1229
4. `Setup Authentication.`_
1330

1431
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
1532
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
33+
.. _Enable the Google Cloud Bigquery Migration API.: https://console.cloud.google.com/apis/library/bigquerymigration.googleapis.com
1634
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
1735

1836
Installation
@@ -34,16 +52,31 @@ Mac/Linux
3452

3553
.. code-block:: console
3654
37-
python3 -m venv <your-env>
55+
pip install virtualenv
56+
virtualenv <your-env>
3857
source <your-env>/bin/activate
39-
<your-env>/bin/pip install /path/to/library
58+
<your-env>/bin/pip install google-cloud-bigquery-migration
4059
4160
4261
Windows
4362
^^^^^^^
4463

4564
.. code-block:: console
4665
47-
python3 -m venv <your-env>
66+
pip install virtualenv
67+
virtualenv <your-env>
4868
<your-env>\Scripts\activate
49-
<your-env>\Scripts\pip.exe install \path\to\library
69+
<your-env>\Scripts\pip.exe install google-cloud-bigquery-migration
70+
71+
Next Steps
72+
~~~~~~~~~~
73+
74+
- Read the `Client Library Documentation`_ for Google Cloud Bigquery
75+
Migration API to see other available methods on the client.
76+
- Read the `Bigquery Migration API Product documentation`_ to learn
77+
more about the product and see How-to Guides.
78+
- View this `README`_ to see the full list of Cloud
79+
APIs that we cover.
80+
81+
.. _Bigquery Migration API Product documentation: https://cloud.google.com/bigquery/docs/reference/migration/
82+
.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst

0 commit comments

Comments
 (0)