Skip to content

Commit 7996d59

Browse files
authored
docs: update README to reflect repository move (#454)
1 parent 6e79d1f commit 7996d59

File tree

1 file changed

+35
-12
lines changed

1 file changed

+35
-12
lines changed

README.rst

Lines changed: 35 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
11
pandas-gbq
22
==========
33

4-
|Build Status| |Version Status| |Coverage Status| |Black Formatted|
4+
|preview| |pypi| |versions|
55

6-
**pandas-gbq** is a package providing an interface to the Google BigQuery API from pandas
6+
**pandas-gbq** is a package providing an interface to the Google BigQuery API from pandas.
77

8+
- `Library Documentation`_
9+
- `Product Documentation`_
10+
11+
.. |preview| image:: https://img.shields.io/badge/support-preview-orange.svg
12+
:target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#beta-support
13+
.. |pypi| image:: https://img.shields.io/pypi/v/pandas-gbq.svg
14+
:target: https://pypi.org/project/pandas-gbq/
15+
.. |versions| image:: https://img.shields.io/pypi/pyversions/pandas-gbq.svg
16+
:target: https://pypi.org/project/pandas-gbq/
17+
.. _Library Documentation: https://googleapis.dev/python/pandas-gbq/latest/
18+
.. _Product Documentation: https://cloud.google.com/bigquery/docs/reference/v2/
819

920
Installation
1021
------------
@@ -29,19 +40,31 @@ Install latest development version
2940

3041
.. code-block:: shell
3142
32-
$ pip install git+https://github.com/pydata/pandas-gbq.git
43+
$ pip install git+https://github.com/googleapis/python-bigquery-pandas.git
3344
3445
3546
Usage
3647
-----
3748

38-
See the `pandas-gbq documentation <https://pandas-gbq.readthedocs.io/>`_ for more details.
49+
Perform a query
50+
~~~~~~~~~~~~~~~
51+
52+
.. code:: python
53+
54+
import pandas_gbq
55+
56+
result_dataframe = pandas_gbq.read_gbq("SELECT column FROM dataset.table WHERE value = 'something'")
57+
58+
Upload a dataframe
59+
~~~~~~~~~~~~~~~~~~
60+
61+
.. code:: python
62+
63+
import pandas_gbq
64+
65+
pandas_gbq.to_gbq(dataframe, "dataset.table")
66+
67+
More samples
68+
~~~~~~~~~~~~
3969

40-
.. |Build Status| image:: https://circleci.com/gh/pydata/pandas-gbq/tree/master.svg?style=svg
41-
:target: https://circleci.com/gh/pydata/pandas-gbq/tree/master
42-
.. |Version Status| image:: https://img.shields.io/pypi/v/pandas-gbq.svg
43-
:target: https://pypi.python.org/pypi/pandas-gbq/
44-
.. |Coverage Status| image:: https://img.shields.io/codecov/c/github/pydata/pandas-gbq.svg
45-
:target: https://codecov.io/gh/pydata/pandas-gbq/
46-
.. |Black Formatted| image:: https://img.shields.io/badge/code%20style-black-000000.svg
47-
:target: https://github.com/ambv/black
70+
See the `pandas-gbq documentation <https://googleapis.dev/python/pandas-gbq/latest/>`_ for more details.

0 commit comments

Comments
 (0)