Skip to content

Commit

Permalink
deploy: a16e6ce
Browse files Browse the repository at this point in the history
  • Loading branch information
@infinityofspace
infinityofspace committed Sep 29, 2024
1 parent a99c73b commit 06e6c3b
Show file tree
Hide file tree
Showing 21 changed files with 1,129 additions and 2,625 deletions.
8 changes: 2 additions & 6 deletions _modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,8 @@
<div class="body" role="main">

<h1>All modules for which code is available</h1>
<ul><li><a href="pkb_client/cli.html">pkb_client.cli</a></li>
<li><a href="pkb_client/client.html">pkb_client.client</a></li>
<li><a href="pkb_client/dns.html">pkb_client.dns</a></li>
<li><a href="pkb_client/domain.html">pkb_client.domain</a></li>
<li><a href="pkb_client/forwarding.html">pkb_client.forwarding</a></li>
<li><a href="pkb_client/ssl_cert.html">pkb_client.ssl_cert</a></li>
<ul><li><a href="pkb_client/client/bind_file.html">pkb_client.client.bind_file</a></li>
<li><a href="pkb_client/client/dns.html">pkb_client.client.dns</a></li>
</ul>

</div>
Expand Down
303 changes: 0 additions & 303 deletions _modules/pkb_client/cli.html
View file

This file was deleted.

850 changes: 0 additions & 850 deletions _modules/pkb_client/client.html
View file

This file was deleted.

272 changes: 272 additions & 0 deletions _modules/pkb_client/client/bind_file.html
View file

Large diffs are not rendered by default.

67 changes: 38 additions & 29 deletions _modules/pkb_client/dns.html → _modules/pkb_client/client/dns.html
View file
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
<!DOCTYPE html>

<html lang="en" data-content_root="../../">
<html lang="en" data-content_root="../../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>pkb_client.dns &#8212; pkb_client v2.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=d1102ebc" />
<link rel="stylesheet" type="text/css" href="../../_static/basic.css?v=c058f7c8" />
<link rel="stylesheet" type="text/css" href="../../_static/alabaster.css?v=27fed22d" />
<script src="../../_static/documentation_options.js?v=aa039f9c"></script>
<script src="../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<title>pkb_client.client.dns &#8212; pkb_client v2.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d1102ebc" />
<link rel="stylesheet" type="text/css" href="../../../_static/basic.css?v=c058f7c8" />
<link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css?v=27fed22d" />
<script src="../../../_static/documentation_options.js?v=aa039f9c"></script>
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />

<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />



Expand All @@ -30,13 +30,14 @@

<div class="body" role="main">

<h1>Source code for pkb_client.dns</h1><div class="highlight"><pre>
<h1>Source code for pkb_client.client.dns</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">dataclasses</span> <span class="kn">import</span> <span class="n">dataclass</span>
<span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Enum</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Optional</span>


<div class="viewcode-block" id="DNSRecordType">
<a class="viewcode-back" href="../../pkb_client.html#pkb_client.dns.DNSRecordType">[docs]</a>
<a class="viewcode-back" href="../../../pkb_client.client.html#pkb_client.client.dns.DNSRecordType">[docs]</a>
<span class="k">class</span> <span class="nc">DNSRecordType</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">Enum</span><span class="p">):</span>
<span class="n">A</span> <span class="o">=</span> <span class="s2">&quot;A&quot;</span>
<span class="n">AAAA</span> <span class="o">=</span> <span class="s2">&quot;AAAA&quot;</span>
Expand All @@ -47,41 +48,49 @@ <h1>Source code for pkb_client.dns</h1><div class="highlight"><pre>
<span class="n">NS</span> <span class="o">=</span> <span class="s2">&quot;NS&quot;</span>
<span class="n">SRV</span> <span class="o">=</span> <span class="s2">&quot;SRV&quot;</span>
<span class="n">TLSA</span> <span class="o">=</span> <span class="s2">&quot;TLSA&quot;</span>
<span class="n">CAA</span> <span class="o">=</span> <span class="s2">&quot;CAA&quot;</span></div>
<span class="n">CAA</span> <span class="o">=</span> <span class="s2">&quot;CAA&quot;</span>

<span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">value</span></div>



<span class="n">DNS_RECORDS_WITH_PRIORITY</span> <span class="o">=</span> <span class="p">{</span><span class="n">DNSRecordType</span><span class="o">.</span><span class="n">MX</span><span class="p">,</span> <span class="n">DNSRecordType</span><span class="o">.</span><span class="n">SRV</span><span class="p">}</span>


<div class="viewcode-block" id="DNSRecord">
<a class="viewcode-back" href="../../pkb_client.html#pkb_client.dns.DNSRecord">[docs]</a>
<a class="viewcode-back" href="../../../pkb_client.client.html#pkb_client.client.dns.DNSRecord">[docs]</a>
<span class="nd">@dataclass</span>
<span class="k">class</span> <span class="nc">DNSRecord</span><span class="p">:</span>
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span>
<span class="n">name</span><span class="p">:</span> <span class="nb">str</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">DNSRecordType</span>
<span class="n">content</span><span class="p">:</span> <span class="nb">str</span>
<span class="n">ttl</span><span class="p">:</span> <span class="nb">str</span>
<span class="n">prio</span><span class="p">:</span> <span class="nb">str</span>
<span class="n">ttl</span><span class="p">:</span> <span class="nb">int</span>
<span class="n">prio</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span>
<span class="n">notes</span><span class="p">:</span> <span class="nb">str</span>

