Skip to content
This repository was archived by the owner on Oct 16, 2023. It is now read-only.
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 38 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,36 @@
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
-----------

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
Expand All @@ -34,16 +52,31 @@ Mac/Linux

.. code-block:: console

python3 -m venv <your-env>
pip install virtualenv
virtualenv <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install /path/to/library
<your-env>/bin/pip install google-cloud-bigquery-migration


Windows
^^^^^^^

.. code-block:: console

python3 -m venv <your-env>
pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install \path\to\library
<your-env>\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