Skip to content

Commit a972c82

Browse files
jskeetchalmerlowe
jskeet
authored and
chalmerlowe
committed
chore: replace symlinks with copies for README.rst (#16653)
1 parent 32e35fe commit a972c82

File tree

9 files changed

+840
-9
lines changed

9 files changed

+840
-9
lines changed

‎packages/bigquery-magics/docs/README.rst‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎packages/bigquery-magics/docs/README.rst‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
IPython Magics for BigQuery
2+
===========================
3+
4+
|GA| |pypi| |versions|
5+
6+
Querying massive datasets can be time consuming and expensive without the
7+
right hardware and infrastructure. Google `BigQuery`_ solves this problem by
8+
enabling super-fast, SQL queries against append-mostly tables, using the
9+
processing power of Google's infrastructure.
10+
11+
- `Library Documentation`_
12+
- `Product Documentation`_
13+
14+
.. |GA| image:: https://img.shields.io/badge/support-GA-gold.svg
15+
:target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#general-availability
16+
.. |pypi| image:: https://img.shields.io/pypi/v/bigquery-magics.svg
17+
:target: https://pypi.org/project/bigquery-magics/
18+
.. |versions| image:: https://img.shields.io/pypi/pyversions/bigquery-magics.svg
19+
:target: https://pypi.org/project/bigquery-magics/
20+
.. _BigQuery: https://cloud.google.com/bigquery/what-is-bigquery
21+
.. _Library Documentation: https://googleapis.dev/python/bigquery-magics/latest
22+
.. _Product Documentation: https://cloud.google.com/bigquery/docs/reference/v2/
23+
24+
Quick Start
25+
-----------
26+
27+
In order to use this library, you first need to go through the following steps:
28+
29+
1. `Select or create a Cloud Platform project.`_
30+
2. `Enable billing for your project.`_
31+
3. `Enable the Google Cloud BigQuery API.`_
32+
4. `Setup Authentication.`_
33+
34+
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
35+
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
36+
.. _Enable the Google Cloud BigQuery API.: https://cloud.google.com/bigquery
37+
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
38+
39+
Installation
40+
~~~~~~~~~~~~
41+
42+
Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
43+
create isolated Python environments. The basic problem it addresses is one of
44+
dependencies and versions, and indirectly permissions.
45+
46+
With `virtualenv`_, it's possible to install this library without needing system
47+
install permissions, and without clashing with the installed system
48+
dependencies.
49+
50+
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
51+
52+
53+
Supported Python Versions
54+
^^^^^^^^^^^^^^^^^^^^^^^^^
55+
Python >= 3.9
56+
57+
Unsupported Python Versions
58+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
59+
Python <= 3.8.
60+
61+
62+
Mac/Linux
63+
^^^^^^^^^
64+
65+
.. code-block:: console
66+
67+
pip install virtualenv
68+
virtualenv <your-env>
69+
source <your-env>/bin/activate
70+
<your-env>/bin/pip install bigquery-magics
71+
72+
73+
Windows
74+
^^^^^^^
75+
76+
.. code-block:: console
77+
78+
pip install virtualenv
79+
virtualenv <your-env>
80+
<your-env>\Scripts\activate
81+
<your-env>\Scripts\pip.exe install bigquery-magics
82+
83+
Example Usage
84+
-------------
85+
86+
To use these magics, you must first register them. Run the ``%load_ext bigquery_magics``
87+
in a Jupyter notebook cell.
88+
89+
.. code-block::
90+
91+
%load_ext bigquery_magics
92+
93+
Perform a query
94+
~~~~~~~~~~~~~~~
95+
96+
.. code:: python
97+
98+
%%bigquery
99+
SELECT name, SUM(number) as count
100+
FROM 'bigquery-public-data.usa_names.usa_1910_current'
101+
GROUP BY name
102+
ORDER BY count DESC
103+
LIMIT 3

‎packages/db-dtypes/docs/README.rst‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎packages/db-dtypes/docs/README.rst‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
Pandas Data Types for SQL systems (BigQuery, Spanner)
2+
=====================================================
3+
4+
|ga| |pypi| |versions|
5+
6+
`Pandas extension data types`_ for data from SQL systems such as `BigQuery`_.
7+
8+
- `Library Documentation`_
9+
10+
.. |ga| image:: https://img.shields.io/badge/support-GA-gold.svg
11+
:target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#general-availability
12+
.. |pypi| image:: https://img.shields.io/pypi/v/db-dtypes.svg
13+
:target: https://pypi.org/project/db-dtypes/
14+
.. |versions| image:: https://img.shields.io/pypi/pyversions/db-dtypes.svg
15+
:target: https://pypi.org/project/db-dtypes/
16+
.. _Pandas extension data types: https://pandas.pydata.org/docs/development/extending.html#extension-types
17+
.. _BigQuery: https://cloud.google.com/bigquery/docs/
18+
.. _Library Documentation: https://googleapis.dev/python/db-dtypes/latest
19+
20+
21+
Installation
22+
------------
23+
24+
Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
25+
create isolated Python environments. The basic problem it addresses is one of
26+
dependencies and versions, and indirectly permissions.
27+
28+
With `virtualenv`_, it's possible to install this library without needing system
29+
install permissions, and without clashing with the installed system
30+
dependencies.
31+
32+
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
33+
34+
35+
Supported Python Versions
36+
^^^^^^^^^^^^^^^^^^^^^^^^^
37+
Python >= 3.9
38+
39+
Unsupported Python Versions
40+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
41+
Python <= 3.8.
42+
43+
44+
Mac/Linux
45+
^^^^^^^^^
46+
47+
.. code-block:: console
48+
49+
pip install virtualenv
50+
virtualenv <your-env>
51+
source <your-env>/bin/activate
52+
<your-env>/bin/pip install db-dtypes
53+
54+
55+
Windows
56+
^^^^^^^
57+
58+
.. code-block:: console
59+
60+
pip install virtualenv
61+
virtualenv <your-env>
62+
<your-env>\Scripts\activate
63+
<your-env>\Scripts\pip.exe install db-dtypes

‎packages/google-auth-httplib2/docs/README.rst‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎packages/google-auth-httplib2/docs/README.rst‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
``httplib2`` Transport for Google Auth
2+
======================================
3+
4+
.. image:: https://img.shields.io/badge/status-deprecated-red.svg
5+
:target: https://github.com/httplib2/httplib2
6+
7+
The library was created to help clients migrate from `oauth2client <https://github.com/googleapis/oauth2client>`_ to `google-auth`_, however this library is no longer maintained. For any new usages please see provided transport layers by `google-auth`_ library.
8+
9+
10+
Documentation
11+
-------------
12+
13+
`httplib2 Transport for Google Auth Documentation`_
14+
15+
16+
Introduction
17+
------------
18+
|pypi|
19+
20+
This library provides an `httplib2`_ transport for `google-auth`_.
21+
22+
.. note:: ``httplib`` has lots of problems such as lack of threadsafety
23+
and insecure usage of TLS. Using it is highly discouraged. This
24+
library is intended to help existing users of ``oauth2client`` migrate to
25+
``google-auth``.
26+
27+
.. |pypi| image:: https://img.shields.io/pypi/v/google-auth-httplib2.svg
28+
:target: https://pypi.python.org/pypi/google-auth-httplib2
29+
30+
.. _httplib2: https://github.com/httplib2/httplib2
31+
.. _httplib2 Transport for Google Auth Documentation: https://googleapis.dev/python/google-auth-httplib2/latest
32+
.. _google-auth: https://github.com/GoogleCloudPlatform/google-auth-library-python/
33+
34+
35+
Installing
36+
----------
37+
38+
You can install using `pip`_::
39+
40+
$ pip install google-auth-httplib2
41+
42+
.. _pip: https://pip.pypa.io/en/stable/
43+
44+
License
45+
-------
46+
47+
Apache 2.0 - See `the LICENSE`_ for more information.
48+
49+
.. _the LICENSE: https://github.com/GoogleCloudPlatform/google-auth-library-python/blob/main/LICENSE

‎packages/google-cloud-bigquery/docs/README.rst‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎packages/google-cloud-bigquery/docs/README.rst‎

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
Python Client for Google BigQuery
2+
=================================
3+
4+
|GA| |pypi| |versions|
5+
6+
Querying massive datasets can be time consuming and expensive without the
7+
right hardware and infrastructure. Google `BigQuery`_ solves this problem by
8+
enabling super-fast, SQL queries against append-mostly tables, using the
9+
processing power of Google's infrastructure.
10+
11+
- `Client Library Documentation`_
12+
- `Product Documentation`_
13+
14+
.. |GA| image:: https://img.shields.io/badge/support-GA-gold.svg
15+
:target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#general-availability
16+
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-bigquery.svg
17+
:target: https://pypi.org/project/google-cloud-bigquery/
18+
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-bigquery.svg
19+
:target: https://pypi.org/project/google-cloud-bigquery/
20+
.. _BigQuery: https://cloud.google.com/bigquery/what-is-bigquery
21+
.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/bigquery/latest/summary_overview
22+
.. _Product Documentation: https://cloud.google.com/bigquery/docs/reference/v2/
23+
24+
Quick Start
25+
-----------
26+
27+
In order to use this library, you first need to go through the following steps:
28+
29+
1. `Select or create a Cloud Platform project.`_
30+
2. `Enable billing for your project.`_
31+
3. `Enable the Google Cloud BigQuery API.`_
32+
4. `Setup Authentication.`_
33+
34+
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
35+
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
36+
.. _Enable the Google Cloud BigQuery API.: https://cloud.google.com/bigquery
37+
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
38+
39+
Installation
40+
~~~~~~~~~~~~
41+
42+
Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
43+
create isolated Python environments. The basic problem it addresses is one of
44+
dependencies and versions, and indirectly permissions.
45+
46+
With `virtualenv`_, it's possible to install this library without needing system
47+
install permissions, and without clashing with the installed system
48+
dependencies.
49+
50+
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
51+
52+
53+
Supported Python Versions
54+
^^^^^^^^^^^^^^^^^^^^^^^^^
55+
Python >= 3.9
56+
57+
Unsupported Python Versions
58+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
59+
Python == 2.7, Python == 3.5, Python == 3.6, Python == 3.7, and Python == 3.8.
60+
61+
The last version of this library compatible with Python 2.7 and 3.5 is
62+
`google-cloud-bigquery==1.28.0`.
63+
64+
65+
Mac/Linux
66+
^^^^^^^^^
67+
68+
.. code-block:: console
69+
70+
pip install virtualenv
71+
virtualenv <your-env>
72+
source <your-env>/bin/activate
73+
<your-env>/bin/pip install google-cloud-bigquery
74+
75+
76+
Windows
77+
^^^^^^^
78+
79+
.. code-block:: console
80+
81+
pip install virtualenv
82+
virtualenv <your-env>
83+
<your-env>\Scripts\activate
84+
<your-env>\Scripts\pip.exe install google-cloud-bigquery
85+
86+
Example Usage
87+
-------------
88+
89+
Perform a query
90+
~~~~~~~~~~~~~~~
91+
92+
.. code:: python
93+
94+
from google.cloud import bigquery
95+
96+
client = bigquery.Client()
97+
98+
# Perform a query.
99+
QUERY = (
100+
'SELECT name FROM `bigquery-public-data.usa_names.usa_1910_2013` '
101+
'WHERE state = "TX" '
102+
'LIMIT 100')
103+
query_job = client.query(QUERY) # API request
104+
rows = query_job.result() # Waits for query to finish
105+
106+
for row in rows:
107+
print(row.name)
108+
109+
Instrumenting With OpenTelemetry
110+
--------------------------------
111+
112+
This application uses `OpenTelemetry`_ to output tracing data from
113+
API calls to BigQuery. To enable OpenTelemetry tracing in
114+
the BigQuery client the following PyPI packages need to be installed:
115+
116+
.. _OpenTelemetry: https://opentelemetry.io
117+
118+
.. code-block:: console
119+
120+
pip install google-cloud-bigquery[opentelemetry] opentelemetry-exporter-gcp-trace
121+
122+
After installation, OpenTelemetry can be used in the BigQuery
123+
client and in BigQuery jobs. First, however, an exporter must be
124+
specified for where the trace data will be outputted to. An
125+
example of this can be found here:
126+
127+
.. code-block:: python
128+
129+
from opentelemetry import trace
130+
from opentelemetry.sdk.trace import TracerProvider
131+
from opentelemetry.sdk.trace.export import BatchSpanProcessor
132+
from opentelemetry.exporter.cloud_trace import CloudTraceSpanExporter
133+
tracer_provider = TracerProvider()
134+
tracer_provider = BatchSpanProcessor(CloudTraceSpanExporter())
135+
trace.set_tracer_provider(TracerProvider())
136+
137+
In this example all tracing data will be published to the Google
138+
`Cloud Trace`_ console. For more information on OpenTelemetry, please consult the `OpenTelemetry documentation`_.
139+
140+
.. _OpenTelemetry documentation: https://opentelemetry-python.readthedocs.io
141+
.. _Cloud Trace: https://cloud.google.com/trace

‎packages/google-cloud-core/docs/README.rst‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)