Skip to content
This repository was archived by the owner on Sep 20, 2023. It is now read-only.

Commit 0613329

Browse files
gcf-owl-bot[bot]parthea
gcf-owl-bot[bot]
and
parthea
authored
fix: require python 3.7+ (#348)
* chore(python): drop python 3.6 Source-Link: googleapis/synthtool@4f89b13 Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:e7bb19d47c13839fe8c147e50e02e8b6cf5da8edd1af8b82208cd6f66cc2829c * require python 3.7+ in setup.py * remove python 3.6 sample configs * add api_description to .repo-metadata.json * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <partheniou@google.com>
1 parent 4c6d561 commit 0613329

File tree

16 files changed

+105
-135
lines changed

16 files changed

+105
-135
lines changed

‎.github/.OwlBot.lock.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@
1313
# limitations under the License.
1414
docker:
1515
image: gcr.io/cloud-devrel-public-resources/owlbot-python:latest
16-
digest: sha256:b2dc5f80edcf5d4486c39068c9fa11f7f851d9568eea4dcba130f994ea9b5e97
17-
# created: 2022-06-12T16:09:31.61859086Z
16+
digest: sha256:e7bb19d47c13839fe8c147e50e02e8b6cf5da8edd1af8b82208cd6f66cc2829c
17+
# created: 2022-07-05T18:31:20.838186805Z

‎.github/workflows/unittest.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ jobs:
88
runs-on: ubuntu-latest
99
strategy:
1010
matrix:
11-
python: ['3.6', '3.7', '3.8', '3.9', '3.10']
11+
python: ['3.7', '3.8', '3.9', '3.10']
1212
steps:
1313
- name: Checkout
1414
uses: actions/checkout@v3

‎.kokoro/samples/python3.6/common.cfg

Lines changed: 0 additions & 40 deletions
This file was deleted.

‎.kokoro/samples/python3.6/continuous.cfg

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎.kokoro/samples/python3.6/periodic-head.cfg

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎.kokoro/samples/python3.6/periodic.cfg

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎.kokoro/samples/python3.6/presubmit.cfg

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎.kokoro/test-samples-impl.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export PYTHONUNBUFFERED=1
3333
env | grep KOKORO
3434

3535
# Install nox
36-
python3.6 -m pip install --upgrade --quiet nox
36+
python3.9 -m pip install --upgrade --quiet nox
3737

3838
# Use secrets acessor service account to get secrets
3939
if [[ -f "${KOKORO_GFILE_DIR}/secrets_viewer_service_account.json" ]]; then
@@ -76,7 +76,7 @@ for file in samples/**/requirements.txt; do
7676
echo "------------------------------------------------------------"
7777

7878
# Use nox to execute the tests for the project.
79-
python3.6 -m nox -s "$RUN_TESTS_SESSION"
79+
python3.9 -m nox -s "$RUN_TESTS_SESSION"
8080
EXIT=$?
8181

8282
# If this is a periodic build, send the test log to the FlakyBot.

‎.repo-metadata.json

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "documentai",
3-
"name_pretty": "Cloud Document Understanding API",
4-
"product_documentation": "https://cloud.google.com/document-understanding/docs/",
3+
"name_pretty": "Document AI",
4+
"product_documentation": "https://cloud.google.com/document-ai/docs",
55
"client_documentation": "https://cloud.google.com/python/docs/reference/documentai/latest",
66
"issue_tracker": "",
77
"release_level": "stable",
@@ -13,5 +13,6 @@
1313
"requires_billing": true,
1414
"default_version": "v1",
1515
"codeowner_team": "@googleapis/cdpe-cloudai",
16-
"api_shortname": "documentai"
16+
"api_shortname": "documentai",
17+
"api_description": "Service to parse structured information from unstructured or semi-structured documents using state-of-the-art Google AI such as natural language, computer vision, translation, and AutoML."
1718
}

‎CONTRIBUTING.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ In order to add a feature:
2222
documentation.
2323

2424
- The feature must work fully on the following CPython versions:
25-
3.6, 3.7, 3.8, 3.9 and 3.10 on both UNIX and Windows.
25+
3.7, 3.8, 3.9 and 3.10 on both UNIX and Windows.
2626

