docs: add samples #23

busunkim96 · 2020-04-09T19:05:42Z

Pulls samples in from python-docs-samples along with the noxfile.

googlebot · 2020-04-09T19:05:59Z

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

samples/noxfile.py

busunkim96 · 2020-04-09T19:55:40Z

noxfile.py

@@ -139,7 +140,7 @@ def docs(session):
    """Build the docs for this library."""

    session.install("-e", ".")
-    session.install("sphinx", "alabaster", "recommonmark")
+    session.install("sphinx<3.0", "alabaster", "recommonmark")


This change has landed in synthtool but the library hasn't been updated

busunkim96 · 2020-04-09T19:59:23Z

.gitignore

@@ -28,7 +28,7 @@ pip-log.txt
 .nox
 .cache
 .pytest_cache
-
+sponge_log.xml


For the sponge_log.xml generated by the sample tests

kurtisvg

One thing to consider is moving the samples into a project under the samples folder. This way, there can by multiple sample projects that are still different.

For example, you may want something like:

samples/snippets
samples/quickstart
samples/sample_app

Also, we may at some point wish to figure out how (and when) we want to test the content of the samples at HEAD for the client libraries - maybe a different session (or set of sessions)?

kurtisvg · 2020-04-09T20:25:57Z

samples/noxfile.py

@@ -0,0 +1,154 @@
+# Copyright 2019 Google LLC


Should this be 2020?

🤔 This is a lightly edited version of noxfile-template.py from python-docs-samples. I'm not sure what the policy is around copyright years in this case

If you copy, keep the original date. If you want to add the new year, you'd better have multiple years.

samples/noxfile.py

busunkim96 · 2020-04-09T21:03:15Z

One thing to consider is moving the samples into a project under the samples folder. This way, there can by multiple sample projects that are still different.

For example, you may want something like:

samples/snippets

samples/quickstart

samples/sample_app

Ah interesting. I see each project has its own requirements.txt and requirements-test.txt in speech. Is there a good name for the sub-directory in this case?
https://github.com/GoogleCloudPlatform/python-docs-samples/tree/master/speech

I'll adjust the noxfile to parametrize the tests session if multiple sample project directories are found.

Also, we may at some point wish to figure out how (and when) we want to test the content of the samples at HEAD for the client libraries - maybe a different session (or set of sessions)?

I edited the noxfile to install the library from HEAD, but you make a good point that it would be preferable to check both (latest published release and HEAD).

leahecole

I added a handful of comments throughout but do have two meta concerns/comments

Doug just did a fantastic job rewriting the authoring guide. How should we best link to that from client libraries?
For every samples PR that is opened, we need to have a CL open to change all affected region tags in the docs

leahecole · 2020-04-09T21:04:10Z

samples/README.rst

@@ -0,0 +1,206 @@
+.. This file is automatically generated. Do not edit this file directly.


It seems like previously folks could edit the readme directly in the samples - how will that work with this being autogenerated?

We have this problem with all the template files (noxfile.py, kokoro files). If someone submits a PR with an edit I ask them to make the change to the template source in synthtool.

If a change does sneak in, it'll be reverted in the next Autosynth PR.

scripts/readme-gen/templates/README.tmpl.rst

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

kurtisvg · 2020-04-09T21:26:53Z

Ah interesting. I see each project has its own requirements.txt and requirements-test.txt in speech. Is there a good name for the sub-directory in this case?
https://github.com/GoogleCloudPlatform/python-docs-samples/tree/master/speech

My preference would be cloud-client becomes snippets and then maybe even breaking up that into smaller snippets if there are a lot relevant subcategories. microphone might make more sense as a subcategory if it's a bunch of snippets, or it might make more sense in it's own folder if it's part of a tutorial.

I'll adjust the noxfile to parametrize the tests session if multiple sample project directories are found.

So I have a slight preference to each project having it's own noxfile if possible. It makes it easier to copy and paste projects atomically, and avoid growing back into the monster shared noxfile we had before.

I edited the noxfile to install the library from HEAD, but you make a good point that it would be preferable to check both (latest published release and HEAD).

We also need to consider how this affects the docs. If we add a new feature (and update the samples) we need to make sure the samples on docs are frozen until the next release.

busunkim96 · 2020-04-09T21:29:12Z

I added a handful of comments throughout but do have two meta concerns/comments

Doug just did a fantastic job rewriting the authoring guide. How should we best link to that from client libraries?

How about I add a filesamples/SAMPLES_AUTHORING_GUIDE.md that links to to the python-docs-samples AUTHORING_GUIDE.md? Open to other ideas on how to make this most visible.

For every samples PR that is opened, we need to have a CL open to change all affected region tags in the docs

Do we need to configure something in google3 to make this happen?

…docs-samples#1421)

