Skip to content

Commit 72fa97a

Browse files
author
selfiebot
committed
Update docs after merge to master
1 parent 91d4337 commit 72fa97a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+16453
-3733
lines changed

‎_modules/gcloud/connection.html‎

Lines changed: 53 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,14 @@ <h1><a href="../../index.html">gcloud 0.1 documentation</a></h1>
6464
<h3>All API Docs</h3>
6565
<nav class="gc-toc">
6666
<ul>
67+
<li class="toctree-l1"><a class="reference internal" href="../../common-api.html">Cloud Common</a></li>
6768
<li class="toctree-l1"><a class="reference internal" href="../../datastore-api.html">Cloud Datastore</a></li>
69+
<li class="toctree-l1"><a class="reference internal" href="../../datastore-getting-started.html">Getting started with Cloud Datastore</a></li>
70+
<li class="toctree-l1"><a class="reference internal" href="../../datastore-quickstart.html">Cloud Datastore in 10 seconds</a></li>
71+
<li class="toctree-l1"><a class="reference internal" href="../../getting-started.html">Getting started with gcloud</a></li>
6872
<li class="toctree-l1"><a class="reference internal" href="../../storage-api.html">Cloud Storage</a></li>
69-
<li class="toctree-l1"><a class="reference internal" href="../../common-api.html">Cloud Common</a></li>
73+
<li class="toctree-l1"><a class="reference internal" href="../../storage-getting-started.html">Getting started with Cloud Storage</a></li>
74+
<li class="toctree-l1"><a class="reference internal" href="../../storage-quickstart.html">Cloud Storage in 10 seconds</a></li>
7075
</ul>
7176

7277
</nav>
@@ -81,50 +86,59 @@ <h3>All API Docs</h3>
8186
<div class="body" role="main" id="gc-content">
8287

8388
<h1>Source code for gcloud.connection</h1><div class="highlight"><pre>
89+
<span class="sd">&quot;&quot;&quot; Shared implementation of connections to API servers.&quot;&quot;&quot;</span>
90+
<span class="kn">from</span> <span class="nn">pkg_resources</span> <span class="kn">import</span> <span class="n">get_distribution</span>
91+
8492
<span class="kn">import</span> <span class="nn">httplib2</span>
8593

8694

8795
<div class="viewcode-block" id="Connection"><a class="viewcode-back" href="../../common-api.html#gcloud.connection.Connection">[docs]</a><span class="k">class</span> <span class="nc">Connection</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
88-
<span class="sd">&quot;&quot;&quot;A generic connection to Google Cloud Platform.</span>
89-
90-
<span class="sd"> Subclasses should understand</span>
91-
<span class="sd"> only the basic types</span>
92-
<span class="sd"> in method arguments,</span>
93-
<span class="sd"> however they should be capable</span>
94-
<span class="sd"> of returning advanced types.</span>
95-
<span class="sd"> &quot;&quot;&quot;</span>
96-
97-
<span class="n">API_BASE_URL</span> <span class="o">=</span> <span class="s">&#39;https://www.googleapis.com&#39;</span>
98-
<span class="sd">&quot;&quot;&quot;The base of the API call URL.&quot;&quot;&quot;</span>
96+
<span class="sd">&quot;&quot;&quot;A generic connection to Google Cloud Platform.</span>
9997

100-
<span class="n">_EMPTY</span> <span class="o">=</span> <span class="nb">object</span><span class="p">()</span>
101-
<span class="sd">&quot;&quot;&quot;A pointer to represent an empty value for default arguments.&quot;&quot;&quot;</span>
102-
103-
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
104-
<span class="sd">&quot;&quot;&quot;</span>
105-
<span class="sd"> :type credentials: :class:`gcloud.credentials.Credentials`</span>
106-
<span class="sd"> :param credentials: The OAuth2 Credentials to use for this connection.</span>
98+
<span class="sd"> Subclasses should understand</span>
99+
<span class="sd"> only the basic types</span>
100+
<span class="sd"> in method arguments,</span>
101+
<span class="sd"> however they should be capable</span>
102+
<span class="sd"> of returning advanced types.</span>
107103
<span class="sd"> &quot;&quot;&quot;</span>
108104