<div class="viewcode-block" id="DNSRecord.from_dict">
<a class="viewcode-back" href="../../pkb_client.html#pkb_client.dns.DNSRecord.from_dict">[docs]</a>
<a class="viewcode-back" href="../../../pkb_client.client.html#pkb_client.client.dns.DNSRecord.from_dict">[docs]</a>
<span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">from_dict</span><span class="p">(</span><span class="n">d</span><span class="p">):</span>
<span class="c1"># only use prio for supported record types since the API returns it for all records with default value 0</span>
<span class="n">prio</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">d</span><span class="p">[</span><span class="s2">&quot;prio&quot;</span><span class="p">])</span> <span class="k">if</span> <span class="n">d</span><span class="p">[</span><span class="s2">&quot;type&quot;</span><span class="p">]</span> <span class="ow">in</span> <span class="n">DNS_RECORDS_WITH_PRIORITY</span> <span class="k">else</span> <span class="kc">None</span>
<span class="k">return</span> <span class="n">DNSRecord</span><span class="p">(</span>
<span class="nb">id</span><span class="o">=</span><span class="n">d</span><span class="p">[</span><span class="s2">&quot;id&quot;</span><span class="p">],</span>
<span class="n">name</span><span class="o">=</span><span class="n">d</span><span class="p">[</span><span class="s2">&quot;name&quot;</span><span class="p">],</span>
<span class="nb">type</span><span class="o">=</span><span class="n">DNSRecordType</span><span class="p">[</span><span class="n">d</span><span class="p">[</span><span class="s2">&quot;type&quot;</span><span class="p">]],</span>
<span class="n">content</span><span class="o">=</span><span class="n">d</span><span class="p">[</span><span class="s2">&quot;content&quot;</span><span class="p">],</span>
<span class="n">ttl</span><span class="o">=</span><span class="n">d</span><span class="p">[</span><span class="s2">&quot;ttl&quot;</span><span class="p">],</span>
<span class="n">prio</span><span class="o">=</span><span class="n">d</span><span class="p">[</span><span class="s2">&quot;prio&quot;</span><span class="p">],</span>
<span class="n">ttl</span><span class="o">=</span><span class="nb">int</span><span class="p">(</span><span class="n">d</span><span class="p">[</span><span class="s2">&quot;ttl&quot;</span><span class="p">]),</span>
<span class="n">prio</span><span class="o">=</span><span class="n">prio</span><span class="p">,</span>
<span class="n">notes</span><span class="o">=</span><span class="n">d</span><span class="p">[</span><span class="s2">&quot;notes&quot;</span><span class="p">],</span>
<span class="p">)</span></div>
</div>



<div class="viewcode-block" id="DNSRestoreMode">
<a class="viewcode-back" href="../../pkb_client.html#pkb_client.dns.DNSRestoreMode">[docs]</a>
<a class="viewcode-back" href="../../../pkb_client.client.html#pkb_client.client.dns.DNSRestoreMode">[docs]</a>
<span class="k">class</span> <span class="nc">DNSRestoreMode</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>
<span class="n">clear</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">replace</span> <span class="o">=</span> <span class="mi">1</span>
Expand All @@ -91,7 +100,7 @@ <h1>Source code for pkb_client.dns</h1><div class="highlight"><pre>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span>

<div class="viewcode-block" id="DNSRestoreMode.from_string">
<a class="viewcode-back" href="../../pkb_client.html#pkb_client.dns.DNSRestoreMode.from_string">[docs]</a>
<a class="viewcode-back" href="../../../pkb_client.client.html#pkb_client.client.dns.DNSRestoreMode.from_string">[docs]</a>
<span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">from_string</span><span class="p">(</span><span class="n">a</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
Expand All @@ -108,7 +117,7 @@ <h1>Source code for pkb_client.dns</h1><div class="highlight"><pre>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">pkb_client</a></h1>
<h1 class="logo"><a href="../../../index.html">pkb_client</a></h1>



Expand All @@ -120,7 +129,7 @@ <h1 class="logo"><a href="../../index.html">pkb_client</a></h1>

<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="Go" />
</form>
Expand All @@ -129,16 +138,16 @@ <h1 class="logo"><a href="../../index.html">pkb_client</a></h1>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../modules.html">pkb_client</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../modules.html">pkb_client</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
<li><a href="../../../index.html">Documentation overview</a><ul>
<li><a href="../../index.html">Module code</a><ul>
</ul></li>
</ul></li>
</ul>
Expand Down
137 changes: 0 additions & 137 deletions _modules/pkb_client/domain.html
View file

This file was deleted.

Loading

0 comments on commit 06e6c3b

Please sign in to comment.