Skip to content

Commit 6d66767

Browse files
danoscarmikegguusswaprinmerla18dpebot
authored
docs: add samples from video/cloud-client/shotchange (#72)
* Adds tutorials using Cloud Client [(#930)](#930) * Adds tutorials. * Removes unused enumerate * Adds one more tutorial as well as fixes some copy/paste typos. [(#933)](#933) * Adds new examples, replaces markdown with restructured text [(#945)](#945) * Adds new examples, replaces markdown with restructured text * Address review feedback * Use videos from pubilc bucket, update to new client library. * Style nit * Updates requirements [(#952)](#952) * Fix README rst links [(#962)](#962) * Fix README rst links * Update all READMEs * change the usage file sample [(#958)](#958) since the file does not exist. Propose to use the same one as the tutorial: demomaker/gbikes_dinosaur.mp4 * Updates examples for video [(#968)](#968) * Auto-update dependencies. [(#1093)](#1093) * Auto-update dependencies. * Fix storage notification poll sample Change-Id: I6afbc79d15e050531555e4c8e51066996717a0f3 * Fix spanner samples Change-Id: I40069222c60d57e8f3d3878167591af9130895cb * Drop coverage because it's not useful Change-Id: Iae399a7083d7866c3c7b9162d0de244fbff8b522 * Try again to fix flaky logging test Change-Id: I6225c074701970c17c426677ef1935bb6d7e36b4 * Update all generated readme auth instructions [(#1121)](#1121) Change-Id: I03b5eaef8b17ac3dc3c0339fd2c7447bd3e11bd2 * Auto-update dependencies. [(#1123)](#1123) * Video v1beta2 [(#1088)](#1088) * update analyze_safe_search * update analyze_shots * update explicit_content_detection and test * update fece detection * update label detection (path) * update label detection (file) * flake * safe search --> explicit content * update faces tutorial * update client library quickstart * update shotchange tutorial * update labels tutorial * correct spelling * correction start_time_offset * import order * rebased * Added Link to Python Setup Guide [(#1158)](#1158) * Update Readme.rst to add Python setup guide As requested in b/64770713. This sample is linked in documentation https://cloud.google.com/bigtable/docs/scaling, and it would make more sense to update the guide here than in the documentation. * Update README.rst * Update README.rst * Update README.rst * Update README.rst * Update README.rst * Update install_deps.tmpl.rst * Updated readmegen scripts and re-generated related README files * Fixed the lint error * Tweak doc/help strings for sample tools [(#1160)](#1160) * Corrected copy-paste on doc string * Updated doc/help string to be more specific to labels tool * Made shotchange doc/help string more specific * Tweaked doc/help string to indicate no arg expected * Adjusted import order to satisfy flake8 * Wrapped doc string to 79 chars to flake8 correctly * Adjusted import order to pass flake8 test * Auto-update dependencies. [(#1186)](#1186) * update samples to v1 [(#1221)](#1221) * update samples to v1 * replace while loop with operation.result(timeout) * addressing review comments * flake * flake * Added "Open in Cloud Shell" buttons to README files [(#1254)](#1254) * Auto-update dependencies. [(#1377)](#1377) * Auto-update dependencies. * Update requirements.txt * Auto-update dependencies. * Regenerate the README files and fix the Open in Cloud Shell link for some samples [(#1441)](#1441) * Update READMEs to fix numbering and add git clone [(#1464)](#1464) * Video Intelligence region tag update [(#1639)](#1639) * Auto-update dependencies. [(#1658)](#1658) * Auto-update dependencies. * Rollback appengine/standard/bigquery/. * Rollback appengine/standard/iap/. * Rollback bigtable/metricscaler. * Rolledback appengine/flexible/datastore. * Rollback dataproc/ * Rollback jobs/api_client * Rollback vision/cloud-client. * Rollback functions/ocr/app. * Rollback iot/api-client/end_to_end_example. * Rollback storage/cloud-client. * Rollback kms/api-client. * Rollback dlp/ * Rollback bigquery/cloud-client. * Rollback iot/api-client/manager. * Rollback appengine/flexible/cloudsql_postgresql. * Use explicit URIs for Video Intelligence sample tests [(#1743)](#1743) * Auto-update dependencies. [(#1846)](#1846) ACK, merging. * Longer timeouts to address intermittent failures [(#1871)](#1871) * Auto-update dependencies. [(#1980)](#1980) * Auto-update dependencies. * Update requirements.txt * Update requirements.txt * replace demomaker with cloud-samples-data/video for video intelligenc… [(#2162)](#2162) * replace demomaker with cloud-samples-data/video for video intelligence samples * flake * Adds updates for samples profiler ... vision [(#2439)](#2439) * Auto-update dependencies. [(#2005)](#2005) * Auto-update dependencies. * Revert update of appengine/flexible/datastore. * revert update of appengine/flexible/scipy * revert update of bigquery/bqml * revert update of bigquery/cloud-client * revert update of bigquery/datalab-migration * revert update of bigtable/quickstart * revert update of compute/api * revert update of container_registry/container_analysis * revert update of dataflow/run_template * revert update of datastore/cloud-ndb * revert update of dialogflow/cloud-client * revert update of dlp * revert update of functions/imagemagick * revert update of functions/ocr/app * revert update of healthcare/api-client/fhir * revert update of iam/api-client * revert update of iot/api-client/gcs_file_to_device * revert update of iot/api-client/mqtt_example * revert update of language/automl * revert update of run/image-processing * revert update of vision/automl * revert update testing/requirements.txt * revert update of vision/cloud-client/detect * revert update of vision/cloud-client/product_search * revert update of jobs/v2/api_client * revert update of jobs/v3/api_client * revert update of opencensus * revert update of translate/cloud-client * revert update to speech/cloud-client Co-authored-by: Kurtis Van Gent <[email protected]> Co-authored-by: Doug Mahugh <[email protected]> * chore(deps): update dependency google-cloud-videointelligence to v1.14.0 [(#3169)](#3169) * Simplify noxfile setup. [(#2806)](#2806) * chore(deps): update dependency requests to v2.23.0 * Simplify noxfile and add version control. * Configure appengine/standard to only test Python 2.7. * Update Kokokro configs to match noxfile. * Add requirements-test to each folder. * Remove Py2 versions from everything execept appengine/standard. * Remove conftest.py. * Remove appengine/standard/conftest.py * Remove 'no-sucess-flaky-report' from pytest.ini. * Add GAE SDK back to appengine/standard tests. * Fix typo. * Roll pytest to python 2 version. * Add a bunch of testing requirements. * Remove typo. * Add appengine lib directory back in. * Add some additional requirements. * Fix issue with flake8 args. * Even more requirements. * Readd appengine conftest.py. * Add a few more requirements. * Even more Appengine requirements. * Add webtest for appengine/standard/mailgun. * Add some additional requirements. * Add workaround for issue with mailjet-rest. * Add responses for appengine/standard/mailjet. Co-authored-by: Renovate Bot <[email protected]> * fix: changes positional to named pararameters in Video samples [(#4017)](#4017) Changes calls to `VideoClient.annotate_video()` so that GCS URIs are provided as named parameters. Example: ``` operation = video_client.annotate_video(path, features=features) ``` Becomes: ``` operation = video_client.annotate_video(input_uri=path, features=features) ``` * Update dependency google-cloud-videointelligence to v1.15.0 [(#4041)](#4041) This PR contains the following updates: | Package | Update | Change | |---|---|---| | [google-cloud-videointelligence](https://togithub.com/googleapis/python-videointelligence) | minor | `==1.14.0` -> `==1.15.0` | --- ### Release Notes <details> <summary>googleapis/python-videointelligence</summary> ### [`v1.15.0`](https://togithub.com/googleapis/python-videointelligence/blob/master/CHANGELOG.md#&#8203;1150-httpswwwgithubcomgoogleapispython-videointelligencecomparev1140v1150-2020-06-09) [Compare Source](https://togithub.com/googleapis/python-videointelligence/compare/v1.14.0...v1.15.0) ##### Features - add support for streaming automl action recognition in v1p3beta1; make 'features' a positional param for annotate_video in betas ([#&#8203;31](https://www.github.com/googleapis/python-videointelligence/issues/31)) ([586f920](https://www.github.com/googleapis/python-videointelligence/commit/586f920a1932e1a813adfed500502fba0ff5edb7)), closes [#&#8203;517](https://www.github.com/googleapis/python-videointelligence/issues/517) [#&#8203;538](https://www.github.com/googleapis/python-videointelligence/issues/538) [#&#8203;565](https://www.github.com/googleapis/python-videointelligence/issues/565) [#&#8203;576](https://www.github.com/googleapis/python-videointelligence/issues/576) [#&#8203;506](https://www.github.com/googleapis/python-videointelligence/issues/506) [#&#8203;586](https://www.github.com/googleapis/python-videointelligence/issues/586) [#&#8203;585](https://www.github.com/googleapis/python-videointelligence/issues/585) </details> --- ### Renovate configuration :date: **Schedule**: At any time (no schedule defined). :vertical_traffic_light: **Automerge**: Disabled by config. Please merge this manually once you are satisfied. :recycle: **Rebasing**: Never, or you tick the rebase/retry checkbox. :no_bell: **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [WhiteSource Renovate](https://renovate.whitesourcesoftware.com). View repository job log [here](https://app.renovatebot.com/dashboard#GoogleCloudPlatform/python-docs-samples). * chore(deps): update dependency pytest to v5.4.3 [(#4279)](#4279) * chore(deps): update dependency pytest to v5.4.3 * specify pytest for python 2 in appengine Co-authored-by: Leah Cole <[email protected]> * Update dependency pytest to v6 [(#4390)](#4390) * chore: pin sphinx * chore: adds samples templates * chore: temporarily pins sphinx * chore: blacken noxfile * chore: lints * chore(deps): update dependency google-cloud-videointelligence to v1.16.0 [(#4798)](#4798) * chore: fixes flaky tests * chore(deps): update dependency pytest to v6.1.1 [(#4761)](#4761) * chore(deps): update dependency pytest to v6.1.2 [(#4921)](#4921) Co-authored-by: Charles Engelke <[email protected]> * chore: updates samples templates * chore: cleans up merge conflicts * chore: blacken Co-authored-by: Gus Class <[email protected]> Co-authored-by: Bill Prin <[email protected]> Co-authored-by: florencep <[email protected]> Co-authored-by: DPE bot <[email protected]> Co-authored-by: Jon Wayne Parrott <[email protected]> Co-authored-by: Yu-Han Liu <[email protected]> Co-authored-by: michaelawyu <[email protected]> Co-authored-by: Perry Stoll <[email protected]> Co-authored-by: Frank Natividad <[email protected]> Co-authored-by: michaelawyu <[email protected]> Co-authored-by: Alix Hamilton <[email protected]> Co-authored-by: Charles Engelke <[email protected]> Co-authored-by: Yu-Han Liu <[email protected]> Co-authored-by: Kurtis Van Gent <[email protected]> Co-authored-by: Doug Mahugh <[email protected]> Co-authored-by: WhiteSource Renovate <[email protected]> Co-authored-by: Eric Schmidt <[email protected]> Co-authored-by: Leah Cole <[email protected]> Co-authored-by: gcf-merge-on-green[bot] <60162190+gcf-merge-on-green[bot]@users.noreply.github.com> Co-authored-by: Charles Engelke <[email protected]>
1 parent 3b6c49c commit 6d66767

File tree

9 files changed

+524
-39
lines changed

9 files changed

+524
-39
lines changed

videointelligence/samples/analyze/README.rst

Lines changed: 5 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
.. This file is automatically generated. Do not edit this file directly.
32
43
Google Cloud Video Intelligence API Python Samples
@@ -16,11 +15,13 @@ This directory contains samples for Google Cloud Video Intelligence API. `Google
1615
.. _Google Cloud Video Intelligence API: https://cloud.google.com/video-intelligence/docs
1716

1817

18+
19+
20+
1921
Setup
2022
-------------------------------------------------------------------------------
2123

2224

23-
2425
Authentication
2526
++++++++++++++
2627

@@ -31,9 +32,6 @@ credentials for applications.
3132
.. _Authentication Getting Started Guide:
3233
https://cloud.google.com/docs/authentication/getting-started
3334

34-
35-
36-
3735
Install Dependencies
3836
++++++++++++++++++++
3937

@@ -48,7 +46,7 @@ Install Dependencies
4846
.. _Python Development Environment Setup Guide:
4947
https://cloud.google.com/python/setup
5048

51-
#. Create a virtualenv. Samples are compatible with Python 3.6+.
49+
#. Create a virtualenv. Samples are compatible with Python 2.7 and 3.4+.
5250

5351
.. code-block:: bash
5452
@@ -64,15 +62,9 @@ Install Dependencies
6462
.. _pip: https://pip.pypa.io/
6563
.. _virtualenv: https://virtualenv.pypa.io/
6664

67-
68-
69-
70-
71-
7265
Samples
7366
-------------------------------------------------------------------------------
7467

75-
7668
analyze
7769
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
7870

@@ -88,7 +80,6 @@ To run this sample:
8880
8981
$ python analyze.py
9082
91-
9283
usage: analyze.py [-h]
9384
{labels,labels_file,explicit_content,shots,transcribe,text_gcs,text_file,objects_gcs,objects_file}
9485
...
@@ -124,8 +115,6 @@ To run this sample:
124115
125116
126117
127-
128-
129118
beta samples
130119
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
131120

@@ -141,7 +130,6 @@ To run this sample:
141130
142131
$ python beta_snippets.py
143132
144-
145133
usage: beta_snippets.py [-h]
146134
{transcription,video-text-gcs,video-text,track-objects-gcs,track-objects,streaming-labels,streaming-shot-change,streaming-objects,streaming-explicit-content,streaming-annotation-storage,streaming-automl-classification}
147135
...
@@ -189,10 +177,6 @@ To run this sample:
189177
190178
191179
192-
193-
194-
195-
196180
The client library
197181
-------------------------------------------------------------------------------
198182

@@ -208,5 +192,4 @@ to `browse the source`_ and `report issues`_.
208192
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
209193

210194

211-
212-
.. _Google Cloud SDK: https://cloud.google.com/sdk/
195+
.. _Google Cloud SDK: https://cloud.google.com/sdk/

videointelligence/samples/quickstart/noxfile.py

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -37,25 +37,28 @@
3737

3838
TEST_CONFIG = {
3939
# You can opt out from the test for specific Python versions.
40-
"ignored_versions": ["2.7"],
40+
'ignored_versions': ["2.7"],
41+
4142
# Old samples are opted out of enforcing Python type hints
4243
# All new samples should feature them
43-
"enforce_type_hints": False,
44+
'enforce_type_hints': False,
45+
4446
# An envvar key for determining the project id to use. Change it
4547
# to 'BUILD_SPECIFIC_GCLOUD_PROJECT' if you want to opt in using a
4648
# build specific Cloud project. You can also use your own string
4749
# to use your own Cloud project.
48-
"gcloud_project_env": "GOOGLE_CLOUD_PROJECT",
50+
'gcloud_project_env': 'GOOGLE_CLOUD_PROJECT',
4951
# 'gcloud_project_env': 'BUILD_SPECIFIC_GCLOUD_PROJECT',
52+
5053
# A dictionary you want to inject into your test. Don't put any
5154
# secrets here. These values will override predefined values.
52-
"envs": {},
55+
'envs': {},
5356
}
5457

5558

5659
try:
5760
# Ensure we can import noxfile_config in the project's directory.
58-
sys.path.append(".")
61+
sys.path.append('.')
5962
from noxfile_config import TEST_CONFIG_OVERRIDE
6063
except ImportError as e:
6164
print("No user noxfile_config found: detail: {}".format(e))
@@ -70,12 +73,12 @@ def get_pytest_env_vars():
7073
ret = {}
7174

7275
# Override the GCLOUD_PROJECT and the alias.
73-
env_key = TEST_CONFIG["gcloud_project_env"]
76+
env_key = TEST_CONFIG['gcloud_project_env']
7477
# This should error out if not set.
75-
ret["GOOGLE_CLOUD_PROJECT"] = os.environ[env_key]
78+
ret['GOOGLE_CLOUD_PROJECT'] = os.environ[env_key]
7679

7780
# Apply user supplied envs.
78-
ret.update(TEST_CONFIG["envs"])
81+
ret.update(TEST_CONFIG['envs'])
7982
return ret
8083

8184

@@ -84,7 +87,7 @@ def get_pytest_env_vars():
8487
ALL_VERSIONS = ["2.7", "3.6", "3.7", "3.8"]
8588

8689
# Any default versions that should be ignored.
87-
IGNORED_VERSIONS = TEST_CONFIG["ignored_versions"]
90+
IGNORED_VERSIONS = TEST_CONFIG['ignored_versions']
8891

8992
TESTED_VERSIONS = sorted([v for v in ALL_VERSIONS if v not in IGNORED_VERSIONS])
9093

@@ -133,7 +136,7 @@ def _determine_local_import_names(start_dir):
133136

134137
@nox.session
135138
def lint(session):
136-
if not TEST_CONFIG["enforce_type_hints"]:
139+
if not TEST_CONFIG['enforce_type_hints']:
137140
session.install("flake8", "flake8-import-order")
138141
else:
139142
session.install("flake8", "flake8-import-order", "flake8-annotations")
@@ -142,11 +145,9 @@ def lint(session):
142145
args = FLAKE8_COMMON_ARGS + [
143146
"--application-import-names",
144147
",".join(local_names),
145-
".",
148+
"."
146149
]
147150
session.run("flake8", *args)
148-
149-
150151
#
151152
# Black
152153
#
@@ -159,7 +160,6 @@ def blacken(session):
159160

160161
session.run("black", *python_files)
161162

162-
163163
#
164164
# Sample Tests
165165
#
@@ -199,9 +199,9 @@ def py(session):
199199
if session.python in TESTED_VERSIONS:
200200
_session_tests(session)
201201
else:
202-
session.skip(
203-
"SKIPPED: {} tests are disabled for this sample.".format(session.python)
204-
)
202+
session.skip("SKIPPED: {} tests are disabled for this sample.".format(
203+
session.python
204+
))
205205

206206

207207
#
Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
2+
.. This file is automatically generated. Do not edit this file directly.
3+
4+
Google Cloud Video Intelligence API Python Samples
5+
===============================================================================
6+
7+
.. image:: https://gstatic.com/cloudssh/images/open-btn.png
8+
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=video/cloud-client/shotchange/README.rst
9+
10+
11+
This directory contains samples for Google Cloud Video Intelligence API. `Google Cloud Video Intelligence API`_ allows developers to easily integrate feature detection in video.
12+
13+
14+
15+
16+
.. _Google Cloud Video Intelligence API: https://cloud.google.com/video-intelligence/docs
17+
18+
19+
Setup
20+
-------------------------------------------------------------------------------
21+
22+
23+
24+
Authentication
25+
++++++++++++++
26+
27+
This sample requires you to have authentication setup. Refer to the
28+
`Authentication Getting Started Guide`_ for instructions on setting up
29+
credentials for applications.
30+
31+
.. _Authentication Getting Started Guide:
32+
https://cloud.google.com/docs/authentication/getting-started
33+
34+
35+
36+
37+
Install Dependencies
38+
++++++++++++++++++++
39+
40+
#. Clone python-docs-samples and change directory to the sample directory you want to use.
41+
42+
.. code-block:: bash
43+
44+
$ git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
45+
46+
#. Install `pip`_ and `virtualenv`_ if you do not already have them. You may want to refer to the `Python Development Environment Setup Guide`_ for Google Cloud Platform for instructions.
47+
48+
.. _Python Development Environment Setup Guide:
49+
https://cloud.google.com/python/setup
50+
51+
#. Create a virtualenv. Samples are compatible with Python 3.6+.
52+
53+
.. code-block:: bash
54+
55+
$ virtualenv env
56+
$ source env/bin/activate
57+
58+
#. Install the dependencies needed to run the samples.
59+
60+
.. code-block:: bash
61+
62+
$ pip install -r requirements.txt
63+
64+
.. _pip: https://pip.pypa.io/
65+
.. _virtualenv: https://virtualenv.pypa.io/
66+
67+
68+
69+
70+
71+
72+
Samples
73+
-------------------------------------------------------------------------------
74+
75+
76+
Shot Change Detection
77+
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
78+
79+
.. image:: https://gstatic.com/cloudssh/images/open-btn.png
80+
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=video/cloud-client/shotchange/shotchange.py,video/cloud-client/shotchange/README.rst
81+
82+
83+
84+
85+
To run this sample:
86+
87+
.. code-block:: bash
88+
89+
$ python shotchange.py
90+
91+
92+
usage: shotchange.py [-h] path
93+
94+
This application demonstrates how to identify all different shots
95+
in a video using the Google Cloud Video Intelligence API.
96+
97+
For more information, check out the documentation at
98+
https://cloud.google.com/videointelligence/docs.
99+
100+
Example Usage:
101+
102+
python shotchange.py gs://cloud-samples-data/video/gbikes_dinosaur.mp4
103+
104+
positional arguments:
105+
path GCS path for shot change detection.
106+
107+
optional arguments:
108+
-h, --help show this help message and exit
109+
110+
111+
112+
113+
114+
115+
116+
117+
118+
The client library
119+
-------------------------------------------------------------------------------
120+
121+
This sample uses the `Google Cloud Client Library for Python`_.
122+
You can read the documentation for more details on API usage and use GitHub
123+
to `browse the source`_ and `report issues`_.
124+
125+
.. _Google Cloud Client Library for Python:
126+
https://googlecloudplatform.github.io/google-cloud-python/
127+
.. _browse the source:
128+
https://github.com/GoogleCloudPlatform/google-cloud-python
129+
.. _report issues:
130+
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
131+
132+
133+
134+
.. _Google Cloud SDK: https://cloud.google.com/sdk/
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# This file is used to generate README.rst
2+
3+
product:
4+
name: Google Cloud Video Intelligence API
5+
short_name: Cloud Video Intelligence API
6+
url: https://cloud.google.com/video-intelligence/docs
7+
description: >
8+
`Google Cloud Video Intelligence API`_ allows developers to easily
9+
integrate feature detection in video.
10+
11+
setup:
12+
- auth
13+
- install_deps
14+
15+
samples:
16+
- name: Shot Change Detection
17+
file: shotchange.py
18+
show_help: True
19+
20+
cloud_client_library: true
21+
22+
folder: video/cloud-client/shotchange

0 commit comments

Comments
 (0)