109-
<span class="bp">self</span><span class="o">.</span><span class="n">_credentials</span> <span class="o">=</span> <span class="n">credentials</span>
110-
111-
<span class="nd">@property</span>
112-
<div class="viewcode-block" id="Connection.credentials"><a class="viewcode-back" href="../../common-api.html#gcloud.connection.Connection.credentials">[docs]</a> <span class="k">def</span> <span class="nf">credentials</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
113-
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_credentials</span>
114-
</div>
115-
<span class="nd">@property</span>
116-
<div class="viewcode-block" id="Connection.http"><a class="viewcode-back" href="../../common-api.html#gcloud.connection.Connection.http">[docs]</a> <span class="k">def</span> <span class="nf">http</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
117-
<span class="sd">&quot;&quot;&quot;A getter for the HTTP transport used in talking to the API.</span>
118-
119-
<span class="sd"> :rtype: :class:`httplib2.Http`</span>
120-
<span class="sd"> :returns: A Http object used to transport data.</span>
121-
<span class="sd"> &quot;&quot;&quot;</span>
122-
<span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">&#39;_http&#39;</span><span class="p">):</span>
123-
<span class="bp">self</span><span class="o">.</span><span class="n">_http</span> <span class="o">=</span> <span class="n">httplib2</span><span class="o">.</span><span class="n">Http</span><span class="p">()</span>
124-
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_credentials</span><span class="p">:</span>
125-
<span class="bp">self</span><span class="o">.</span><span class="n">_http</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_credentials</span><span class="o">.</span><span class="n">authorize</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_http</span><span class="p">)</span>
126-
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_http</span>
127-
</pre></div></div></div>
105+
<span class="n">API_BASE_URL</span> <span class="o">=</span> <span class="s">&#39;https://www.googleapis.com&#39;</span>
106+
<span class="sd">&quot;&quot;&quot;The base of the API call URL.&quot;&quot;&quot;</span>
107+
108+
<span class="n">_EMPTY</span> <span class="o">=</span> <span class="nb">object</span><span class="p">()</span>
109+
<span class="sd">&quot;&quot;&quot;A pointer to represent an empty value for default arguments.&quot;&quot;&quot;</span>
110+
111+
<span class="n">USER_AGENT</span> <span class="o">=</span> <span class="s">&quot;gcloud-python/{0}&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">get_distribution</span><span class="p">(</span><span class="s">&#39;gcloud&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">version</span><span class="p">)</span>
112+
<span class="sd">&quot;&quot;&quot;The user agent for gcloud-python requests.&quot;&quot;&quot;</span>
113+
114+
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
115+
<span class="sd">&quot;&quot;&quot;</span>
116+
<span class="sd"> :type credentials: :class:`oauth2client.client.OAuth2Credentials`</span>
117+
<span class="sd"> :param credentials: The OAuth2 Credentials to use for this connection.</span>
118+
<span class="sd"> &quot;&quot;&quot;</span>
119+
<span class="bp">self</span><span class="o">.</span><span class="n">_credentials</span> <span class="o">=</span> <span class="n">credentials</span>
120+
121+
<span class="nd">@property</span>
122+
<span class="k">def</span> <span class="nf">credentials</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
123+
<span class="sd">&quot;&quot;&quot;</span>
124+
<span class="sd"> :rtype: :class:`oauth2client.client.OAuth2Credentials`, or None</span>
125+
<span class="sd"> :returns: The credentials object associated with this connection.</span>
126+
<span class="sd"> &quot;&quot;&quot;</span>
127+
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_credentials</span>
128+
129+
<span class="nd">@property</span>
130+
<span class="k">def</span> <span class="nf">http</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
131+
<span class="sd">&quot;&quot;&quot;A getter for the HTTP transport used in talking to the API.</span>
132+
133+
<span class="sd"> :rtype: :class:`httplib2.Http`</span>
134+
<span class="sd"> :returns: A Http object used to transport data.</span>
135+
<span class="sd"> &quot;&quot;&quot;</span>
136+
<span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">&#39;_http&#39;</span><span class="p">):</span>
137+
<span class="bp">self</span><span class="o">.</span><span class="n">_http</span> <span class="o">=</span> <span class="n">httplib2</span><span class="o">.</span><span class="n">Http</span><span class="p">()</span>
138+
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_credentials</span><span class="p">:</span>
139+
<span class="bp">self</span><span class="o">.</span><span class="n">_http</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_credentials</span><span class="o">.</span><span class="n">authorize</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_http</span><span class="p">)</span>
140+
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_http</span></div>
141+
</pre></div>
128142

129143
</div>
130144
</div>
@@ -136,7 +150,7 @@ <h1>Source code for gcloud.connection</h1><div class="highlight"><pre>
136150
<footer id="gc-footer" class="footer" role="contentinfo">
137151
<div id="gc-copyright">
138152
&copy; Copyright 2014, JJ Geewax.
139-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
153+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3b1.
140154
</div>
141155
</footer>
142156
</body>

‎_modules/gcloud/credentials.html‎

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,14 @@ <h1><a href="../../index.html">gcloud 0.1 documentation</a></h1>
6464
<h3>All API Docs</h3>
6565
<nav class="gc-toc">
6666
<ul>
67+
<li class="toctree-l1"><a class="reference internal" href="../../common-api.html">Cloud Common</a></li>
6768
<li class="toctree-l1"><a class="reference internal" href="../../datastore-api.html">Cloud Datastore</a></li>
69+
<li class="toctree-l1"><a class="reference internal" href="../../datastore-getting-started.html">Getting started with Cloud Datastore</a></li>
70+
<li class="toctree-l1"><a class="reference internal" href="../../datastore-quickstart.html">Cloud Datastore in 10 seconds</a></li>
71+
<li class="toctree-l1"><a class="reference internal" href="../../getting-started.html">Getting started with gcloud</a></li>
6872
<li class="toctree-l1"><a class="reference internal" href="../../storage-api.html">Cloud Storage</a></li>
69-
<li class="toctree-l1"><a class="reference internal" href="../../common-api.html">Cloud Common</a></li>
73+
<li class="toctree-l1"><a class="reference internal" href="../../storage-getting-started.html">Getting started with Cloud Storage</a></li>
74+
<li class="toctree-l1"><a class="reference internal" href="../../storage-quickstart.html">Cloud Storage in 10 seconds</a></li>
7075
</ul>
7176

7277
</nav>
@@ -86,22 +91,17 @@ <h1>Source code for gcloud.credentials</h1><div class="highlight"><pre>
8691
<span class="kn">from</span> <span class="nn">oauth2client</span> <span class="kn">import</span> <span class="n">client</span>
8792

8893

