Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 6e304b7

Browse filesBrowse files
tseavertseaver
authored
BigQuery Data Transfer: Harmonize / DRY 'README.rst' / 'docs/index.rst'. (#6013)
1 parent 6cbb169 commit 6e304b7
Copy full SHA for 6e304b7

File tree

Expand file treeCollapse file tree

2 files changed

+24
-110
lines changed
Filter options
Expand file treeCollapse file tree

2 files changed

+24
-110
lines changed

‎bigquery_datatransfer/README.rst

Copy file name to clipboardExpand all lines: bigquery_datatransfer/README.rst
+12-11Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
11
Python Client for BigQuery Data Transfer API (`Alpha`_)
22
=======================================================
33

4-
`BigQuery Data Transfer API`_: Transfers data from partner SaaS applications to Google BigQuery on a
5-
scheduled, managed basis.
4+
|pypi| |versions|
5+
6+
The `BigQuery Data Transfer API`_ allows users to transfer data from partner
7+
SaaS applications to Google BigQuery on a scheduled, managed basis.
68

79
- `Client Library Documentation`_
810
- `Product Documentation`_
911

1012
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
11-
.. _BigQuery Data Transfer API: https://cloud.google.com/bigquery/docs/transfer-service-overview
13+
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-bigquery-datatransfer.svg
14+
:target: https://pypi.org/project/google-cloud-bigquery-datatransfer/
15+
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-bigquery-datatransfer.svg
16+
:target: https://pypi.org/project/google-cloud-bigquery-datatransfer/
17+
.. _BigQuery Data Transfer API: https://cloud.google.com/bigquery/transfer
1218
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/bigquery_datatransfer/index.html
1319
.. _Product Documentation: https://cloud.google.com/bigquery/docs/transfer-service-overview
1420

@@ -60,8 +66,8 @@ Windows
6066
<your-env>\Scripts\activate
6167
<your-env>\Scripts\pip.exe install google-cloud-bigquery-datatransfer
6268
63-
Preview
64-
~~~~~~~
69+
Example Usage
70+
~~~~~~~~~~~~~
6571

6672
DataTransferServiceClient
6773
^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -91,10 +97,5 @@ Next Steps
9197

9298
- Read the `Client Library Documentation`_ for BigQuery Data Transfer API
9399
API to see other available methods on the client.
94-
- Read the `BigQuery Data Transfer API Product documentation`_ to learn
100+
- Read the `Product documentation`_ to learn
95101
more about the product and see How-to Guides.
96-
- View this `repository’s main README`_ to see the full list of Cloud
97-
APIs that we cover.
98-
99-
.. _BigQuery Data Transfer API Product documentation: https://cloud.google.com/bigquery/docs/transfer-service-overview
100-
.. _repository’s main README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst

‎bigquery_datatransfer/docs/index.rst

Copy file name to clipboard
+12-99Lines changed: 12 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -1,109 +1,22 @@
1-
Python Client for BigQuery Data Transfer API (`Alpha`_)
2-
=======================================================
1+
.. include:: /../bigquery_datatransfer/README.rst
32

4-
`BigQuery Data Transfer API`_: Transfers data from partner SaaS applications to Google BigQuery on a
5-
scheduled, managed basis.
6-
7-
- `Client Library Documentation`_
8-
- `Product Documentation`_
9-
10-
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
11-
.. _BigQuery Data Transfer API: https://cloud.google.com/bigquery/docs/transfer-service-overview
12-
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/bigquery_datatransfer/index.html
13-
.. _Product Documentation: https://cloud.google.com/bigquery/transfer
14-
15-
Quick Start
16-
-----------
17-
18-
In order to use this library, you first need to go through the following steps:
19-
20-
1. `Select or create a Cloud Platform project.`_
21-
2. `Enable the BigQuery Data Transfer API.`_
22-
3. `Setup Authentication.`_
23-
24-
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
25-
.. _Enable the BigQuery Data Transfer API.: https://cloud.google.com/bigquery/docs/transfer-service-overview
26-
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/latest/core/auth.html
27-
28-
Installation
29-
~~~~~~~~~~~~
30-
31-
Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
32-
create isolated Python environments. The basic problem it addresses is one of
33-
dependencies and versions, and indirectly permissions.
34-
35-
With `virtualenv`_, it's possible to install this library without needing system
36-
install permissions, and without clashing with the installed system
37-
dependencies.
38-
39-
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
40-
41-
42-
Mac/Linux
43-
^^^^^^^^^
44-
45-
.. code-block:: console
46-
47-
pip install virtualenv
48-
virtualenv <your-env>
49-
source <your-env>/bin/activate
50-
<your-env>/bin/pip install google-cloud-bigquerydatatransfer
51-
52-
53-
Windows
54-
^^^^^^^
55-
56-
.. code-block:: console
57-
58-
pip install virtualenv
59-
virtualenv <your-env>
60-
<your-env>\Scripts\activate
61-
<your-env>\Scripts\pip.exe install google-cloud-bigquerydatatransfer
62-
63-
Preview
64-
~~~~~~~
65-
66-
DataTransferServiceClient
67-
^^^^^^^^^^^^^^^^^^^^^^^^^
68-
69-
.. code:: py
70-
71-
from google.cloud import bigquery_datatransfer_v1
72-
73-
client = bigquery_datatransfer_v1.DataTransferServiceClient()
74-
75-
parent = client.location_path('[PROJECT]', '[LOCATION]')
763

4+
API Reference
5+
-------------
776

78-
# Iterate over all results
79-
for element in client.list_data_sources(parent):
80-
# process element
81-
pass
7+
.. toctree::
8+
:maxdepth: 2
829

83-
# Or iterate over results one page at a time
84-
for page in client.list_data_sources(parent, options=CallOptions(page_token=INITIAL_PAGE)):
85-
for element in page:
86-
# process element
87-
pass
10+
gapic/v1/api
11+
gapic/v1/types
8812

89-
Next Steps
90-
~~~~~~~~~~
9113

92-
- Read the `Client Library Documentation`_ for BigQuery Data Transfer API
93-
API to see other available methods on the client.
94-
- Read the `BigQuery Data Transfer API Product documentation`_ to learn
95-
more about the product and see How-to Guides.
96-
- View this `repository’s main README`_ to see the full list of Cloud
97-
APIs that we cover.
14+
Changelog
15+
---------
9816

99-
.. _BigQuery Data Transfer API Product documentation: https://cloud.google.com/bigquery/docs/transfer-service-overview
100-
.. _repository’s main README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
17+
For a list of all ``google-cloud-bigquery-bigquery-datatransfer`` releases:
10118

102-
Api Reference
103-
-------------
10419
.. toctree::
105-
:maxdepth: 2
20+
:maxdepth: 2
10621

107-
gapic/v1/api
108-
gapic/v1/types
109-
changelog
22+
changelog

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.