feat: Rename pybigquery to sqlalchemy-bigquery #198

jimfulton · 2021-07-02T14:38:33Z

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
Ensure the tests and linter pass
Code coverage does not decrease (if any source code was changed)
Appropriate docs were updated (if necessary)

Fixes #197 🦕

…m schema names.

It, itself isn't public.

and updated package name in copyright statement.

tswast · 2021-07-02T14:46:46Z

Could we add a warning to setup.py and the README and make a release of pybigquery first? I'd like to make sure folk who look for the pybigquery package are able to find sqlalchemy-bigquery.

I'm thinking something similar to what we're doing here: https://pypi.org/project/google-cloud/

jimfulton · 2021-07-02T14:57:49Z

Could we add a warning to setup.py and the README and make a release of pybigquery first? I'd like to make sure folk who look for the pybigquery package are able to find sqlalchemy-bigquery.

I'm thinking something similar to what we're doing here: https://pypi.org/project/google-cloud/

In this case, we'd be telling people to install a package that doesn't exist, wouldn't we?

Note that pybigquery will continue to work indefinitely!

Daft plan, modified based on your comment:

Release an alpha of sqlalchemy-bigquery
Release an alpha of pybigquery that is a facade/shim for sqlalchemy-bigquery
Non-alpha pybigquery works as expected.

Prior to these releases, test with non-pypi installs.
Decide when to go to non-alpha. For sake of discussion, say, July 42. ;)
Make a pybigquery release that gives folks a heads up of the swap on July 42.
On July 42, release non-alpha sqlalchemy-bigquery and non-alpha pybigquery shim

pybigquery shim still works but issues a deprecation warning.

Old installs of pybigquery or installes of pinned versions still work as expected.

Thoughts @tswast ?

…lalchemy-bigquery-197

tswast · 2021-07-13T19:16:17Z

In this case, we'd be telling people to install a package that doesn't exist, wouldn't we?

True. Maybe we try to use some of the LTS client automation and keep around a pybigquery branch for backports? Or maybe we just manually publish a release of pybigquery once sqlalchemy-bigquery is available?

jimfulton · 2021-07-13T19:41:55Z

There are a number of ways we could approach this, depending on what we (you :) ) want to do. Let's discuss on Wednesday. Jim

…

On Tue, Jul 13, 2021 at 3:17 PM Tim Swast ***@***.***> wrote: In this case, we'd be telling people to install a package that doesn't exist, wouldn't we? True. Maybe we try to use some of the LTS client automation and keep around a pybigquery branch for backports? Or maybe we just manually publish a release of pybigquery once sqlalchemy-bigquery is available? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#198 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAF4U5YTOHRYENEPHAZOINTTXSGI3ANCNFSM47W3FT6A> .

-- Jim Fulton http://jimfulton.info

.repo-metadata.json

Co-authored-by: Tim Swast <swast@google.com>

jimfulton · 2021-07-16T11:54:52Z

Note that we have to sort out the new name, since the new name was taken.

cpdean · 2021-08-01T11:24:57Z

Note that we have to sort out the new name, since the new name was taken.

Hey @jimfulton and @tswast , I have added Jim as an owner on https://pypi.org/project/sqlalchemy_bigquery/ , and added a redirect notice on my old project at https://github.com/cpdean/sqlalchemy-bigquery .

Let me know if there's anything else I can do to help.

jimfulton · 2021-08-02T13:11:59Z

Note that we have to sort out the new name, since the new name was taken.

Hey @jimfulton and @tswast , I have added Jim as an owner on https://pypi.org/project/sqlalchemy_bigquery/ , and added a redirect notice on my old project at https://github.com/cpdean/sqlalchemy-bigquery .

Let me know if there's anything else I can do to help.

@cpdean Thank you very much!

jimfulton · 2021-08-05T16:09:23Z

@tswast are you good with this?

tswast

Looking good! A couple minor comments. I think we can merge this sooner rather than later.

tswast · 2021-08-05T17:46:29Z

.repo-metadata.json

  "release_level": "beta",
  "language": "python",
  "library_type": "INTEGRATION",
  "repo": "googleapis/python-bigquery-sqlalchemy",
-  "distribution_name": "pybigquery",
+  "distribution_name": "sqlalchemy-bigquery"


Need extra comma now that we added api_id

Suggested change

"distribution_name": "sqlalchemy-bigquery"

"distribution_name": "sqlalchemy-bigquery",

tswast · 2021-08-05T17:50:00Z

sqlalchemy_bigquery/__init__.py

+except ImportError:
+    pass
+else:  # pragma: NO COVER
+    if not hasattr(pybigquery, "__version__"):


I'm curious what the not hasattr is doing. Could you add a comment about this? If __version__ is present it's less likely to conflict?

That's a holdover from the shim, I think. The shim would have that attribute. I'll get rid of it.

jimfulton · 2021-08-05T18:47:24Z

Looking good! A couple minor comments. I think we can merge this sooner rather than later.

I also just removed the api module, which we'd discussed, but that I just remembered. :)

sqlalchemy_bigquery/__init__.py

…distributed as pybigquery

tswast · 2021-08-06T18:52:09Z

README.rst

 .. code-block:: python

-    from pybigquery.api import ApiClient
+    from sqlalchemy_bigquery.api import ApiClient
    api_client = ApiClient()
    print(api_client.dry_run_query(query=sqlstr).total_bytes_processed)


