-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2033 from daspecster/docs-updates
Package docs files for simple deployment
- Loading branch information
Showing
7 changed files
with
303 additions
and
12 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| <section class="hero-banner"> | ||
| <div class="container clearfix"> | ||
| <div class="quote-box"> | ||
| <h1>gcloud-python</h1> | ||
| <p>Google Cloud Client Library for Python | ||
| - an idiomatic, intuitive, and natural way for Python developers to | ||
| integrate with Google Cloud Platform services, like Cloud Datastore | ||
| and Cloud Storage.</p> | ||
| </div> | ||
|
|
||
| <div class="quote-box--supplementary"> | ||
| <pre class="skip-highlight"><code class="subtle--blue">$</code> pip install <code class="subtle--blue">--upgrade</code> <strong>gcloud</strong></pre> | ||
| <h4 class="latest-release subtle" ng-if="home.latestRelease"> | ||
| Latest Release <a ng-href="{{home.latestRelease.link}}" class="latest-release--link white">{{home.latestRelease.name}}</a> | ||
| {{home.latestRelease.date|date}} | ||
| </h4> | ||
| </div> | ||
| </div><!-- end of .container --> | ||
| </section><!-- end of .hero-banner --> | ||
|
|
||
| <section class="block featuring"> | ||
| <div class="container"> | ||
| <ul class="featuring-links"> | ||
| <li> | ||
| <a href="#/docs/{{home.latestRelease.name}}/gcloud" title="gcloud-python docs" class="btn btn-docs"> | ||
| <img src="src/images/icon-lang-python-gray.svg" alt="Python icon" /> | ||
| Read the Docs | ||
| </a> | ||
| </li> | ||
| <li> | ||
| <a href="https://github.com/GoogleCloudPlatform/gcloud-python" title="gcloud-python on GitHub" class="ext-link"> | ||
| <img src="src/images/icon-link-github.svg" alt="GitHub icon" /> | ||
| GitHub | ||
| </a> | ||
| </li> | ||
| <li> | ||
| <a href="https://github.com/GoogleCloudPlatform/gcloud-python/issues" title="gcloud-python issues on Github" class="ext-link"> | ||
| <img src="src/images/icon-link-github.svg" alt="GitHub icon" /> | ||
| Issues | ||
| </a> | ||
| </li> | ||
| <li> | ||
| <a href="http://stackoverflow.com/questions/tagged/gcloud-python" title="gcloud-python on StackOverflow" class="ext-link"> | ||
| <img src="src/images/icon-link-stackoverflow.svg" alt="StackOverflow icon" /> | ||
| StackOverflow | ||
| </a> | ||
| </li> | ||
| <li> | ||
| <a href="https://pypi.python.org/pypi/gcloud" title="gcloud-python on pypi" class="ext-link"> | ||
| <img src="src/images/icon-link-package-manager.svg" alt="pypi icon" /> | ||
| PyPI | ||
| </a> | ||
| </li> | ||
| </ul> | ||
| </div><!-- end of .container --> | ||
| </section><!-- end of .featuring --> | ||
|
|
||
| <section class="block about"> | ||
| <div class="container clearfix"> | ||
| <div class="quote-box"> | ||
| <h3 class="block-title">What is it?</h3> | ||
|
|
||
| <p><code>gcloud-python</code> is a client library for accessing Google | ||
| Cloud Platform services that significantly reduces the boilerplate | ||
| code you have to write. The library provides high-level API | ||
| abstractions so they're easier to understand. It embraces | ||
| idioms of Python, works well with the standard library, and | ||
| integrates better with your codebase. | ||
| All this means you spend more time creating code that matters | ||
| to you.</p> | ||
|
|
||
| <p><code>gcloud-python</code> is configured to access Google Cloud Platform | ||
| services and authorize (OAuth 2.0) automatically on your behalf. | ||
| With a one-line install and a private key, you are up and ready | ||
| to go. Better yet, if you are running on a Google Compute Engine | ||
| instance, the one-line install is enough!</p> | ||
|
|
||
| </div> | ||
|
|
||
| <div class="quote-box--supplementary"> | ||
| <h4>Retrieve Datastore Entities</h4> | ||
|
|
||
| <div hljs hlsj-language="python"> | ||
| from gcloud import datastore | ||
|
|
||
| client = datastore.Client() | ||
| product_key = client.key('Product', 123) | ||
| print(client.get(product_key)) | ||
| </div> | ||
| </div> | ||
| </div><!-- end of .container --> | ||
| </section><!-- end of .featuring --> | ||
|
|
||
| <section class="block examples"> | ||
| <div class="container clearfix"> | ||
| <h3 class="block-title">Examples</h3> | ||
|
|
||
| <ul> | ||
| <li> | ||
| <a href="https://github.com/GoogleCloudPlatform/gcloud-python-expenses-demo"><code>gcloud-python-expenses-demo</code></a> - Use gcloud-python with the Datastore and Cloud Storage to manage expenses | ||
| </li> | ||
| </ul> | ||
| </div> | ||
| </section> | ||
|
|
||
| <section class="block"> | ||
| <div class="container clearfix"> | ||
| <h3 class="block-title">FAQ</h3> | ||
|
|
||
| <h4>What is the relationship between the <code>gcloud-python</code> package | ||
| and the <code>gcloud</code> command-line tool?</h4> | ||
| <p>Both the <code>gcloud</code> command-line tool and | ||
| <code>gcloud-python</code> package are a part of the Google Cloud SDK: a collection | ||
| of tools and libraries that enable you to easily create and manage | ||
| resources on the Google Cloud Platform. The <code>gcloud</code> command-line | ||
| tool can be used to manage both your development workflow and your | ||
| Google Cloud Platform resources while the <code>gcloud-python</code> package is the | ||
| Google Cloud Client Library for Python.</p> | ||
|
|
||
| <h4>What is the relationship between <code>gcloud-python</code> | ||
| and the Google APIs Python Client?</h4> | ||
| <p>The <a href="https://github.com/google/google-api-python-client"> | ||
| Google APIs Python Client</a> is a client library for | ||
| using the broad set of Google APIs. | ||
| <code>gcloud-python</code> is built specifically for the Google Cloud Platform | ||
| and is the recommended way to integrate Google Cloud APIs into your | ||
| Python applications. If your application requires both Google Cloud Platform and | ||
| other Google APIs, the 2 libraries may be used by your application.</p> | ||
| </div> | ||
| </section> <!-- end of FAQ --> |
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,130 @@ | ||
| <section class="hero-banner"> | ||
| <div class="container clearfix"> | ||
| <div class="quote-box"> | ||
| <h1>gcloud-python</h1> | ||
| <p>Google Cloud Client Library for Python | ||
| - an idiomatic, intuitive, and natural way for Python developers to | ||
| integrate with Google Cloud Platform services, like Cloud Datastore | ||
| and Cloud Storage.</p> | ||
| </div> | ||
|
|
||
| <div class="quote-box--supplementary"> | ||
| <pre class="skip-highlight"><code class="subtle--blue">$</code> pip install <code class="subtle--blue">--upgrade</code> <strong>gcloud</strong></pre> | ||
| <h4 class="latest-release subtle" ng-if="home.latestRelease"> | ||
| Latest Release <a ng-href="{{home.latestRelease.link}}" class="latest-release--link white">{{home.latestRelease.name}}</a> | ||
| {{home.latestRelease.date|date}} | ||
| </h4> | ||
| </div> | ||
| </div><!-- end of .container --> | ||
| </section><!-- end of .hero-banner --> | ||
|
|
||
| <section class="block featuring"> | ||
| <div class="container"> | ||
| <ul class="featuring-links"> | ||
| <li> | ||
| <a href="#/docs/{{home.latestRelease.name}}/gcloud" title="gcloud-python docs" class="btn btn-docs"> | ||
| <img src="src/images/icon-lang-python-gray.svg" alt="Python icon" /> | ||
| Read the Docs | ||
| </a> | ||
| </li> | ||
| <li> | ||
| <a href="https://github.com/GoogleCloudPlatform/gcloud-python" title="gcloud-python on GitHub" class="ext-link"> | ||
| <img src="src/images/icon-link-github.svg" alt="GitHub icon" /> | ||
| GitHub | ||
| </a> | ||
| </li> | ||
| <li> | ||
| <a href="https://github.com/GoogleCloudPlatform/gcloud-python/issues" title="gcloud-python issues on Github" class="ext-link"> | ||
| <img src="src/images/icon-link-github.svg" alt="GitHub icon" /> | ||
| Issues | ||
| </a> | ||
| </li> | ||
| <li> | ||
| <a href="http://stackoverflow.com/questions/tagged/gcloud-python" title="gcloud-python on StackOverflow" class="ext-link"> | ||
| <img src="src/images/icon-link-stackoverflow.svg" alt="StackOverflow icon" /> | ||
| StackOverflow | ||
| </a> | ||
| </li> | ||
| <li> | ||
| <a href="https://pypi.python.org/pypi/gcloud" title="gcloud-python on pypi" class="ext-link"> | ||
| <img src="src/images/icon-link-package-manager.svg" alt="pypi icon" /> | ||
| PyPI | ||
| </a> | ||
| </li> | ||
| </ul> | ||
| </div><!-- end of .container --> | ||
| </section><!-- end of .featuring --> | ||
|
|
||
| <section class="block about"> | ||
| <div class="container clearfix"> | ||
| <div class="quote-box"> | ||
| <h3 class="block-title">What is it?</h3> | ||
|
|
||
| <p><code>gcloud-python</code> is a client library for accessing Google | ||
| Cloud Platform services that significantly reduces the boilerplate | ||
| code you have to write. The library provides high-level API | ||
| abstractions so they're easier to understand. It embraces | ||
| idioms of Python, works well with the standard library, and | ||
| integrates better with your codebase. | ||
| All this means you spend more time creating code that matters | ||
| to you.</p> | ||
|
|
||
| <p><code>gcloud-python</code> is configured to access Google Cloud Platform | ||
| services and authorize (OAuth 2.0) automatically on your behalf. | ||
| With a one-line install and a private key, you are up and ready | ||
| to go. Better yet, if you are running on a Google Compute Engine | ||
| instance, the one-line install is enough!</p> | ||
|
|
||
| </div> | ||
|
|
||
| <div class="quote-box--supplementary"> | ||
| <h4>Retrieve Datastore Entities</h4> | ||
|
|
||
| <div hljs hlsj-language="python"> | ||
| from gcloud import datastore | ||
|
|
||
| client = datastore.Client() | ||
| product_key = client.key('Product', 123) | ||
| print(client.get(product_key)) | ||
| </div> | ||
| </div> | ||
| </div><!-- end of .container --> | ||
| </section><!-- end of .featuring --> | ||
|
|
||
| <section class="block examples"> | ||
| <div class="container clearfix"> | ||
| <h3 class="block-title">Examples</h3> | ||
|
|
||
| <ul> | ||
| <li> | ||
| <a href="https://github.com/GoogleCloudPlatform/gcloud-python-expenses-demo"><code>gcloud-python-expenses-demo</code></a> - Use gcloud-python with the Datastore and Cloud Storage to manage expenses | ||
| </li> | ||
| </ul> | ||
| </div> | ||
| </section> | ||
|
|
||
| <section class="block"> | ||
| <div class="container clearfix"> | ||
| <h3 class="block-title">FAQ</h3> | ||
|
|
||
| <h4>What is the relationship between the <code>gcloud-python</code> package | ||
| and the <code>gcloud</code> command-line tool?</h4> | ||
| <p>Both the <code>gcloud</code> command-line tool and | ||
| <code>gcloud-python</code> package are a part of the Google Cloud SDK: a collection | ||
| of tools and libraries that enable you to easily create and manage | ||
| resources on the Google Cloud Platform. The <code>gcloud</code> command-line | ||
| tool can be used to manage both your development workflow and your | ||
| Google Cloud Platform resources while the <code>gcloud-python</code> package is the | ||
| Google Cloud Client Library for Python.</p> | ||
|
|
||
| <h4>What is the relationship between <code>gcloud-python</code> | ||
| and the Google APIs Python Client?</h4> | ||
| <p>The <a href="https://github.com/google/google-api-python-client"> | ||
| Google APIs Python Client</a> is a client library for | ||
| using the broad set of Google APIs. | ||
| <code>gcloud-python</code> is built specifically for the Google Cloud Platform | ||
| and is the recommended way to integrate Google Cloud APIs into your | ||
| Python applications. If your application requires both Google Cloud Platform and | ||
| other Google APIs, the 2 libraries may be used by your application.</p> | ||
| </div> | ||
| </section> <!-- end of FAQ --> |
File renamed without changes.
File renamed without changes.
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
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