…some samples [(#1441)](GoogleCloudPlatform/python-docs-samples#1441)

…udPlatform/python-docs-samples#1464)

…s#1523)

…les#1545)

…rm/python-docs-samples#1538) * Added Audio Profile sample * Adjusted the row lengths * Adjusted the row length * Fixed Import orders * Fixed print statement * Debugging the unit test * Fixed the unit test * Some fixes per Noah's suggestions. * Renamed the function name in the test. * Multilined the long line. * Fixed the misspelling * Fixed the long line * Forcing the CicleCi to build again * Changing Inc to LLC * Updated library version. * Generated README.rst

…-samples#1586) * Printing the last paragraph only. * Python3 print * Removing sample rate setting * Adding the missing output parameter in the example * Changes based on the comments * Removed filenames as input parameters * Removed unused args * Updated README file * Updated the inline comment * Modified code to make it more readable * Simplified the response object processing. * Fixing the long line issue.

…es#1646)

…loudPlatform/python-docs-samples#1738) * Get display name of enums using IntEnum Requires updating google-cloud-language to 1.1.0 * Add note about gs://demomaker for video test files * Get display name of enums using IntEnum * Get display name of enums using IntEnum * Revert "Add note about gs://demomaker for video test files" This reverts commit 39d9bfff03201f7c6dcb38fee3856dd537ab4b62.

…amples#1980) * Auto-update dependencies. * Update requirements.txt * Update requirements.txt

…amples#2008)

…CloudPlatform/python-docs-samples#2378) * fix: refactored MP3 file tests * fix: moving resources to cloud-client/resources * fix: removing expected_example.mp3

…tform/python-docs-samples#2439)

…-samples#2687) * Add voice selection by name * Add future to requirements.txt Fixes python2 test failures referencing html. Co-authored-by: Leah E. Cole <[email protected]>

…0)](GoogleCloudPlatform/python-docs-samples#3210) Co-authored-by: gcf-merge-on-green[bot] <60162190+gcf-merge-on-green[bot]@users.noreply.github.com>

…ples#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]>

googlebot · 2020-05-19T20:59:05Z

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

googlebot · 2020-05-19T21:01:13Z

A Googler has manually verified that the CLAs look good.

(Googler, please make sure the reason for overriding the CLA status is clearly documented in these comments.)

ℹ️ Googlers: Go here for more info.

.kokoro/periodic/common.cfg

.kokoro/test-samples.sh

samples/snippets/noxfile.py

samples/snippets/noxfile_config.py

googlebot · 2020-05-19T22:07:42Z

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

googlebot · 2020-05-19T22:11:47Z

A Googler has manually verified that the CLAs look good.

(Googler, please make sure the reason for overriding the CLA status is clearly documented in these comments.)

ℹ️ Googlers: Go here for more info.

.kokoro/periodic/common.cfg

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

CODEOWNERS

tmatsuo · 2020-05-19T22:45:29Z

scripts/readme-gen/readme_gen.py

@@ -0,0 +1,66 @@
+#!/usr/bin/env python


Do we want to have copies of readme-gen everywhere? How do we maintain changes?

My pending synthtool PR adds readmegen into the synthtool. Eventually we can remove this separate script and only do sample README regens with the templates in synthtool.

scripts/readme-gen/templates/README.tmpl.rst

googlebot · 2020-05-19T23:19:21Z

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

googlebot · 2020-05-19T23:27:30Z

A Googler has manually verified that the CLAs look good.

(Googler, please make sure the reason for overriding the CLA status is clearly documented in these comments.)

ℹ️ Googlers: Go here for more info.

plamut

Stamping this based on other approvals.

googlebot added the cla: no This human has *not* signed the Contributor License Agreement. label Apr 9, 2020

busunkim96 added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Apr 9, 2020

yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Apr 9, 2020

busunkim96 commented Apr 9, 2020

View reviewed changes

busunkim96 requested review from leahecole and crwilcox April 9, 2020 20:17

busunkim96 marked this pull request as draft April 9, 2020 20:18

kurtisvg reviewed Apr 9, 2020

View reviewed changes

leahecole reviewed Apr 9, 2020

View reviewed changes

nnegrey and others added 17 commits May 13, 2020 03:02

Add text-to-speech beta samples [(#1421)](GoogleCloudPlatform/python-…

203501d

…docs-samples#1421)

Regenerate the README files and fix the Open in Cloud Shell link for …

1df57e2

…some samples [(#1441)](GoogleCloudPlatform/python-docs-samples#1441)

Update READMEs to fix numbering and add git clone [(#1464)](GoogleClo…

ff400e4

…udPlatform/python-docs-samples#1464)

Update library to GA [(#1523)](GoogleCloudPlatform/python-docs-sample…

b3cd81f

…s#1523)

Rollback Changes [(#1539)](GoogleCloudPlatform/python-docs-samples#1539)

e722062

Fixes link render typo [(#1545)](GoogleCloudPlatform/python-docs-samp…

6f4b4a9

…les#1545)

TTS region tag update [(#1646)](GoogleCloudPlatform/python-docs-sampl…

c186ece

…es#1646)

Auto-update dependencies. [(#1980)](GoogleCloudPlatform/python-docs-s…

2536a22

…amples#1980) * Auto-update dependencies. * Update requirements.txt * Update requirements.txt

Update beta samples to GA [(#2008)](GoogleCloudPlatform/python-docs-s…

18d0e10

…amples#2008)

fix: MP3 file test for Text-to-Speech SSML addresses [(#2378)](Google…

be27842

…CloudPlatform/python-docs-samples#2378) * fix: refactored MP3 file tests * fix: moving resources to cloud-client/resources * fix: removing expected_example.mp3

Adds updates for samples profiler ... vision [(#2439)](GoogleCloudPla…

bbcf6c4

…tform/python-docs-samples#2439)

Add voice selection by name [(#2687)](GoogleCloudPlatform/python-docs…

e84e022

…-samples#2687) * Add voice selection by name * Add future to requirements.txt Fixes python2 test failures referencing html. Co-authored-by: Leah E. Cole <[email protected]>

chore(deps): update dependency google-cloud-texttospeech to v1 [(#321…

330d50c

…0)](GoogleCloudPlatform/python-docs-samples#3210) Co-authored-by: gcf-merge-on-green[bot] <60162190+gcf-merge-on-green[bot]@users.noreply.github.com>

googlebot added cla: no This human has *not* signed the Contributor License Agreement. and removed cla: yes This human has signed the Contributor License Agreement. labels May 19, 2020

busunkim96 added cla: yes This human has signed the Contributor License Agreement. and removed cla: no This human has *not* signed the Contributor License Agreement. labels May 19, 2020

busunkim96 added the kokoro:run Add this label to force Kokoro to re-run the tests. label May 19, 2020

kurtisvg approved these changes May 19, 2020

View reviewed changes

.kokoro/periodic/common.cfg Show resolved Hide resolved

.kokoro/test-samples.sh Show resolved Hide resolved

samples/snippets/noxfile.py Show resolved Hide resolved

samples/snippets/noxfile_config.py Outdated Show resolved Hide resolved

build: use python samples docker image

6f1131c

googlebot added cla: no This human has *not* signed the Contributor License Agreement. and removed cla: yes This human has signed the Contributor License Agreement. labels May 19, 2020

chore: remove noxfile config

c5110b9

yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label May 19, 2020

tmatsuo reviewed May 19, 2020

View reviewed changes

fix: address PR comments

2b09fa7

googlebot added cla: no This human has *not* signed the Contributor License Agreement. and removed cla: yes This human has signed the Contributor License Agreement. labels May 19, 2020

busunkim96 added cla: yes This human has signed the Contributor License Agreement. and removed cla: no This human has *not* signed the Contributor License Agreement. labels May 19, 2020

tmatsuo approved these changes May 19, 2020

View reviewed changes

plamut approved these changes May 20, 2020

View reviewed changes

busunkim96 merged commit 65f903b into master May 20, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add samples #23

docs: add samples #23

busunkim96 commented Apr 9, 2020 •

edited

Loading

googlebot commented Apr 9, 2020

busunkim96 Apr 9, 2020

busunkim96 Apr 9, 2020

kurtisvg left a comment

kurtisvg Apr 9, 2020

busunkim96 Apr 9, 2020

tmatsuo May 19, 2020

busunkim96 commented Apr 9, 2020

leahecole left a comment

leahecole Apr 9, 2020

busunkim96 Apr 9, 2020

kurtisvg commented Apr 9, 2020 •

edited

Loading

busunkim96 commented Apr 9, 2020

googlebot commented May 19, 2020

googlebot commented May 19, 2020

googlebot commented May 19, 2020

googlebot commented May 19, 2020

tmatsuo May 19, 2020

busunkim96 May 19, 2020

googlebot commented May 19, 2020

googlebot commented May 19, 2020

plamut left a comment

		@@ -0,0 +1,206 @@
		.. This file is automatically generated. Do not edit this file directly.

docs: add samples #23

docs: add samples #23

Conversation

busunkim96 commented Apr 9, 2020 • edited Loading

googlebot commented Apr 9, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kurtisvg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

busunkim96 commented Apr 9, 2020

leahecole left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kurtisvg commented Apr 9, 2020 • edited Loading

busunkim96 commented Apr 9, 2020

googlebot commented May 19, 2020

googlebot commented May 19, 2020

googlebot commented May 19, 2020

googlebot commented May 19, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

googlebot commented May 19, 2020

googlebot commented May 19, 2020

plamut left a comment

Choose a reason for hiding this comment

busunkim96 commented Apr 9, 2020 •

edited

Loading

kurtisvg commented Apr 9, 2020 •

edited

Loading