We can remove this code sample now that we don't have an ApiClient

Dang, I did yesterday, but I guess that change lost in my docfx flailing. Thanks, will do.

jimfulton added 16 commits July 1, 2021 11:30

Rename refs in files

839965e

Move package

7b9dd6b

more renaming

dc70785

Expose dialect and types

ca88aaa

explain the weird registration

d0f9bd4

fixed: No longer need test_pybigquery_sqla schema, we generte rando…

c35a686

…m schema names.

document that we obsolete pybigquery

b2636d6

get _type_map from the base module.

9a82e92

It, itself isn't public.

fix import

33da56c

Warn if an old (non-empty) version of pybigquery is installed.

073293f

Add __version__

3555943

fixed names

b3d022b

Updated the way the path to __init__.py is computed

af5242a

and updated package name in copyright statement.

Updated copyright statements with new package name

2a0f6a0

Define the version in version.py

b0458cc

skip coverage for code handling pybigquery hanging around

95c1bc3

product-auto-label bot added the api: bigquery Issues related to the googleapis/python-bigquery-sqlalchemy API. label Jul 2, 2021

google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Jul 2, 2021

jimfulton added 2 commits July 2, 2021 11:03

blacken/lint

159f618

Merge branch 'master' into sqlalchemy-bigquery-197

e2d6021

jimfulton requested a review from tswast July 2, 2021 20:39

jimfulton added 3 commits July 6, 2021 11:38

merge upstream

e5dc64b

Merge remote-tracking branch 'origin/sqlalchemy-bigquery-197' into sq…

a0eeeff

…lalchemy-bigquery-197

merge upstream

5975e16

tswast reviewed Jul 14, 2021

View reviewed changes

.repo-metadata.json Outdated Show resolved Hide resolved

Update .repo-metadata.json

132fcd1

Co-authored-by: Tim Swast <swast@google.com>

Merge branch 'master' into sqlalchemy-bigquery-197

741f3a4

Merge branch 'master' into sqlalchemy-bigquery-197

20bc572

cpdean mentioned this pull request Aug 1, 2021

Let Google pybigquery project use the sqlalchemy-bigquery name in PyPI cpdean/sqlalchemy-bigquery#7

Closed

merge upstream/master

02f4b54

jimfulton added 2 commits August 5, 2021 12:26

merge upstream/master

0ab7d52

Keep pybigquery history pypi link

64a26a6

tswast reviewed Aug 5, 2021

View reviewed changes

jimfulton added 4 commits August 5, 2021 14:41

Removed the api module

0aed0cb

added missing comma

3ac10f8

we decided not to have a shim, so get rid of the check for it.

9b49a87

fixed indentation

9c31524

tswast requested changes Aug 5, 2021

View reviewed changes

sqlalchemy_bigquery/__init__.py Show resolved Hide resolved

sqlalchemy_bigquery/__init__.py Outdated Show resolved Hide resolved

jimfulton added 4 commits August 6, 2021 08:35

Added missing import and added module docstring

5f821e3

More docs reorg

24a7e59

fixed some heading levels and also highlight that older versions are …

1b7be89

…distributed as pybigquery

lint

657054f

jimfulton marked this pull request as ready for review August 6, 2021 15:43

jimfulton requested a review from a team as a code owner August 6, 2021 15:43

tswast reviewed Aug 6, 2021

View reviewed changes

removed a reference to the old API client

8f1c2e4

tswast approved these changes Aug 10, 2021

View reviewed changes

jimfulton merged commit a6f0a5d into googleapis:master Aug 10, 2021

jimfulton deleted the sqlalchemy-bigquery-197 branch August 10, 2021 14:57

tswast mentioned this pull request Nov 11, 2022

Reference new repo location in README, CHANGELOG, and other docs #91

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Rename pybigquery to sqlalchemy-bigquery #198

feat: Rename pybigquery to sqlalchemy-bigquery #198

jimfulton commented Jul 2, 2021

tswast commented Jul 2, 2021

jimfulton commented Jul 2, 2021 •

edited

tswast commented Jul 13, 2021

jimfulton commented Jul 13, 2021 via email

jimfulton commented Jul 16, 2021

cpdean commented Aug 1, 2021

jimfulton commented Aug 2, 2021

jimfulton commented Aug 5, 2021

tswast left a comment

tswast Aug 5, 2021

jimfulton Aug 5, 2021

tswast Aug 5, 2021

jimfulton Aug 5, 2021

jimfulton Aug 5, 2021

jimfulton commented Aug 5, 2021

tswast Aug 6, 2021

jimfulton Aug 6, 2021

jimfulton Aug 7, 2021

	"distribution_name": "sqlalchemy-bigquery"
	"distribution_name": "sqlalchemy-bigquery",

feat: Rename pybigquery to sqlalchemy-bigquery #198

feat: Rename pybigquery to sqlalchemy-bigquery #198

Conversation

jimfulton commented Jul 2, 2021

tswast commented Jul 2, 2021

jimfulton commented Jul 2, 2021 • edited

tswast commented Jul 13, 2021

jimfulton commented Jul 13, 2021 via email

jimfulton commented Jul 16, 2021

cpdean commented Aug 1, 2021

jimfulton commented Aug 2, 2021

jimfulton commented Aug 5, 2021

tswast left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jimfulton commented Aug 5, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jimfulton commented Jul 2, 2021 •

edited