Skip to content

Commit

Permalink
Deploying to gh-pages from @ 20ccd0a 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
glass-ships committed Nov 22, 2023
1 parent d1627fc commit 58b33e6
Showing 14 changed files with 157 additions and 86 deletions.
6 changes: 3 additions & 3 deletions docs/404.html
Original file line number Diff line number Diff line change
@@ -12,15 +12,15 @@


<link rel="icon" href="/images/favicon.ico">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.8">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.10">



<title>Koza Documentation</title>



<link rel="stylesheet" href="/assets/stylesheets/main.4b4a2bd9.min.css">
<link rel="stylesheet" href="/assets/stylesheets/main.fad675c6.min.css">


<link rel="stylesheet" href="/assets/stylesheets/palette.356b1318.min.css">
@@ -481,7 +481,7 @@ <h1>404 - Not found</h1>
<script id="__config" type="application/json">{"base": "/", "features": ["content.code.copy", "navigation.expand", "navigation.instant", "navigation.tracking", "navigation.tabs", "navigation.tabs.sticky"], "search": "/assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="/assets/javascripts/bundle.81fa17fe.min.js"></script>
<script src="/assets/javascripts/bundle.6c14ae12.min.js"></script>


</body>
78 changes: 51 additions & 27 deletions docs/Usage/API/index.html
Original file line number Diff line number Diff line change
@@ -16,15 +16,15 @@


<link rel="icon" href="../../images/favicon.ico">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.8">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.10">



<title>API - Koza Documentation</title>



<link rel="stylesheet" href="../../assets/stylesheets/main.4b4a2bd9.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.fad675c6.min.css">


<link rel="stylesheet" href="../../assets/stylesheets/palette.356b1318.min.css">
@@ -431,35 +431,45 @@

<li class="md-nav__item">
<a href="#src.koza.cli_runner.get_koza_app" class="md-nav__link">
get_koza_app()
<span class="md-ellipsis">
get_koza_app()
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#src.koza.cli_runner.get_translation_table" class="md-nav__link">
get_translation_table()
<span class="md-ellipsis">
get_translation_table()
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#src.koza.cli_runner.test_koza" class="md-nav__link">
test_koza()
<span class="md-ellipsis">
test_koza()
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#src.koza.cli_runner.transform_source" class="md-nav__link">
transform_source()
<span class="md-ellipsis">
transform_source()
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#src.koza.cli_runner.validate_file" class="md-nav__link">
validate_file()
<span class="md-ellipsis">
validate_file()
</span>
</a>

</li>
@@ -498,35 +508,45 @@

<li class="md-nav__item">
<a href="#src.koza.cli_runner.get_koza_app" class="md-nav__link">
get_koza_app()
<span class="md-ellipsis">
get_koza_app()
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#src.koza.cli_runner.get_translation_table" class="md-nav__link">
get_translation_table()
<span class="md-ellipsis">
get_translation_table()
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#src.koza.cli_runner.test_koza" class="md-nav__link">
test_koza()
<span class="md-ellipsis">
test_koza()
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#src.koza.cli_runner.transform_source" class="md-nav__link">
transform_source()
<span class="md-ellipsis">
transform_source()
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#src.koza.cli_runner.validate_file" class="md-nav__link">
validate_file()
<span class="md-ellipsis">
validate_file()
</span>
</a>

</li>
@@ -731,9 +751,7 @@ <h2 id="src.koza.cli_runner.get_translation_table" class="doc doc-heading">

<details class="quote">
<summary>Source code in <code>src/koza/cli_runner.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">118</span>
<span class="normal">119</span>
<span class="normal">120</span>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">120</span>
<span class="normal">121</span>
<span class="normal">122</span>
<span class="normal">123</span>
@@ -771,7 +789,9 @@ <h2 id="src.koza.cli_runner.get_translation_table" class="doc doc-heading">
<span class="normal">155</span>
<span class="normal">156</span>
<span class="normal">157</span>
<span class="normal">158</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">get_translation_table</span><span class="p">(</span>
<span class="normal">158</span>
<span class="normal">159</span>
<span class="normal">160</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">get_translation_table</span><span class="p">(</span>
<span class="n">global_table</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Dict</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">local_table</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Dict</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">logger</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
@@ -836,10 +856,10 @@ <h2 id="src.koza.cli_runner.test_koza" class="doc doc-heading">

<details class="quote">
<summary>Source code in <code>src/koza/cli_runner.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">176</span>
<span class="normal">177</span>
<span class="normal">178</span>
<span class="normal">179</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">test_koza</span><span class="p">(</span><span class="n">koza</span><span class="p">:</span> <span class="n">KozaApp</span><span class="p">):</span>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">180</span>
<span class="normal">181</span>
<span class="normal">182</span>
<span class="normal">183</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">test_koza</span><span class="p">(</span><span class="n">koza</span><span class="p">:</span> <span class="n">KozaApp</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Manually sets KozaApp (for testing)&quot;&quot;&quot;</span>
<span class="k">global</span> <span class="n">koza_app</span>
<span class="n">koza_app</span> <span class="o">=</span> <span class="n">koza</span>
@@ -1055,13 +1075,17 @@ <h2 id="src.koza.cli_runner.transform_source" class="doc doc-heading">
<span class="normal">79</span>
<span class="normal">80</span>
<span class="normal">81</span>
<span class="normal">82</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">transform_source</span><span class="p">(</span>
<span class="normal">82</span>
<span class="normal">83</span>
<span class="normal">84</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">transform_source</span><span class="p">(</span>
<span class="n">source</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="n">output_dir</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="n">output_format</span><span class="p">:</span> <span class="n">OutputFormat</span> <span class="o">=</span> <span class="n">OutputFormat</span><span class="p">(</span><span class="s1">&#39;tsv&#39;</span><span class="p">),</span>
<span class="n">global_table</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">local_table</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">schema</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">node_type</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">edge_type</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">row_limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">verbose</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">log</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
@@ -1099,7 +1123,7 @@ <h2 id="src.koza.cli_runner.transform_source" class="doc doc-heading">
<span class="n">logger</span><span class="p">,</span>
<span class="p">)</span>

<span class="n">koza_app</span> <span class="o">=</span> <span class="n">_set_koza_app</span><span class="p">(</span><span class="n">koza_source</span><span class="p">,</span> <span class="n">translation_table</span><span class="p">,</span> <span class="n">output_dir</span><span class="p">,</span> <span class="n">output_format</span><span class="p">,</span> <span class="n">schema</span><span class="p">,</span> <span class="n">logger</span><span class="p">)</span>
<span class="n">koza_app</span> <span class="o">=</span> <span class="n">_set_koza_app</span><span class="p">(</span><span class="n">koza_source</span><span class="p">,</span> <span class="n">translation_table</span><span class="p">,</span> <span class="n">output_dir</span><span class="p">,</span> <span class="n">output_format</span><span class="p">,</span> <span class="n">schema</span><span class="p">,</span> <span class="n">node_type</span><span class="p">,</span> <span class="n">edge_type</span><span class="p">,</span> <span class="n">logger</span><span class="p">)</span>
<span class="n">koza_app</span><span class="o">.</span><span class="n">process_maps</span><span class="p">()</span>
<span class="n">koza_app</span><span class="o">.</span><span class="n">process_sources</span><span class="p">()</span>
</code></pre></div></td></tr></table></div>
@@ -1128,9 +1152,7 @@ <h2 id="src.koza.cli_runner.validate_file" class="doc doc-heading">

<details class="quote">
<summary>Source code in <code>src/koza/cli_runner.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 85</span>
<span class="normal"> 86</span>
<span class="normal"> 87</span>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 87</span>
<span class="normal"> 88</span>
<span class="normal"> 89</span>
<span class="normal"> 90</span>
@@ -1158,7 +1180,9 @@ <h2 id="src.koza.cli_runner.validate_file" class="doc doc-heading">
<span class="normal">112</span>
<span class="normal">113</span>
<span class="normal">114</span>
<span class="normal">115</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">validate_file</span><span class="p">(</span>
<span class="normal">115</span>
<span class="normal">116</span>
<span class="normal">117</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">validate_file</span><span class="p">(</span>
<span class="n">file</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="nb">format</span><span class="p">:</span> <span class="n">FormatType</span> <span class="o">=</span> <span class="n">FormatType</span><span class="o">.</span><span class="n">csv</span><span class="p">,</span>
<span class="n">delimiter</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;,&#39;</span><span class="p">,</span>
@@ -1269,7 +1293,7 @@ <h2 id="src.koza.cli_runner.validate_file" class="doc doc-heading">
<script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "navigation.expand", "navigation.instant", "navigation.tracking", "navigation.tabs", "navigation.tabs.sticky"], "search": "../../assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../../assets/javascripts/bundle.81fa17fe.min.js"></script>
<script src="../../assets/javascripts/bundle.6c14ae12.min.js"></script>


