Generate readmes for most service samples by theacodes · Pull Request #599 · GoogleCloudPlatform/python-docs-samples

theacodes · 2016-10-20T20:43:09Z

No description provided.

Change-Id: I7074b9c13ffe2d3ad687fa51b6d847f946c24c80

jerjou

It seems like github is making a bunch of the urls relative urls for some reason?

jerjou · 2016-10-20T20:45:08Z

-* https://cloud.google.com/bigquery/docs/managing_jobs_datasets_projects
-* https://cloud.google.com/bigquery/streaming-data-into-bigquery
-* https://cloud.google.com/bigquery/docs/data
-* https://cloud.google.com/bigquery/querying-data


Do we not want the links back to the docs anymore?

I'm gonna revisit this one Jason has his docs tracker working.

jerjou · 2016-10-20T20:53:49Z

+Google BigQuery Python Samples
+===============================================================================
+
+This directory contains samples for Google BigQuery. `BigQuery`_ is Google's fully managed, petabyte scale, low cost analytics data warehouse. BigQuery is NoOps—there is no infrastructure to manage and you don't need a database administrator—so you can focus on analyzing data to find meaningful insights, use familiar SQL, and take advantage of our pay-as-you-go model.


The rendered 'BigQuery_' in the second sentence here seems to appear as a link that goes nowhere (and the trailing underscore still appears) (ditto below)

jerjou · 2016-10-20T20:54:29Z

+
+#. When running on App Engine or Compute Engine, credentials are already
+   set-up. However, you may need to configure your Compute Engine instance
+   with `additional scopes <gce-auth>`_.


This link 404s

jerjou · 2016-10-20T20:56:28Z

+  show_help: true
+- name: User auth with an installed app
+  file: installed_app.py
+  show_help: true


Oh neat - does the script automatically run the script with no arguments, and include the output? That's super cool.

nit: Perhaps include the -h flag explicitly, to make clear that it's printing the help?

Without or without the -h flag, it'll show the help. :)

Hrm... I'm not seeing that:

$ python sync_query.py usage: sync_query.py [-h] query sync_query.py: error: too few arguments $ python sync_query.py -h usage: sync_query.py [-h] query Command-line application to perform synchronous queries in BigQuery. For more information, see the README.md under /bigquery. Example invocation: $ python sync_query.py 'SELECT corpus FROM `publicdata.samples.shakespeare` GROUP BY corpus' positional arguments: query BigQuery SQL Query. optional arguments: -h, --help show this help message and exit

jerjou · 2016-10-20T20:57:57Z

+
+.. code-block:: bash
+
+    $ python quickstart.py


Hm... is it worth it to include this, if it doesn't include 'help' text?

jerjou · 2016-10-20T20:58:11Z

+    For more information, see the README.md under /bigquery.
+
+    Example invocation:
+        $ python sync_query.py           'SELECT corpus FROM `publicdata.samples.shakespeare` GROUP BY corpus'


Weird random spaces here..

Not sure why, but it's not the samplegen's fault.

Should probably fix it before checking in the README that shows it, though.

I suspect it's because argparse is using the module's docstring for its help text, which includes a newline escape to fit under 80 characters (and a subsequent indent). If you escape the escape (ie \\) that should fix both the help text displayed when invoking the command, and the random spaces here.

jerjou · 2016-10-20T20:58:48Z

+The client library
+-------------------------------------------------------------------------------
+
+This sample uses the `Google Cloud Client Library for Python <ccl-docs>`_.


This link 404s

Change-Id: Ia1f5b06b85106adced1aadff8d056e4f57da6faa

Change-Id: Ia4225e3a4fd45d01e70856c5276fddb7345bcb76

Change-Id: I4a7ba7644f402c59567a00c9457556e6ec7cb0f2

theacodes · 2016-10-25T18:22:29Z

Done

On Thu, Oct 20, 2016 at 2:22 PM Jerjou [email protected] wrote:

@jerjou commented on this pull request.

In bigquery/api/README.rst.in
#599:

show_help: true
+- name: Load data by POST

file: load_data_by_post.py

show_help: true
+- name: Load data from CSV

file: load_data_from_csv.py

show_help: true
+- name: Load streaming data

file: streaming.py

show_help: true
+- name: Export data to Cloud Storage

file: export_data_to_cloud_storage.py

show_help: true
+- name: User auth with an installed app

file: installed_app.py

show_help: true

Hrm... I'm not seeing that:

$ python sync_query.py
usage: sync_query.py [-h] query
sync_query.py: error: too few arguments

$ python sync_query.py -h
usage: sync_query.py [-h] query

Command-line application to perform synchronous queries in BigQuery.

For more information, see the README.md under /bigquery.

Example invocation:
$ python sync_query.py 'SELECT corpus FROM publicdata.samples.shakespeare GROUP BY corpus'

positional arguments:
query BigQuery SQL Query.

optional arguments:
-h, --help show this help message and exit

In bigquery/cloud-client/README.rst
#599:
+To run this sample:
+
+.. code-block:: bash
+

$ python sync_query.py

usage: sync_query.py [-h] query

Command-line application to perform synchronous queries in BigQuery.

For more information, see the README.md under /bigquery.
Example invocation:
   $ python sync_query.py           'SELECT corpus FROM `publicdata.samples.shakespeare` GROUP BY corpus'
Should probably fix it before checking in the README that shows it, though.

I suspect it's because argparse is using the module's docstring for its
help text, which includes a newline escape to fit under 80 characters (and
a subsequent indent). If you escape the escape (ie ) that should fix
both the help text displayed when invoking the command, and the random
spaces here.

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#599, or mute
the thread
https://github.com/notifications/unsubscribe-auth/AAPUc-Zzla9mAGVMJ9TY0O-pOzrKffN4ks5q19t4gaJpZM4KclUn
.

…oudPlatform/python-docs-samples#599)

Generate readmes for most service samples

148389f

Change-Id: I7074b9c13ffe2d3ad687fa51b6d847f946c24c80

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Oct 20, 2016

jerjou reviewed Oct 20, 2016

View reviewed changes

Jon Wayne Parrott added 3 commits October 20, 2016 14:13

Address review comments

e396578

Change-Id: Ia1f5b06b85106adced1aadff8d056e4f57da6faa

Address review comments

3203e69

Change-Id: Ia4225e3a4fd45d01e70856c5276fddb7345bcb76

Address review comments

d074fec

Change-Id: I4a7ba7644f402c59567a00c9457556e6ec7cb0f2

theacodes merged commit a38e13a into master Oct 24, 2016

theacodes deleted the gen-service-readmes branch October 24, 2016 18:03

busunkim96 pushed a commit to busunkim96/python-pubsub that referenced this pull request May 20, 2020

Generate readmes for most service samples [(googleapis#599)](GoogleCl…

26903ff

…oudPlatform/python-docs-samples#599)

busunkim96 pushed a commit to busunkim96/python-bigtable that referenced this pull request May 28, 2020

Generate readmes for most service samples [(googleapis#599)](GoogleCl…

f945fc5

…oudPlatform/python-docs-samples#599)

busunkim96 pushed a commit to busunkim96/python-bigtable that referenced this pull request May 28, 2020

Generate readmes for most service samples [(googleapis#599)](GoogleCl…

f6ebc97

…oudPlatform/python-docs-samples#599)

kolea2 pushed a commit to googleapis/python-bigtable that referenced this pull request Jun 4, 2020

docs: add samples from bigtable (#38

Conversation

theacodes commented Oct 20, 2016

Uh oh!

jerjou left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

theacodes commented Oct 25, 2016

Uh oh!