diff --git a/docs/conf.py b/docs/conf.py index ad534385..620d2a06 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -113,7 +113,6 @@ "**/.nox/**/*", "samples/AUTHORING_GUIDE.md", "samples/CONTRIBUTING.md", - "samples/snippets/README.md", "samples/snippets/README.rst", ] diff --git a/noxfile.py b/noxfile.py index eeacb636..0b1c0f6c 100644 --- a/noxfile.py +++ b/noxfile.py @@ -30,7 +30,7 @@ DEFAULT_PYTHON_VERSION = "3.8" # We're using two Python versions to test with sqlalchemy 1.3 and 1.4. -SYSTEM_TEST_PYTHON_VERSIONS = ["3.8", "3.9", "3.10"] +SYSTEM_TEST_PYTHON_VERSIONS = ["3.8", "3.10"] UNIT_TEST_PYTHON_VERSIONS = ["3.6", "3.7", "3.8", "3.9", "3.10"] CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() @@ -100,7 +100,7 @@ def default(session): if session.python == "3.8": extras = "[tests,alembic]" - elif session.python in {"3.9", "3.10"}: + elif session.python == "3.10": extras = "[tests,geography]" else: extras = "[tests]" @@ -158,7 +158,7 @@ def system(session): session.install("mock", "pytest", "google-cloud-testutils", "-c", constraints_path) if session.python == "3.8": extras = "[tests,alembic]" - elif session.python == "3.9": + elif session.python == "3.10": extras = "[tests,geography]" else: extras = "[tests]" diff --git a/owlbot.py b/owlbot.py index ef519a92..c007d936 100644 --- a/owlbot.py +++ b/owlbot.py @@ -30,12 +30,11 @@ extras = ["tests"] extras_by_python = { "3.8": ["tests", "alembic"], - "3.9": ["tests", "geography"], "3.10": ["tests", "geography"], } templated_files = common.py_library( unit_test_python_versions=["3.6", "3.7", "3.8", "3.9", "3.10"], - system_test_python_versions=["3.8", "3.9", "3.10"], + system_test_python_versions=["3.8", "3.10"], cov_level=100, unit_test_extras=extras, unit_test_extras_by_python=extras_by_python, @@ -137,7 +136,7 @@ def compliance(session): ) if session.python == "3.8": extras = "[tests,alembic]" - elif session.python in {"3.9", "3.10"}: + elif session.python == "3.10": extras = "[tests,geography]" else: extras = "[tests]" diff --git a/samples/snippets/README.md b/samples/snippets/README.md deleted file mode 100644 index 0d2530cc..00000000 --- a/samples/snippets/README.md +++ /dev/null @@ -1,35 +0,0 @@ -## Info regarding requirements{,-test}.{in,txt} - -`requirements.in` is generated by running the following command in this -directory: - -```bash -(cd ../../ \ - && python setup.py egg_info 1>&2 && \ - cat sqlalchemy_bigquery.egg-info/requires.txt \ - | egrep -v -e '^\[' -e '^\s*$') | tee requirements.in -``` - -This results in a requirements.in file that contains all direct dependencies of -this project with correct version ranges. - -`requirements-test.in` is hand crtetafted. - -`requirements.in` and `requirements-test.in` are made for processing with -[pip-compile](https://github.com/jazzband/pip-tools). - -To generate `requirements{,-test}.txt` from `requirements{,-test}.in` run the -following commands in this directory: - -```bash -pipx run --spec pip-tools --python python3.6 \ - pip-compile --output-file=requirements.txt \ - requirements.in -pipx run --spec pip-tools --python python3.6 \ - pip-compile --output-file=requirements-test.txt \ - requirements-test.in -``` - -**IMPORTANT**: python 3.6 is used as this is the lowest version of python -supported and if a newer version of python is used instead the -`requirements{,-test}.txt` will not work for python 3.6. diff --git a/samples/snippets/README.rst b/samples/snippets/README.rst new file mode 100644 index 00000000..b98e34ff --- /dev/null +++ b/samples/snippets/README.rst @@ -0,0 +1,37 @@ +Info regarding ``requirements{,-test}.{in,txt}`` +================================================ + +``requirements.in`` is generated by running the following command in +this directory: + +.. code:: bash + + (cd ../../ \ + && python setup.py egg_info 1>&2 && \ + cat sqlalchemy_bigquery.egg-info/requires.txt \ + | egrep -v -e '^\[' -e '^\s*$') | tee requirements.in + +This results in a requirements.in file that contains all direct +dependencies of this project with correct version ranges. + +``requirements-test.in`` is hand crafted. + +``requirements.in`` and ``requirements-test.in`` are made for processing +with `pip-compile `__. + +To generate ``requirements{,-test}.txt`` from +``requirements{,-test}.in`` run the following commands in this +directory: + +.. code:: bash + + pipx run --spec pip-tools --python python3.6 \ + pip-compile --output-file=requirements.txt \ + requirements.in + pipx run --spec pip-tools --python python3.6 \ + pip-compile --output-file=requirements-test.txt \ + requirements-test.in + +.. important:: python 3.6 is used as this is the lowest version of + python supported and if a newer version of python is used instead the + ``requirements{,-test}.txt`` will not work for python 3.6.