</body>
22 changes: 15 additions & 7 deletions docs/Usage/CLI/index.html
Original file line number Diff line number Diff line change
@@ -18,15 +18,15 @@


<link rel="icon" href="../../images/favicon.ico">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.8">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.10">



<title>CLI - Koza Documentation</title>



<link rel="stylesheet" href="../../assets/stylesheets/main.4b4a2bd9.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.fad675c6.min.css">


<link rel="stylesheet" href="../../assets/stylesheets/palette.356b1318.min.css">
@@ -418,14 +418,18 @@

<li class="md-nav__item">
<a href="#koza-transform" class="md-nav__link">
koza transform
<span class="md-ellipsis">
koza transform
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#koza-validate" class="md-nav__link">
koza validate
<span class="md-ellipsis">
koza validate
</span>
</a>

</li>
@@ -485,14 +489,18 @@

<li class="md-nav__item">
<a href="#koza-transform" class="md-nav__link">
koza transform
<span class="md-ellipsis">
koza transform
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#koza-validate" class="md-nav__link">
koza validate
<span class="md-ellipsis">
koza validate
</span>
</a>

</li>
@@ -630,7 +638,7 @@ <h2 id="koza-validate"><code>koza validate</code></h2>
<script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "navigation.expand", "navigation.instant", "navigation.tracking", "navigation.tabs", "navigation.tabs.sticky"], "search": "../../assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../../assets/javascripts/bundle.81fa17fe.min.js"></script>
<script src="../../assets/javascripts/bundle.6c14ae12.min.js"></script>


</body>
Loading

0 comments on commit 58b33e6

Please sign in to comment.