Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update pandas.read_gbq docs to point to pandas-gbq #18548

Merged
merged 3 commits into from
Dec 1, 2017

Conversation

tswast
Copy link
Contributor

@tswast tswast commented Nov 28, 2017

The pandas-gbq package must be installed to use pandas.read_gbq.
Also, with soon-to-be-release version 0.3.0 of pandas-gbq the Google
Cloud client library is used instead of the Google API library.

Also, standard SQL is no longer beta. In fact it is highly recommended
over using legacy SQL.

  • N/A - closes #xxxx
  • N/A (docs change only) - tests added / passed
  • passes git diff upstream/master -u -- "*.py" | flake8 --diff
  • N/A (docs change only) - whatsnew entry

@codecov
Copy link

codecov bot commented Nov 28, 2017

Codecov Report

Merging #18548 into master will decrease coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #18548      +/-   ##
==========================================
- Coverage   91.35%   91.33%   -0.02%     
==========================================
  Files         164      164              
  Lines       49802    49802              
==========================================
- Hits        45496    45487       -9     
- Misses       4306     4315       +9
Flag Coverage Δ
#multiple 89.13% <ø> (ø) ⬆️
#single 40.81% <ø> (-0.07%) ⬇️
Impacted Files Coverage Δ
pandas/io/gbq.py 25% <ø> (-58.34%) ⬇️
pandas/core/frame.py 97.81% <0%> (-0.1%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2a0e54b...a1ce420. Read the comment docs.

@codecov
Copy link

codecov bot commented Nov 28, 2017

Codecov Report

Merging #18548 into master will decrease coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #18548      +/-   ##
==========================================
- Coverage   91.35%   91.33%   -0.02%     
==========================================
  Files         164      164              
  Lines       49802    49802              
==========================================
- Hits        45496    45487       -9     
- Misses       4306     4315       +9
Flag Coverage Δ
#multiple 89.13% <ø> (ø) ⬆️
#single 40.81% <ø> (-0.07%) ⬇️
Impacted Files Coverage Δ
pandas/io/gbq.py 25% <ø> (-58.34%) ⬇️
pandas/core/frame.py 97.81% <0%> (-0.1%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7627cca...135d2f8. Read the comment docs.

Google BigQuery API Client Library v2 for Python is used.
Documentation is available `here
<https://developers.google.com/api-client-library/python/apis/bigquery/v2>`__
This function requires the `pandas-gbq package
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So need to have a section in the pandas-gbq docs on how to deal with < 0.3.0 (IOW list the deps and such).

Also I would remove the referenes here tot the google cloud library itself, you just need to install pandas-gbq, which depending the installed version has different requirements.

also there is a referene in install.rst to pandas-gbq, see if it needs updating.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done, done, and done.

tswast and others added 3 commits November 29, 2017 10:14
The `pandas-gbq` package must be installed to use `pandas.read_gbq`.
Also, with soon-to-be-release version 0.3.0 of `pandas-gbq` the Google
Cloud client library is used instead of the Google API library.

Also, standard SQL is no longer beta. In fact it is highly recommended
over using legacy SQL.
@tswast
Copy link
Contributor Author

tswast commented Nov 30, 2017

Since this PR no longer talks about explicit dependencies that pandas-gbq has it is not dependent on googleapis/python-bigquery-pandas#25. I believe it can be merged any time.

@jreback jreback added this to the 0.21.1 milestone Dec 1, 2017
@jreback jreback merged commit 5cd5e3b into pandas-dev:master Dec 1, 2017
@jreback
Copy link
Contributor

jreback commented Dec 1, 2017

thanks @tswast

TomAugspurger pushed a commit to TomAugspurger/pandas that referenced this pull request Dec 8, 2017
TomAugspurger pushed a commit that referenced this pull request Dec 11, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants