docs: add templates for move to googleapis/python-bigquery-sqlalchemy repo #88

tswast · 2021-03-23T16:26:06Z

Closes #85

tswast · 2021-03-23T16:28:44Z

synth.py

@@ -0,0 +1,59 @@
+# Copyright 2021 Google LLC


Manual code

tswast · 2021-03-23T16:28:56Z

setup.py

@@ -21,39 +21,58 @@
 import io
 from setuptools import setup

+# Package metadata.


Manual code

setup.cfg

tswast · 2021-03-23T20:39:21Z

Test output (local)

$ nox
nox > Running session unit-3.6
nox > Creating virtual environment (virtualenv) using python3.6 in .nox/unit-3-6
nox > pip install mock pytest pytest-cov -c /Users/swast/src/pybigquery/testing/constraints-3.6.txt
nox > pip install -e . -c /Users/swast/src/pybigquery/testing/constraints-3.6.txt
nox > py.test --quiet --junitxml=unit_3.6_sponge_log.xml --cov=pybigquery --cov=tests/unit --cov-append --cov-config=.coveragerc --cov-report= --cov-fail-under=0 tests/unit
.....................................                                                                                       [100%]
----------------------------- generated xml file: /Users/swast/src/pybigquery/unit_3.6_sponge_log.xml -----------------------------


37 passed in 1.14s
nox > Session unit-3.6 was successful.
nox > Running session unit-3.7
nox > Creating virtual environment (virtualenv) using python3.7 in .nox/unit-3-7
nox > pip install mock pytest pytest-cov -c /Users/swast/src/pybigquery/testing/constraints-3.7.txt
nox > pip install -e . -c /Users/swast/src/pybigquery/testing/constraints-3.7.txt
nox > py.test --quiet --junitxml=unit_3.7_sponge_log.xml --cov=pybigquery --cov=tests/unit --cov-append --cov-config=.coveragerc --cov-report= --cov-fail-under=0 tests/unit
.....................................                                                                                       [100%]
----------------------------- generated xml file: /Users/swast/src/pybigquery/unit_3.7_sponge_log.xml -----------------------------


37 passed in 1.17s
nox > Session unit-3.7 was successful.
nox > Running session unit-3.8
nox > Creating virtual environment (virtualenv) using python3.8 in .nox/unit-3-8
nox > pip install mock pytest pytest-cov -c /Users/swast/src/pybigquery/testing/constraints-3.8.txt
nox > pip install -e . -c /Users/swast/src/pybigquery/testing/constraints-3.8.txt
nox > py.test --quiet --junitxml=unit_3.8_sponge_log.xml --cov=pybigquery --cov=tests/unit --cov-append --cov-config=.coveragerc --cov-report= --cov-fail-under=0 tests/unit
.....................................                                                                                       [100%]
----------------------------- generated xml file: /Users/swast/src/pybigquery/unit_3.8_sponge_log.xml -----------------------------


37 passed in 1.09s
nox > Session unit-3.8 was successful.
nox > Running session unit-3.9
nox > Creating virtual environment (virtualenv) using python3.9 in .nox/unit-3-9
nox > pip install mock pytest pytest-cov -c /Users/swast/src/pybigquery/testing/constraints-3.9.txt
nox > pip install -e . -c /Users/swast/src/pybigquery/testing/constraints-3.9.txt
nox > py.test --quiet --junitxml=unit_3.9_sponge_log.xml --cov=pybigquery --cov=tests/unit --cov-append --cov-config=.coveragerc --cov-report= --cov-fail-under=0 tests/unit
.....................................                                                                                       [100%]
----------------------------- generated xml file: /Users/swast/src/pybigquery/unit_3.9_sponge_log.xml -----------------------------


