Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@ross-spencer
ross-spencer committed Nov 19, 2024
1 parent 4e55e8f commit 165170f
Show file tree
Hide file tree
Showing 7 changed files with 586 additions and 18 deletions.
4 changes: 2 additions & 2 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ <h1 class="title">Namespace <code>src</code></h1>
<section>
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
<dl>
<dt><code class="name"><a title="src.template" href="template/index.html">src.template</a></code></dt>
<dt><code class="name"><a title="src.itn_api" href="itn_api/index.html">src.itn_api</a></code></dt>
<dd>
<div class="desc"><p>Package level init.</p></div>
</dd>
Expand All @@ -49,7 +49,7 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
<ul id="index">
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
<ul>
<li><code><a title="src.template" href="template/index.html">src.template</a></code></li>
<li><code><a title="src.itn_api" href="itn_api/index.html">src.itn_api</a></code></li>
</ul>
</li>
</ul>
Expand Down
162 changes: 162 additions & 0 deletions docs/itn_api/api.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
<meta name="generator" content="pdoc3 0.11.1">
<title>src.itn_api.api API documentation</title>
<meta name="description" content="ITN Validator API …">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => {
hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
hljs.highlightAll();
})</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>src.itn_api.api</code></h1>
</header>
<section id="section-intro">
<p>ITN Validator API.</p>
<p>Output stats from the Orcfax Validator Database in order to report on
the ITN output.</p>
<pre><code>`uvicorn src.itn_api.api:app --reload`
</code></pre>
<p>The database for this app is configured by the DATABASE_PATH environment
variable.</p>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="src.itn_api.api.get_active_participants"><code class="name flex">
<span>async def <span class="ident">get_active_participants</span></span>(<span>)</span>
</code></dt>
<dd>
<div class="desc"><p>Return participants in the ITN database.</p></div>
</dd>
<dt id="src.itn_api.api.get_date_range"><code class="name flex">
<span>async def <span class="ident">get_date_range</span></span>(<span>)</span>
</code></dt>
<dd>
<div class="desc"><p>Return the date range of all statistics.</p></div>
</dd>
<dt id="src.itn_api.api.get_itn_aliases_and_staking"><code class="name flex">
<span>async def <span class="ident">get_itn_aliases_and_staking</span></span>(<span>min_stake: int = 500000, license_no: str = None) ‑> dict</span>
</code></dt>
<dd>
<div class="desc"><p>Return ITN aliases and stake values.</p>
<p>Optionally: enter a license number, e.g. <code>#001</code> to see the details
of a specific license.</p></div>
</dd>
<dt id="src.itn_api.api.get_itn_aliases_and_staking_csv"><code class="name flex">
<span>async def <span class="ident">get_itn_aliases_and_staking_csv</span></span>(<span>min_stake: int = 500000, sort: str = 'stake') ‑> str</span>
</code></dt>
<dd>
<div class="desc"><p>Return ITN aliases and stake values.</p>
<p>Optionally: enter a license number, e.g. <code>#001</code> to see the details
of a specific license.</p></div>
</dd>
<dt id="src.itn_api.api.get_itn_participants"><code class="name flex">
<span>async def <span class="ident">get_itn_participants</span></span>(<span>) ‑> str</span>
</code></dt>
<dd>
<div class="desc"><p>Return ITN aliases and stake values.</p>
<p>Optionally: enter a license number, e.g. <code>#001</code> to see the details
of a specific license.</p></div>
</dd>
<dt id="src.itn_api.api.get_online_collectors"><code class="name flex">
<span>async def <span class="ident">get_online_collectors</span></span>(<span>) ‑> str</span>
</code></dt>
<dd>
<div class="desc"><p>Return ITN aliases and stake values.</p>
<p>Optionally: enter a license number, e.g. <code>#001</code> to see the details
of a specific license.</p></div>
</dd>
<dt id="src.itn_api.api.get_participants_counts_day"><code class="name flex">
<span>async def <span class="ident">get_participants_counts_day</span></span>(<span>date_start: str = '1970-01-01', date_end: str = '1970-01-03')</span>
</code></dt>
<dd>
<div class="desc"><p>Return participants in ITN.</p></div>
</dd>
<dt id="src.itn_api.api.get_participants_counts_day_csv"><code class="name flex">
<span>async def <span class="ident">get_participants_counts_day_csv</span></span>(<span>date_start: str = '1970-01-01', date_end: str = '1970-01-03') ‑> str</span>
</code></dt>
<dd>
<div class="desc"><p>Return participants in ITN.</p></div>
</dd>
<dt id="src.itn_api.api.get_participants_counts_total"><code class="name flex">
<span>async def <span class="ident">get_participants_counts_total</span></span>(<span>)</span>
</code></dt>
<dd>
<div class="desc"><p>Return participants total counts.</p></div>
</dd>
<dt id="src.itn_api.api.lifespan"><code class="name flex">
<span>async def <span class="ident">lifespan</span></span>(<span>app: fastapi.applications.FastAPI)</span>
</code></dt>
<dd>
<div class="desc"><p>Load the database connection for the life of the app.s</p></div>
</dd>
<dt id="src.itn_api.api.main"><code class="name flex">
<span>def <span class="ident">main</span></span>(<span>)</span>
</code></dt>
<dd>
<div class="desc"><p>Primary entry point for this script.</p></div>
</dd>
<dt id="src.itn_api.api.redirect_root_to_docs"><code class="name flex">
<span>def <span class="ident">redirect_root_to_docs</span></span>(<span>)</span>
</code></dt>
<dd>
<div class="desc"><p>Redirect a user calling the API root '/' to the API
documentation.</p></div>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="src.itn_api" href="index.html">src.itn_api</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="src.itn_api.api.get_active_participants" href="#src.itn_api.api.get_active_participants">get_active_participants</a></code></li>
<li><code><a title="src.itn_api.api.get_date_range" href="#src.itn_api.api.get_date_range">get_date_range</a></code></li>
<li><code><a title="src.itn_api.api.get_itn_aliases_and_staking" href="#src.itn_api.api.get_itn_aliases_and_staking">get_itn_aliases_and_staking</a></code></li>
<li><code><a title="src.itn_api.api.get_itn_aliases_and_staking_csv" href="#src.itn_api.api.get_itn_aliases_and_staking_csv">get_itn_aliases_and_staking_csv</a></code></li>
<li><code><a title="src.itn_api.api.get_itn_participants" href="#src.itn_api.api.get_itn_participants">get_itn_participants</a></code></li>
<li><code><a title="src.itn_api.api.get_online_collectors" href="#src.itn_api.api.get_online_collectors">get_online_collectors</a></code></li>
<li><code><a title="src.itn_api.api.get_participants_counts_day" href="#src.itn_api.api.get_participants_counts_day">get_participants_counts_day</a></code></li>
<li><code><a title="src.itn_api.api.get_participants_counts_day_csv" href="#src.itn_api.api.get_participants_counts_day_csv">get_participants_counts_day_csv</a></code></li>
<li><code><a title="src.itn_api.api.get_participants_counts_total" href="#src.itn_api.api.get_participants_counts_total">get_participants_counts_total</a></code></li>
<li><code><a title="src.itn_api.api.lifespan" href="#src.itn_api.api.lifespan">lifespan</a></code></li>
<li><code><a title="src.itn_api.api.main" href="#src.itn_api.api.main">main</a></code></li>
<li><code><a title="src.itn_api.api.redirect_root_to_docs" href="#src.itn_api.api.redirect_root_to_docs">redirect_root_to_docs</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
</footer>
</body>
</html>
Loading

0 comments on commit 165170f

Please sign in to comment.