New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Pysamples new readme gen #112
Merged
gcf-merge-on-green
merged 9 commits into
googleapis:master
from
runargs:pysamples-new-README-gen
Aug 21, 2020
Merged
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
1bfa440
Sample docs generation
runargs adfdb93
docs: new README generation for pysamples
runargs 1437dfb
Link update, remove README.rst/.rst.in files
runargs 8e27266
Remove unnecessary logger import
runargs be25e16
Full -h text in README
runargs 7077a76
Delete Beam README.md
runargs 092aa8a
Add back usage
runargs 7229785
Merge branch 'pysamples-new-README-gen' of github.com:runargs/python-…
runargs a9ee215
Merge branch 'master' into pysamples-new-README-gen
runargs File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
[//]: # "This README.md file is auto-generated, all changes to this file will be lost." | ||
[//]: # "To regenerate it, use `python -m synthtool`." | ||
|
||
## Python Samples for Cloud Bigtable | ||
|
||
This directory contains samples for Cloud Bigtable, which may be used as a refererence for how to use Cloud Bigtable. | ||
|
||
## Additional Information | ||
|
||
You can read the documentation for more details on API usage and use GitHub | ||
to <a href="https://github.com/googleapis/python-bigtable">source</a> and [report issues][issues]. | ||
|
||
### Contributing | ||
For [contributing guidelines][contrib_guide], the [Python style guide][py_style], and more information on prerequisite steps to contribute, view the source code at <a href="https://github.com/googleapis/python-bigtable">googleapis/python-bigtable</a>. | ||
|
||
[authentication]: https://cloud.google.com/docs/authentication/getting-started | ||
[enable_billing]:https://cloud.google.com/apis/docs/getting-started#enabling_billing | ||
[client_library_python]: https://googlecloudplatform.github.io/google-cloud-python/ | ||
[issues]: https://github.com/GoogleCloudPlatform/google-cloud-python/issues | ||
[contrib_guide]: https://github.com/googleapis/google-cloud-python/blob/master/CONTRIBUTING.rst | ||
[py_style]: http://google.github.io/styleguide/pyguide.html | ||
[cloud_sdk]: https://cloud.google.com/sdk/docs | ||
[gcloud_shell]: https://cloud.google.com/shell/docs | ||
[gcloud_shell]: https://cloud.google.com/shell/docs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
[//]: # "This README.md file is auto-generated, all changes to this file will be lost." | ||
[//]: # "To regenerate it, use `python -m synthtool`." | ||
|
||
## Python Samples for Cloud Bigtable | ||
|
||
This directory contains samples for Cloud Bigtable, which may be used as a refererence for how to use Cloud Bigtable. | ||
Samples, quickstarts, and other documentation are available at <a href="https://cloud.google.com/bigtable">cloud.google.com</a>. | ||
|
||
|
||
### Beam | ||
|
||
This sample demonstrates writing data to Bigtable with Beam. | ||
|
||
|
||
|
||
## Additional Information | ||
|
||
You can read the documentation for more details on API usage and use GitHub | ||
to <a href="https://github.com/googleapis/python-bigtable">source</a> and [report issues][issues]. | ||
|
||
### Contributing | ||
For [contributing guidelines][contrib_guide], the [Python style guide][py_style], and more information on prerequisite steps to contribute, view the source code at <a href="https://github.com/googleapis/python-bigtable">googleapis/python-bigtable</a>. | ||
|
||
[authentication]: https://cloud.google.com/docs/authentication/getting-started | ||
[enable_billing]:https://cloud.google.com/apis/docs/getting-started#enabling_billing | ||
[client_library_python]: https://googlecloudplatform.github.io/google-cloud-python/ | ||
[issues]: https://github.com/GoogleCloudPlatform/google-cloud-python/issues | ||
[contrib_guide]: https://github.com/googleapis/google-cloud-python/blob/master/CONTRIBUTING.rst | ||
[py_style]: http://google.github.io/styleguide/pyguide.html | ||
[cloud_sdk]: https://cloud.google.com/sdk/docs | ||
[gcloud_shell]: https://cloud.google.com/shell/docs | ||
[gcloud_shell]: https://cloud.google.com/shell/docs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
[//]: # "This README.md file is auto-generated, all changes to this file will be lost." | ||
[//]: # "To regenerate it, use `python -m synthtool`." | ||
|
||
## Python Samples for Cloud Bigtable | ||
|
||
This directory contains samples for Cloud Bigtable, which may be used as a refererence for how to use Cloud Bigtable. | ||
Samples, quickstarts, and other documentation are available at <a href="https://cloud.google.com/bigtable">cloud.google.com</a>. | ||
|
||
|
||
### Hello World in Cloud Bigtable | ||
|
||
Demonstrates how to connect to Cloud Bigtable and run some basic operations. More information available at: https://cloud.google.com/bigtable/docs/samples-python-hello | ||
|
||
|
||
<a href="https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/python-bigtable&page=editor&open_in_editor=main.py"><img alt="Open in Cloud Shell" src="http://gstatic.com/cloudssh/images/open-btn.png"> | ||
</a> | ||
|
||
To run this sample: | ||
|
||
1. If this is your first time working with GCP products, you will need to set up [the Cloud SDK][cloud_sdk] or utilize [Google Cloud Shell][gcloud_shell]. This sample may [require authetication][authentication] and you will need to [enable billing][enable_billing]. | ||
|
||
1. Make a fork of this repo and clone the branch locally, then navigate to the sample directory you want to use. | ||
|
||
1. Install the dependencies needed to run the samples. | ||
|
||
pip install -r requirements.txt | ||
|
||
1. Run the sample using | ||
|
||
python main.py | ||
|
||
|
||
`usage: main.py [-h] [--table TABLE] project_id instance_id` | ||
|
||
## Additional Information | ||
|
||
You can read the documentation for more details on API usage and use GitHub | ||
to <a href="https://github.com/googleapis/python-bigtable">source</a> and [report issues][issues]. | ||
|
||
### Contributing | ||
For [contributing guidelines][contrib_guide], the [Python style guide][py_style], and more information on prerequisite steps to contribute, view the source code at <a href="https://github.com/googleapis/python-bigtable">googleapis/python-bigtable</a>. | ||
|
||
[authentication]: https://cloud.google.com/docs/authentication/getting-started | ||
[enable_billing]:https://cloud.google.com/apis/docs/getting-started#enabling_billing | ||
[client_library_python]: https://googlecloudplatform.github.io/google-cloud-python/ | ||
[issues]: https://github.com/GoogleCloudPlatform/google-cloud-python/issues | ||
[contrib_guide]: https://github.com/googleapis/google-cloud-python/blob/master/CONTRIBUTING.rst | ||
[py_style]: http://google.github.io/styleguide/pyguide.html | ||
[cloud_sdk]: https://cloud.google.com/sdk/docs | ||
[gcloud_shell]: https://cloud.google.com/shell/docs | ||
[gcloud_shell]: https://cloud.google.com/shell/docs |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
[//]: # "This README.md file is auto-generated, all changes to this file will be lost." | ||
[//]: # "To regenerate it, use `python -m synthtool`." | ||
|
||
## Python Samples for Cloud Bigtable | ||
|
||
This directory contains samples for Cloud Bigtable, which may be used as a refererence for how to use Cloud Bigtable. | ||
Samples, quickstarts, and other documentation are available at <a href="https://cloud.google.com/bigtable">cloud.google.com</a>. | ||
|
||
|
||
### Hello World using HappyBase | ||
|
||
This sample demonstrates using the Google Cloud Client Library HappyBase package, an implementation of the HappyBase API to connect to and interact with Cloud Bigtable. More information available at: https://cloud.google.com/bigtable/docs/samples-python-hello-happybase | ||
|
||
|
||
<a href="https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/python-bigtable&page=editor&open_in_editor=main.py"><img alt="Open in Cloud Shell" src="http://gstatic.com/cloudssh/images/open-btn.png"> | ||
</a> | ||
|
||
To run this sample: | ||
|
||
1. If this is your first time working with GCP products, you will need to set up [the Cloud SDK][cloud_sdk] or utilize [Google Cloud Shell][gcloud_shell]. This sample may [require authetication][authentication] and you will need to [enable billing][enable_billing]. | ||
|
||
1. Make a fork of this repo and clone the branch locally, then navigate to the sample directory you want to use. | ||
|
||
1. Install the dependencies needed to run the samples. | ||
|
||
pip install -r requirements.txt | ||
|
||
1. Run the sample using | ||
|
||
python main.py | ||
|
||
|
||
`usage: main.py [-h] [--table TABLE] project_id instance_id` | ||
|
||
## Additional Information | ||
|
||
You can read the documentation for more details on API usage and use GitHub | ||
to <a href="https://github.com/googleapis/python-bigtable">source</a> and [report issues][issues]. | ||
|
||
### Contributing | ||
For [contributing guidelines][contrib_guide], the [Python style guide][py_style], and more information on prerequisite steps to contribute, view the source code at <a href="https://github.com/googleapis/python-bigtable">googleapis/python-bigtable</a>. | ||
|
||
[authentication]: https://cloud.google.com/docs/authentication/getting-started | ||
[enable_billing]:https://cloud.google.com/apis/docs/getting-started#enabling_billing | ||
[client_library_python]: https://googlecloudplatform.github.io/google-cloud-python/ | ||
[issues]: https://github.com/GoogleCloudPlatform/google-cloud-python/issues | ||
[contrib_guide]: https://github.com/googleapis/google-cloud-python/blob/master/CONTRIBUTING.rst | ||
[py_style]: http://google.github.io/styleguide/pyguide.html | ||
[cloud_sdk]: https://cloud.google.com/sdk/docs | ||
[gcloud_shell]: https://cloud.google.com/shell/docs | ||
[gcloud_shell]: https://cloud.google.com/shell/docs |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
doesn't seem to have any instructions?