37 passed in 1.54s
nox > Session unit-3.9 was successful.
nox > Running session system-3.8
nox > Creating virtual environment (virtualenv) using python3.8 in .nox/system-3-8
nox > pip install --pre grpcio
nox > pip install mock pytest google-cloud-testutils -c /Users/swast/src/pybigquery/testing/constraints-3.8.txt
nox > pip install -e . -c /Users/swast/src/pybigquery/testing/constraints-3.8.txt
nox > py.test --quiet --junitxml=system_3.8_sponge_log.xml tests/system
........................................                                                                                    [100%]
======================================================== warnings summary =========================================================
tests/system/test_sqlalchemy_bigquery.py::test_engine_with_dataset
tests/system/test_sqlalchemy_bigquery.py::test_dataset_location
tests/system/test_sqlalchemy_bigquery.py::test_reflect_select
tests/system/test_sqlalchemy_bigquery.py::test_custom_expression
  /Users/swast/src/pybigquery/.nox/system-3-8/lib/python3.8/site-packages/google/cloud/bigquery/client.py:444: UserWarning: Cannot create BigQuery Storage client, the dependency google-cloud-bigquery-storage is not installed.
    warnings.warn(

-- Docs: https://docs.pytest.org/en/stable/warnings.html
---------------------------- generated xml file: /Users/swast/src/pybigquery/system_3.8_sponge_log.xml ----------------------------
40 passed, 4 warnings in 54.32s
nox > Session system-3.8 was successful.
nox > Running session cover
nox > Creating virtual environment (virtualenv) using python3.8 in .nox/cover
nox > pip install coverage pytest-cov
nox > coverage report --show-missing --fail-under=50
Name                                Stmts   Miss Branch BrPart  Cover   Missing
-------------------------------------------------------------------------------
pybigquery/__init__.py                  0      0      0      0   100%
pybigquery/api.py                      16     16      2      0     0%   20-43
pybigquery/parse_url.py               112      1     50      2    98%   41, 232->242
pybigquery/sqlalchemy_bigquery.py     331    219    104      0    26%   60, 72, 82-83, 90-108, 111-121, 154-157, 162-164, 174-175, 181-209, 216-218, 221, 228, 231, 234, 237, 240, 243, 246, 249, 256, 260, 263-270, 273-285, 319-324, 328, 333, 338-343, 348-362, 370-411, 419, 422-441, 446-462, 467-516, 519-529, 532-536, 543-558, 561-584, 587-588, 594, 598, 601-619, 622-629, 632-635, 638-641, 645, 649, 653
tests/unit/test_dialect_types.py        6      0      2      0   100%
tests/unit/test_parse_url.py           62      0      8      0   100%
-------------------------------------------------------------------------------
TOTAL                                 527    236    166      2    50%
nox > coverage erase
nox > Session cover was successful.
nox > Running session lint
nox > Creating virtual environment (virtualenv) using python3.8 in .nox/lint
nox > pip install flake8 black==19.10b0
nox > black --check docs pybigquery tests noxfile.py setup.py
All done! ✨ 🍰 ✨
12 files would be left unchanged.
nox > flake8 pybigquery tests
tests/unit/test_parse_url.py:201:83: E231 missing whitespace after ','
tests/system/test_sqlalchemy_bigquery.py:72:36: E231 missing whitespace after ','
tests/system/test_sqlalchemy_bigquery.py:73:49: E231 missing whitespace after ','
tests/system/test_sqlalchemy_bigquery.py:220:37: E231 missing whitespace after ','
tests/system/test_sqlalchemy_bigquery.py:389:75: E231 missing whitespace after ','
nox > Command flake8 pybigquery tests failed with exit code 1
nox > Session lint failed.
nox > Running session lint_setup_py
nox > Creating virtual environment (virtualenv) using python3.8 in .nox/lint_setup_py
nox > pip install docutils pygments
nox > python setup.py check --restructuredtext --strict
running check
nox > Session lint_setup_py was successful.
nox > Running session blacken
nox > Creating virtual environment (virtualenv) using python3.6 in .nox/blacken
nox > pip install black==19.10b0
nox > black docs pybigquery tests noxfile.py setup.py
All done! ✨ 🍰 ✨
12 files left unchanged.
nox > Session blacken was successful.
nox > Running session docs
nox > Creating virtual environment (virtualenv) using python3.8 in .nox/docs
nox > pip install -e .
nox > pip install sphinx alabaster recommonmark
nox > sphinx-build -W -T -N -b html -d docs/_build/doctrees/ docs/ docs/_build/html/
Running Sphinx v3.5.3
making output directory... done
[autosummary] generating autosummary for: multiprocessing.rst
loading intersphinx inventory from https://python.readthedocs.org/en/latest/objects.inv...
loading intersphinx inventory from https://googleapis.dev/python/google-auth/latest/objects.inv...
loading intersphinx inventory from https://googleapis.dev/python/google-api-core/latest/objects.inv...
loading intersphinx inventory from https://grpc.github.io/grpc/python/objects.inv...
loading intersphinx inventory from https://proto-plus-python.readthedocs.io/en/latest/objects.inv...
intersphinx inventory has moved: https://python.readthedocs.org/en/latest/objects.inv -> https://python.readthedocs.io/en/latest/objects.inv
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 1 source files that are out of date
updating environment: [new config] 1 added, 0 changed, 0 removed
reading sources... [100%] multiprocessing


Traceback (most recent call last):
  File "/Users/swast/src/pybigquery/.nox/docs/lib/python3.8/site-packages/sphinx/cmd/build.py", line 280, in build_main
    app.build(args.force_all, filenames)
  File "/Users/swast/src/pybigquery/.nox/docs/lib/python3.8/site-packages/sphinx/application.py", line 352, in build
    self.builder.build_update()
  File "/Users/swast/src/pybigquery/.nox/docs/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 296, in build_update
    self.build(to_build,
  File "/Users/swast/src/pybigquery/.nox/docs/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 310, in build
    updated_docnames = set(self.read())
  File "/Users/swast/src/pybigquery/.nox/docs/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 420, in read
    raise SphinxError('master file %s not found' %
sphinx.errors.SphinxError: master file /Users/swast/src/pybigquery/docs/index.rst not found

Sphinx error:
master file /Users/swast/src/pybigquery/docs/index.rst not found
nox > Command sphinx-build -W -T -N -b html -d docs/_build/doctrees/ docs/ docs/_build/html/ failed with exit code 2
nox > Session docs failed.
nox > Ran multiple sessions:
nox > * unit-3.6: success
nox > * unit-3.7: success
nox > * unit-3.8: success
nox > * unit-3.9: success
nox > * system-3.8: success
nox > * cover: success
nox > * lint: failed
nox > * lint_setup_py: success
nox > * blacken: success
nox > * docs: failed

I can fix up those trailing commas in this PR for the lint session, but for docs I'd prefer to cover that in a follow-up PR. #90

shollyman

Templated and manual files seem okay.

Should there be something added in this or another PR indicating the transitions in the CHANGELOG or README? Or address that when you cut the first release?

tswast · 2021-03-23T20:48:15Z

Should there be something added in this or another PR indicating the transitions in the CHANGELOG or README? Or address that when you cut the first release?

Good call. Filed #91 to do this.

I'm hoping that release-please can take over ownership of the changelog, so I'll mention the move in the commit subject for this PR.

🤖 I have created a release \*beep\* \*boop\* --- ### [0.5.1](https://www.github.com/googleapis/python-bigquery-sqlalchemy/compare/v0.5.0...v0.5.1) (2021-04-01) ### Bug Fixes * avoid 404 if dataset is deleted while listing tables or views ([#106](https://www.github.com/googleapis/python-bigquery-sqlalchemy/issues/106)) ([db379d8](https://www.github.com/googleapis/python-bigquery-sqlalchemy/commit/db379d850b916149db5976689d6f2323d2281f7a)) ### Documentation * add templates for move to googleapis/python-bigquery-sqlalchemy repo ([#88](https://www.github.com/googleapis/python-bigquery-sqlalchemy/issues/88)) ([37e584e](https://www.github.com/googleapis/python-bigquery-sqlalchemy/commit/37e584e05db6316b4abd41ebc08486047d2c49b8)) * build documentation with Sphinx ([#97](https://www.github.com/googleapis/python-bigquery-sqlalchemy/issues/97)) ([1707737](https://www.github.com/googleapis/python-bigquery-sqlalchemy/commit/1707737c60997e9714387c8077727eb5918626bb)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

chore: add generated templates (via synthtool)

51fc2bf

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

tswast commented Mar 23, 2021

View reviewed changes

tswast added 2 commits March 23, 2021 12:28

use templated noxfile

f367bfa

restore setup.cfg db section

08813db

shollyman approved these changes Mar 23, 2021

View reviewed changes

tswast changed the title ~~chore: add generated templates (via synthtool)~~ chore: add templates for move to googleapis/python-bigquery-sqlalchemy repo Mar 23, 2021

tswast changed the title ~~chore: add templates for move to googleapis/python-bigquery-sqlalchemy repo~~ docs: add templates for move to googleapis/python-bigquery-sqlalchemy repo Mar 23, 2021

tswast merged commit 37e584e into googleapis:master Mar 23, 2021

tswast deleted the issue85-noxfile branch March 23, 2021 20:49

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

docs: add templates for move to googleapis/python-bigquery-sqlalchemy repo #88

docs: add templates for move to googleapis/python-bigquery-sqlalchemy repo #88

tswast commented Mar 23, 2021

tswast Mar 23, 2021

tswast Mar 23, 2021

tswast commented Mar 23, 2021

shollyman left a comment

tswast commented Mar 23, 2021

docs: add templates for move to googleapis/python-bigquery-sqlalchemy repo #88

docs: add templates for move to googleapis/python-bigquery-sqlalchemy repo #88

Conversation

tswast commented Mar 23, 2021

tswast Mar 23, 2021

Choose a reason for hiding this comment

tswast Mar 23, 2021

Choose a reason for hiding this comment

tswast commented Mar 23, 2021

shollyman left a comment

Choose a reason for hiding this comment

tswast commented Mar 23, 2021