2727
- The feature must not add unnecessary dependencies (where
2828
"unnecessary" is of course subjective, but new dependencies should
@@ -221,13 +221,11 @@ Supported Python Versions
221221

222222
We support:
223223

224-
- `Python 3.6`_
225224
- `Python 3.7`_
226225
- `Python 3.8`_
227226
- `Python 3.9`_
228227
- `Python 3.10`_
229228

230-
.. _Python 3.6: https://docs.python.org/3.6/
231229
.. _Python 3.7: https://docs.python.org/3.7/
232230
.. _Python 3.8: https://docs.python.org/3.8/
233231
.. _Python 3.9: https://docs.python.org/3.9/
@@ -239,7 +237,7 @@ Supported versions can be found in our ``noxfile.py`` `config`_.
239237
.. _config: https://github.com/googleapis/python-documentai/blob/main/noxfile.py
240238

241239

242-
We also explicitly decided to support Python 3 beginning with version 3.6.
240+
We also explicitly decided to support Python 3 beginning with version 3.7.
243241
Reasons for this include:
244242

245243
- Encouraging use of newest versions of Python 3

‎README.rst

Lines changed: 36 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,22 @@
1-
Python Client for Cloud Document AI API
2-
==================================================
1+
Python Client for Document AI API
2+
=================================
33

4-
|GA| |pypi| |versions|
4+
|stable| |pypi| |versions|
55

6-
`Cloud Document AI API`_: Service to parse structured information from unstructured or
7-
semi-structured documents using state-of-the-art Google AI such as natural
8-
language, computer vision, translation, and AutoML.
6+
`Document AI API`_: Service to parse structured information from unstructured or semi-structured documents using state-of-the-art Google AI such as natural language, computer vision, translation, and AutoML.
97

108
- `Client Library Documentation`_
119
- `Product Documentation`_
1210

13-
.. |GA| image:: https://img.shields.io/badge/support-ga-gold.svg
14-
:target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#general-availability
15-
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-service-directory.svg
11+
.. |stable| image:: https://img.shields.io/badge/support-stable-gold.svg
12+
:target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels
13+
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-documentai.svg
1614
:target: https://pypi.org/project/google-cloud-documentai/
1715
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-documentai.svg
1816
:target: https://pypi.org/project/google-cloud-documentai/
19-
.. _Cloud Document AI API: https://cloud.google.com/document-ai/docs/overview
17+
.. _Document AI API: https://cloud.google.com/document-ai/docs
2018
.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/documentai/latest
21-
.. _Product Documentation: https://cloud.google.com/document-ai/docs
19+
.. _Product Documentation: https://cloud.google.com/document-ai/docs
2220

2321
Quick Start
2422
-----------
@@ -27,12 +25,12 @@ In order to use this library, you first need to go through the following steps:
2725

2826
1. `Select or create a Cloud Platform project.`_
2927
2. `Enable billing for your project.`_
30-
3. `Enable the Cloud Document AI API.`_
28+
3. `Enable the Document AI API.`_
3129
4. `Setup Authentication.`_
3230

3331
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
3432
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
35-
.. _Enable the Cloud Document AI API.: https://cloud.google.com/document-ai/docs
33+
.. _Enable the Document AI API.: https://cloud.google.com/document-ai/docs
3634
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
3735

3836
Installation
@@ -49,6 +47,27 @@ dependencies.
4947
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
5048

5149

50+
Code samples and snippets
51+
~~~~~~~~~~~~~~~~~~~~~~~~~
52+
53+
Code samples and snippets live in the `samples/` folder.
54+
55+
56+
Supported Python Versions
57+
^^^^^^^^^^^^^^^^^^^^^^^^^
58+
Our client libraries are compatible with all current [active](https://devguide.python.org/devcycle/#in-development-main-branch) and [maintenance](https://devguide.python.org/devcycle/#maintenance-branches) versions of
59+
Python.
60+
61+
Python >= 3.7
62+
63+
Unsupported Python Versions
64+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
65+
Python <= 3.6
66+
67+
If you are using an [end-of-life](https://devguide.python.org/devcycle/#end-of-life-branches)
68+
version of Python, we recommend that you update as soon as possible to an actively supported version.
69+
70+
5271
Mac/Linux
5372
^^^^^^^^^
5473

@@ -73,12 +92,12 @@ Windows
7392
Next Steps
7493
~~~~~~~~~~
7594

76-
- Read the `Client Library Documentation`_ for Cloud Document AI API
77-
API to see other available methods on the client.
78-
- Read the `Cloud Document AI API Product documentation`_ to learn
95+
- Read the `Client Library Documentation`_ for Document AI API
96+
to see other available methods on the client.
97+
- Read the `Document AI API Product documentation`_ to learn
7998
more about the product and see How-to Guides.
8099
- View this `README`_ to see the full list of Cloud
81100
APIs that we cover.
82101

83-
.. _Cloud Document AI API Product documentation: https://cloud.google.com/document-ai/docs/overview
102+
.. _Document AI API Product documentation: https://cloud.google.com/document-ai/docs
84103
.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst

‎docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
.. include:: multiprocessing.rst
44

5-
This package includes clients for multiple versions of Cloud Document Understanding API.
5+
This package includes clients for multiple versions of Document AI.
66
By default, you will get version ``documentai_v1``.
77

88

‎noxfile.py

Lines changed: 54 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232

3333
DEFAULT_PYTHON_VERSION = "3.8"
3434

35-
UNIT_TEST_PYTHON_VERSIONS = ["3.6", "3.7", "3.8", "3.9", "3.10"]
35+
UNIT_TEST_PYTHON_VERSIONS = ["3.7", "3.8", "3.9", "3.10"]
3636
UNIT_TEST_STANDARD_DEPENDENCIES = [
3737
"mock",
3838
"asyncmock",
@@ -332,28 +332,15 @@ def docfx(session):
332332
def prerelease_deps(session):
333333
"""Run all tests with prerelease versions of dependencies installed."""
334334

335-
prerel_deps = [
336-
"protobuf",
337-
"googleapis-common-protos",
338-
"google-auth",
339-
"grpcio",
340-
"grpcio-status",
341-
"google-api-core",
342-
"proto-plus",
343-
# dependencies of google-auth
344-
"cryptography",
345-
"pyasn1",
346-
]
347-
348-
for dep in prerel_deps:
349-
session.install("--pre", "--no-deps", "--upgrade", dep)
350-
351-
# Remaining dependencies
352-
other_deps = ["requests"]
353-
session.install(*other_deps)
354-
335+
# Install all dependencies
336+
session.install("-e", ".[all, tests, tracing]")
355337
session.install(*UNIT_TEST_STANDARD_DEPENDENCIES)
356-
session.install(*SYSTEM_TEST_STANDARD_DEPENDENCIES)
338+
system_deps_all = (
339+
SYSTEM_TEST_STANDARD_DEPENDENCIES
340+
+ SYSTEM_TEST_EXTERNAL_DEPENDENCIES
341+
+ SYSTEM_TEST_EXTRAS
342+
)
343+
session.install(*system_deps_all)
357344

358345
# Because we test minimum dependency versions on the minimum Python
359346
# version, the first version we test with in the unit tests sessions has a
@@ -367,19 +354,44 @@ def prerelease_deps(session):
367354
constraints_text = constraints_file.read()
368355

369356
# Ignore leading whitespace and comment lines.
370-
deps = [
357+
constraints_deps = [
371358
match.group(1)
372359
for match in re.finditer(
373360
r"^\s*(\S+)(?===\S+)", constraints_text, flags=re.MULTILINE
374361
)
375362
]
376363

377-
# Don't overwrite prerelease packages.
378-
deps = [dep for dep in deps if dep not in prerel_deps]
379-
# We use --no-deps to ensure that pre-release versions aren't overwritten
380-
# by the version ranges in setup.py.
381-
session.install(*deps)
382-
session.install("--no-deps", "-e", ".[all]")
364+
session.install(*constraints_deps)
365+
366+
if os.path.exists("samples/snippets/requirements.txt"):
367+
session.install("-r", "samples/snippets/requirements.txt")
368+
369+
if os.path.exists("samples/snippets/requirements-test.txt"):
370+
session.install("-r", "samples/snippets/requirements-test.txt")
371+
372+
prerel_deps = [
373+
"protobuf",
374+
# dependency of grpc
375+
"six",
376+
"googleapis-common-protos",
377+
"grpcio",
378+
"grpcio-status",
379+
"google-api-core",
380+
"proto-plus",
381+
"google-cloud-testutils",
382+
# dependencies of google-cloud-testutils"
383+
"click",
384+
]
385+
386+
for dep in prerel_deps:
387+
session.install("--pre", "--no-deps", "--upgrade", dep)
388+
389+
# Remaining dependencies
390+
other_deps = [
391+
"requests",
392+
"google-auth",
393+
]
394+
session.install(*other_deps)
383395

384396
# Print out prerelease package versions
385397
session.run(
@@ -388,5 +400,16 @@ def prerelease_deps(session):
388400
session.run("python", "-c", "import grpc; print(grpc.__version__)")
389401

390402
session.run("py.test", "tests/unit")
391-
session.run("py.test", "tests/system")
392-
session.run("py.test", "samples/snippets")
403+
404+
system_test_path = os.path.join("tests", "system.py")
405+
system_test_folder_path = os.path.join("tests", "system")
406+
407+
# Only run system tests if found.
408+
if os.path.exists(system_test_path) or os.path.exists(system_test_folder_path):
409+
session.run("py.test", "tests/system")
410+
411+
snippets_test_path = os.path.join("samples", "snippets")
412+
413+
# Only run samples tests if found.
414+
if os.path.exists(snippets_test_path):
415+
session.run("py.test", "samples/snippets")

‎samples/snippets/noxfile.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ def get_pytest_env_vars() -> Dict[str, str]:
8888

8989
# DO NOT EDIT - automatically generated.
9090
# All versions used to test samples.
91-
ALL_VERSIONS = ["3.6", "3.7", "3.8", "3.9", "3.10"]
91+
ALL_VERSIONS = ["3.7", "3.8", "3.9", "3.10"]
9292

9393
# Any default versions that should be ignored.
9494
IGNORED_VERSIONS = TEST_CONFIG["ignored_versions"]

‎scripts/readme-gen/templates/install_deps.tmpl.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Install Dependencies
1212
.. _Python Development Environment Setup Guide:
1313
https://cloud.google.com/python/setup
1414

15-
#. Create a virtualenv. Samples are compatible with Python 3.6+.
15+
#. Create a virtualenv. Samples are compatible with Python 3.7+.
1616

1717
.. code-block:: bash
1818

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy