/usr/share/doc/python-gnocchiclient-doc/html/api.html is in python-gnocchiclient-doc 7.0.1-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>The gnocchiclient Python API — Gnocchiclient 7.0.1 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '7.0.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="shortcut icon" href="_static/gnocchi-icon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="The gnocchi shell utility" href="shell.html" />
</head>
<body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="shell.html" title="The gnocchi shell utility"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Gnocchiclient 7.0.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-gnocchiclient">
<span id="the-gnocchiclient-python-api"></span><h1>The <a class="reference internal" href="#module-gnocchiclient" title="gnocchiclient: A client for the Gnocchi API."><code class="xref py py-mod docutils literal"><span class="pre">gnocchiclient</span></code></a> Python API<a class="headerlink" href="#module-gnocchiclient" title="Permalink to this headline">¶</a></h1>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<p>To use gnocchiclient in a project:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gnocchiclient</span> <span class="k">import</span> <span class="n">auth</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gnocchiclient.v1</span> <span class="k">import</span> <span class="n">client</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="n">auth_plugin</span> <span class="o">=</span> <span class="n">auth</span><span class="o">.</span><span class="n">GnocchiBasicPlugin</span><span class="p">(</span><span class="n">user</span><span class="o">=</span><span class="s2">"admin"</span><span class="p">,</span>
<span class="gp">>>> </span> <span class="n">endpoint</span><span class="o">=</span><span class="s2">"http://localhost:8041"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">gnocchi</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">Client</span><span class="p">(</span><span class="n">session_options</span><span class="o">=</span><span class="p">{</span><span class="s1">'auth'</span><span class="p">:</span> <span class="n">auth_plugin</span><span class="p">})</span>
<span class="gp">>>> </span><span class="n">gnocchi</span><span class="o">.</span><span class="n">resource</span><span class="o">.</span><span class="n">list</span><span class="p">(</span><span class="s2">"generic"</span><span class="p">)</span>
</pre></div>
</div>
<p>With authentication from a keystoneauth1 plugins:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">keystoneauth1</span> <span class="k">import</span> <span class="n">loading</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">oslo_config</span> <span class="k">import</span> <span class="n">cfg</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gnocchiclient</span> <span class="k">import</span> <span class="n">auth</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gnocchiclient.v1</span> <span class="k">import</span> <span class="n">client</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="n">conf</span> <span class="o">=</span> <span class="n">cfg</span><span class="o">.</span><span class="n">ConfigOpts</span><span class="p">()</span>
<span class="gp">>>> </span><span class="o">...</span>
<span class="gp">>>> </span><span class="n">auth_plugin</span> <span class="o">=</span> <span class="n">loading</span><span class="o">.</span><span class="n">load_auth_from_conf_options</span><span class="p">(</span><span class="n">conf</span><span class="p">,</span> <span class="s2">"gnocchi_credentials"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">gnocchi</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">Client</span><span class="p">(</span><span class="n">session_options</span><span class="o">=</span><span class="p">{</span><span class="s1">'auth'</span><span class="p">:</span> <span class="n">auth_plugin</span><span class="p">})</span>
<span class="gp">>>> </span><span class="n">gnocchi</span><span class="o">.</span><span class="n">resource</span><span class="o">.</span><span class="n">list</span><span class="p">(</span><span class="s2">"generic"</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="reference">
<h2>Reference<a class="headerlink" href="#reference" title="Permalink to this headline">¶</a></h2>
<p>For more information, see the reference:</p>
<div class="toctree-wrapper compound">
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/gnocchi-logo.png" alt="Logo"/>
</a></p>
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">The <code class="docutils literal"><span class="pre">gnocchiclient</span></code> Python API</a><ul>
<li><a class="reference internal" href="#usage">Usage</a></li>
<li><a class="reference internal" href="#reference">Reference</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="shell.html"
title="previous chapter">The <strong class="program">gnocchi</strong> shell utility</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/api.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="shell.html" title="The gnocchi shell utility"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Gnocchiclient 7.0.1 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2018, The Gnocchi Developers.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.7.
</div>
</body>
</html>
|