Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Pysamples new readme gen (#112)
This PR adds some new generation code to the synth.py to handle generation of the Python sample docs! Content of the sample descriptions/custom content is predominantly pulled from the existing docs
- Loading branch information
Showing
25 changed files
with
481 additions
and
1,012 deletions.
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,25 @@ | ||
[//]: # "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 [browse the source][source] 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/ | ||
[source]: https://github.com/GoogleCloudPlatform/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,52 @@ | ||
[//]: # "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 | ||
|
||
|
||
<pre>usage: main.py [-h] [--table TABLE] project_id instance_id<br>Demonstrates how to connect to Cloud Bigtable and run some basic operations.<br>Prerequisites: - Create a Cloud Bigtable cluster.<br>https://cloud.google.com/bigtable/docs/creating-cluster - Set your Google<br>Application Default Credentials.<br>https://developers.google.com/identity/protocols/application-default-<br>credentials<br><br><br>positional arguments:<br> project_id Your Cloud Platform project ID.<br> instance_id ID of the Cloud Bigtable instance to connect to.<br><br><br>optional arguments:<br> -h, --help show this help message and exit<br> --table TABLE Table to create and destroy. (default: Hello-Bigtable)</pre> | ||
|
||
## Additional Information | ||
|
||
You can read the documentation for more details on API usage and use GitHub | ||
to [browse the source][source] 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/ | ||
[source]: https://github.com/GoogleCloudPlatform/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.
Oops, something went wrong.