feat: Rename pybigquery to sqlalchemy-bigquery

.coveragerc

@@ -18,7 +18,7 @@
 [run]
 branch = True
 omit =
-  pybigquery/requirements.py
+  sqlalchemy_bigquery/requirements.py
 
 [report]
 fail_under = 100
@@ -35,4 +35,4 @@ omit =
   */proto/*.py
   */core/*.py
   */site-packages/*.py
-  pybigquery/requirements.py
+  sqlalchemy_bigquery/requirements.py

.github/ISSUE_TEMPLATE/bug_report.md

@@ -20,7 +20,7 @@ If you are still having issues, please be sure to include as much information as
   - OS type and version:
   - Python version: `python --version`
   - pip version: `pip --version`
-  - `pybigquery` version: `pip show pybigquery`
+  - `sqlalchemy-bigquery` version: `pip show sqlalchemy-bigquery`
 
 #### Steps to reproduce
 

.repo-metadata.json

@@ -1,10 +1,10 @@
 {
-  "name": "pybigquery",
+  "name": "sqlalchemy-bigquery",
   "name_pretty": "SQLAlchemy dialect for BigQuery",
-  "client_documentation": "https://github.com/googleapis/pybigquery",
+  "client_documentation": "https://github.com/googleapis/sqlalchemy-bigquery",
   "release_level": "beta",
   "language": "python",
   "library_type": "INTEGRATION",
   "repo": "googleapis/python-bigquery-sqlalchemy",
-  "distribution_name": "pybigquery"
-}
+  "distribution_name": "sqlalchemy-bigquery"
+}

AUTHORS

@@ -1,4 +1,4 @@
-# This is the list of pybigquery's significant contributors.
+# This is the list of sqlalchemy-bigquery's significant contributors.
 #
 # This does not necessarily list everyone who has contributed code,
 # especially since many employees of one corporation may be contributing.
@@ -12,6 +12,7 @@ Google LLC
 Harshal Sheth
 Jacob Hayes
 James Campbell
+Jim Fulton
 Joshua Carp
 Kurian (kuriancheeramelil)
 Maksym Voitko

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 [PyPI History][1]
 
-[1]: https://pypi.org/project/pybigquery/#history
+[1]: https://pypi.org/project/sqlalchemy-bigquery/#history
 
 ## [0.10.0](https://www.github.com/googleapis/python-bigquery-sqlalchemy/compare/v0.9.1...v0.10.0) (2021-07-06)
 

CONTRIBUTING.rst

@@ -188,7 +188,7 @@ instead of
 ``https://github.com/googleapis/python-bigquery-sqlalchemy/blob/master/CONTRIBUTING.rst``)
 may cause problems creating links or rendering the description.
 
-.. _description on PyPI: https://pypi.org/project/pybigquery
+.. _description on PyPI: https://pypi.org/project/sqlalchemy-bigquery
 
 
 *************************

README.rst

@@ -10,12 +10,12 @@ SQLAlchemy Dialect for BigQuery
 
 .. |beta| image:: https://img.shields.io/badge/support-beta-orange.svg
    :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#beta-support
-.. |pypi| image:: https://img.shields.io/pypi/v/pybigquery.svg
-   :target: https://pypi.org/project/pybigquery/
-.. |versions| image:: https://img.shields.io/pypi/pyversions/pybigquery.svg
-   :target: https://pypi.org/project/pybigquery/
+.. |pypi| image:: https://img.shields.io/pypi/v/sqlalchemy-bigquery.svg
+   :target: https://pypi.org/project/sqlalchemy-bigquery/
+.. |versions| image:: https://img.shields.io/pypi/pyversions/sqlalchemy-bigquery.svg
+   :target: https://pypi.org/project/sqlalchemy-bigquery/
 .. _SQLAlchemy Dialects: https://docs.sqlalchemy.org/en/14/dialects/
-.. _Dialect Documentation: https://googleapis.dev/python/pybigquery/latest
+.. _Dialect Documentation: https://googleapis.dev/python/sqlalchemy-bigquery/latest
 .. _Product Documentation: https://cloud.google.com/bigquery/docs/
 
 
@@ -65,7 +65,7 @@ Mac/Linux
     pip install virtualenv
     virtualenv <your-env>
     source <your-env>/bin/activate
-    <your-env>/bin/pip install pybigquery
+    <your-env>/bin/pip install sqlalchemy-bigquery
 
 
 Windows
@@ -76,7 +76,7 @@ Windows
     pip install virtualenv
     virtualenv <your-env>
     <your-env>\Scripts\activate
-    <your-env>\Scripts\pip.exe install pybigquery
+    <your-env>\Scripts\pip.exe install sqlalchemy-bigquery
 
 Usage
 -----
@@ -98,7 +98,7 @@ API Client
 
 .. 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)
 

docs/conf.py

@@ -13,7 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-# pybigquery documentation build configuration file
+# sqlalchemy-bigquery documentation build configuration file
 #
 # This file is execfile()d with the current directory set to its
 # containing dir.
@@ -80,7 +80,7 @@
 master_doc = "index"
 
 # General information about the project.
-project = "pybigquery"
+project = "sqlalchemy-bigquery"
 copyright = "2019, Google"
 author = "Google APIs"
 
@@ -153,7 +153,7 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 html_theme_options = {
-    "description": "Google Cloud Client Libraries for pybigquery",
+    "description": "Google Cloud Client Libraries for sqlalchemy-bigquery",
     "github_user": "googleapis",
     "github_repo": "python-bigquery-sqlalchemy",
     "github_banner": True,
@@ -247,7 +247,7 @@
 # html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = "pybigquery-doc"
+htmlhelp_basename = "sqlalchemy-bigquery-doc"
 
 # -- Options for warnings ------------------------------------------------------
 
@@ -278,7 +278,13 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, "pybigquery.tex", "pybigquery Documentation", author, "manual",)
+    (
+        master_doc,
+        "sqlalchemy-bigquery.tex",
+        "sqlalchemy-bigquery Documentation",
+        author,
+        "manual",
+    )
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -306,7 +312,15 @@
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, "pybigquery", "pybigquery Documentation", [author], 1,)]
+man_pages = [
+    (
+        master_doc,
+        "sqlalchemy-bigquery",
+        "sqlalchemy-bigquery Documentation",
+        [author],
+        1,
+    )
+]
 
 # If true, show URL addresses after external links.
 # man_show_urls = False
@@ -320,11 +334,11 @@
 texinfo_documents = [
     (
         master_doc,
-        "pybigquery",
-        "pybigquery Documentation",
+        "sqlalchemy-bigquery",
+        "sqlalchemy-bigquery Documentation",
         author,
-        "pybigquery",
-        "pybigquery Library",
+        "sqlalchemy-bigquery",
+        "sqlalchemy-bigquery Library",
         "APIs",
     )
 ]

docs/index.rst

@@ -9,12 +9,12 @@ API Reference
 .. toctree::
     :maxdepth: 2
 
-    pybigquery/api
+    sqlalchemy-bigquery/api
 
 Changelog
 ---------
 
-For a list of all ``pybigquery`` releases:
+For a list of all ``sqlalchemy-bigquery`` releases:
 
 .. toctree::
    :maxdepth: 2

docs/sqlalchemy-bigquery/api.rst

@@ -0,0 +1,7 @@
+sqlalchemy-bigquery API
+=======================
+
+.. automodule:: sqlalchemy_bigquery.api
+    :members:
+    :undoc-members:
+    :inherited-members:

noxfile.py

@@ -25,7 +25,7 @@
 
 
 BLACK_VERSION = "black==19.10b0"
-BLACK_PATHS = ["docs", "pybigquery", "tests", "noxfile.py", "setup.py"]
+BLACK_PATHS = ["docs", "sqlalchemy_bigquery", "tests", "noxfile.py", "setup.py"]
 
 DEFAULT_PYTHON_VERSION = "3.8"
 
@@ -63,7 +63,7 @@ def lint(session):
     session.run(
         "black", "--check", *BLACK_PATHS,
     )
-    session.run("flake8", "pybigquery", "tests")
+    session.run("flake8", "sqlalchemy_bigquery", "tests")
 
 
 @nox.session(python=DEFAULT_PYTHON_VERSION)
@@ -114,7 +114,7 @@ def default(session):
         "py.test",
         "--quiet",
         f"--junitxml=unit_{session.python}_sponge_log.xml",
-        "--cov=pybigquery",
+        "--cov=sqlalchemy_bigquery",
         "--cov=tests/unit",
         "--cov-append",
         "--cov-config=.coveragerc",

owlbot.py

@@ -33,7 +33,7 @@
     cov_level=100
 )
 s.move(templated_files, excludes=[
-    # pybigquery was originally licensed MIT
+    # sqlalchemy-bigquery was originally licensed MIT
     "LICENSE"
 ])
 
@@ -44,17 +44,17 @@
 s.replace(
     [".coveragerc"],
     "google/cloud/__init__.py",
-    "pybigquery/requirements.py",
+    "sqlalchemy_bigquery/requirements.py",
     )
 
 s.replace(
     ["noxfile.py"],
     r"[\"']google[\"']",
-    '"pybigquery"',
+    '"sqlalchemy_bigquery"',
 )
 
 s.replace(
-    ["noxfile.py"], "google/cloud", "pybigquery",
+    ["noxfile.py"], "google/cloud", "sqlalchemy_bigquery",
 )
 
 def place_before(path, text, *before_text, escape=None):
@@ -192,7 +192,7 @@ def compliance(session):
     """universal = 1
 
 [sqla_testing]
-requirement_cls=pybigquery.requirements:Requirements
+requirement_cls=sqlalchemy_bigquery.requirements:Requirements
 profile_file=.sqlalchemy_dialect_compliance-profiles.txt
 
 [tool:pytest]

release-procedure.md

@@ -1,4 +1,4 @@
-# pybigquery release procedure
+# sqlalchemy-bigquery release procedure
 
 *   Checkout master branch
 
@@ -26,7 +26,7 @@
 
 *   Try out test PyPI package
 
-        pip install --upgrade --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple pybigquery
+        pip install --upgrade --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple sqlalchemy-bigquery
 
 *   Upload to PyPI
 

setup.cfg

@@ -19,7 +19,7 @@
 universal = 1
 
 [sqla_testing]
-requirement_cls=pybigquery.requirements:Requirements
+requirement_cls=sqlalchemy_bigquery.requirements:Requirements
 profile_file=.sqlalchemy_dialect_compliance-profiles.txt
 
 [tool:pytest]

setup.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# Copyright (c) 2017 The PyBigQuery Authors
+# Copyright (c) 2017 The sqlalchemy-bigquery Authors
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of
 # this software and associated documentation files (the "Software"), to deal in
@@ -19,12 +19,13 @@
 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 import io
+import os
+import re
 from setuptools import setup
 
 # Package metadata.
 
-name = "pybigquery"
-version = "0.10.0"
+name = "sqlalchemy-bigquery"
 description = "SQLAlchemy dialect for BigQuery"
 
 # Should be one of:
@@ -33,6 +34,10 @@
 # 'Development Status :: 5 - Production/Stable'
 release_status = "Development Status :: 4 - Beta"
 
+package_root = os.path.abspath(os.path.dirname(__file__))
+with open(os.path.join(package_root, "sqlalchemy_bigquery", "version.py")) as f:
+    version = re.search('__version__ = "([^"]+)"', f.read()).group(1)
+
 
 def readme():
     with io.open("README.rst", "r", encoding="utf8") as f:
@@ -45,9 +50,9 @@ def readme():
     description=description,
     long_description=readme(),
     long_description_content_type="text/x-rst",
-    author="The PyBigQuery Authors",
+    author="The Sqlalchemy-Bigquery Authors",
     author_email="googleapis-packages@google.com",
-    packages=["pybigquery"],
+    packages=["sqlalchemy_bigquery"],
     url="https://github.com/googleapis/python-bigquery-sqlalchemy",
     keywords=["bigquery", "sqlalchemy"],
     classifiers=[
@@ -74,8 +79,10 @@ def readme():
     python_requires=">=3.6, <3.10",
     tests_require=["pytz"],
     entry_points={
-        "sqlalchemy.dialects": [
-            "bigquery = pybigquery.sqlalchemy_bigquery:BigQueryDialect"
-        ]
+        "sqlalchemy.dialects": ["bigquery = sqlalchemy_bigquery:BigQueryDialect"]
     },
+    # Document that this replaces pybigquery, however, this isn't
+    # enforced by pip, because doing so would allow rogue packages to
+    # obsolete legitimate ones.
+    obsoletes=["pybigquery"],
 )