89-
<div class="viewcode-block" id="Credentials"><a class="viewcode-back" href="../../common-api.html#gcloud.credentials.Credentials">[docs]</a><span class="k">class</span> <span class="nc">Credentials</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
90-
<span class="sd">&quot;&quot;&quot;An object used to simplify the OAuth2 credentials library.</span>
91-
92-
<span class="sd"> .. note::</span>
93-
<span class="sd"> You should not need to use this class directly.</span>
94-
<span class="sd"> Instead, use the helper methods provided in</span>
95-
<span class="sd"> :func:`gcloud.datastore.__init__.get_connection`</span>
96-
<span class="sd"> and</span>
97-
<span class="sd"> :func:`gcloud.datastore.__init__.get_dataset`</span>
98-
<span class="sd"> which use this class under the hood.</span>
99-
<span class="sd"> &quot;&quot;&quot;</span>
100-
101-
<span class="nd">@classmethod</span>
102-
<div class="viewcode-block" id="Credentials.get_for_service_account"><a class="viewcode-back" href="../../common-api.html#gcloud.credentials.Credentials.get_for_service_account">[docs]</a> <span class="k">def</span> <span class="nf">get_for_service_account</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">client_email</span><span class="p">,</span> <span class="n">private_key_path</span><span class="p">,</span> <span class="n">scope</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
94+
<div class="viewcode-block" id="get_for_service_account"><a class="viewcode-back" href="../../common-api.html#gcloud.credentials.get_for_service_account">[docs]</a><span class="k">def</span> <span class="nf">get_for_service_account</span><span class="p">(</span><span class="n">client_email</span><span class="p">,</span> <span class="n">private_key_path</span><span class="p">,</span> <span class="n">scope</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
10395
<span class="sd">&quot;&quot;&quot;Gets the credentials for a service account.</span>
10496

97+
<span class="sd"> .. note::</span>
98+
<span class="sd"> You should not need to use this function directly.</span>
99+
<span class="sd"> Instead, use the helper methods provided in</span>
100+
<span class="sd"> :func:`gcloud.datastore.__init__.get_connection`</span>
101+
<span class="sd"> and</span>
102+
<span class="sd"> :func:`gcloud.datastore.__init__.get_dataset`</span>
103+
<span class="sd"> which use this method under the hood.</span>
104+
105105
<span class="sd"> :type client_email: string</span>
106106
<span class="sd"> :param client_email: The e-mail attached to the service account.</span>
107107

@@ -111,16 +111,19 @@ <h1>Source code for gcloud.credentials</h1><div class="highlight"><pre>
111111
<span class="sd"> account).</span>
112112

113113
<span class="sd"> :type scope: string or tuple of strings</span>
114-
<span class="sd"> :param scope: The scope against which to authenticate.</span>
115-
<span class="sd"> (Different services require different scopes,</span>
116-
<span class="sd"> check the documentation for which scope is required</span>
117-
<span class="sd"> for the different levels of access</span>
118-
<span class="sd"> to any particular API.)</span>
114+
<span class="sd"> :param scope: The scope against which to authenticate. (Different services</span>
115+
<span class="sd"> require different scopes, check the documentation for which</span>
116+
<span class="sd"> scope is required for the different levels of access to any</span>
117+
<span class="sd"> particular API.)</span>
118+
119+
<span class="sd"> :rtype: :class:`oauth2client.client.SignedJwtAssertionCredentials`</span>
120+
<span class="sd"> :returns: A new SignedJwtAssertionCredentials instance with the</span>
121+
<span class="sd"> needed service account settings.</span>
119122
<span class="sd"> &quot;&quot;&quot;</span>
120123
<span class="k">return</span> <span class="n">client</span><span class="o">.</span><span class="n">SignedJwtAssertionCredentials</span><span class="p">(</span>
121124
<span class="n">service_account_name</span><span class="o">=</span><span class="n">client_email</span><span class="p">,</span>
122125
<span class="n">private_key</span><span class="o">=</span><span class="nb">open</span><span class="p">(</span><span class="n">private_key_path</span><span class="p">)</span><span class="o">.</span><span class="n">read</span><span class="p">(),</span>
123-
<span class="n">scope</span><span class="o">=</span><span class="n">scope</span><span class="p">)</span></div></div>
126+
<span class="n">scope</span><span class="o">=</span><span class="n">scope</span><span class="p">)</span></div>
124127
</pre></div>
125128

126129
</div>
@@ -133,7 +136,7 @@ <h1>Source code for gcloud.credentials</h1><div class="highlight"><pre>
133136
<footer id="gc-footer" class="footer" role="contentinfo">
134137
<div id="gc-copyright">
135138
&copy; Copyright 2014, JJ Geewax.
136-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
139+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3b1.
137140
</div>
138141
</footer>
139142
</body>

0 commit comments

Comments
 (0)