kheops/docs/_build/html/api/kheops.plugin.backend.html

154 lines
7.1 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>kheops.plugin.backend package &#8212; Khéops 0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="kheops.plugin.scope package" href="kheops.plugin.scope.html" />
<link rel="prev" title="kheops.plugin package" href="kheops.plugin.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-kheops.plugin.backend">
<span id="kheops-plugin-backend-package"></span><h1>kheops.plugin.backend package<a class="headerlink" href="#module-kheops.plugin.backend" title="Permalink to this headline"></a></h1>
<p>Backend plugins</p>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</section>
<section id="module-kheops.plugin.backend.file">
<span id="kheops-plugin-backend-file-module"></span><h2>kheops.plugin.backend.file module<a class="headerlink" href="#module-kheops.plugin.backend.file" title="Permalink to this headline"></a></h2>
<p>File Backend Code</p>
<dl class="py class">
<dt class="sig sig-object py" id="kheops.plugin.backend.file.Plugin">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kheops.plugin.backend.file.</span></span><span class="sig-name descname"><span class="pre">Plugin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kheops.plugin.backend.file.Plugin" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="kheops.plugin.html#kheops.plugin.common.BackendPlugin" title="kheops.plugin.common.BackendPlugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">kheops.plugin.common.BackendPlugin</span></code></a></p>
<p>Generic Plugin Class</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="kheops.plugin.backend.file.Plugin.extensions">
<span class="sig-name descname"><span class="pre">extensions</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'.yaml':</span> <span class="pre">'yaml',</span> <span class="pre">'.yml':</span> <span class="pre">'yaml'}</span></em><a class="headerlink" href="#kheops.plugin.backend.file.Plugin.extensions" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kheops.plugin.backend.file.Plugin.fetch_data">
<span class="sig-name descname"><span class="pre">fetch_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#kheops.plugin.backend.file.Plugin.fetch_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">Khéops</a></h1>
<h3>Navigation</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../docs/app/index.html">Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../docs/learn/index.html">Learn</a></li>
<li class="toctree-l1"><a class="reference internal" href="../docs/guide/index.html">Guides</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">Python API</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="kheops.html">kheops package</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="kheops.html#subpackages">Subpackages</a></li>
<li class="toctree-l3"><a class="reference internal" href="kheops.html#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="kheops.html#module-kheops.app">kheops.app module</a></li>
<li class="toctree-l3"><a class="reference internal" href="kheops.html#module-kheops.cli">kheops.cli module</a></li>
<li class="toctree-l3"><a class="reference internal" href="kheops.html#module-kheops.controllers">kheops.controllers module</a></li>
<li class="toctree-l3"><a class="reference internal" href="kheops.html#module-kheops.utils">kheops.utils module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li><a href="modules.html">kheops</a><ul>
<li><a href="kheops.html">kheops package</a><ul>
<li><a href="kheops.plugin.html">kheops.plugin package</a><ul>
<li>Previous: <a href="kheops.plugin.html" title="previous chapter">kheops.plugin package</a></li>
<li>Next: <a href="kheops.plugin.scope.html" title="next chapter">kheops.plugin.scope package</a></li>
</ul></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2022, Barbu IT.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="../_sources/api/kheops.plugin.backend.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>