Deployed ca1a9aa with MkDocs version: 1.5.3

hotosm · Dec 20, 2023 · 724f6e6 · 724f6e6
1 parent 49cf241
commit 724f6e6
Show file tree

Hide file tree

Showing 5 changed files with 219 additions and 53 deletions.
diff --git a/api/index.html b/api/index.html
@@ -1055,6 +1055,19 @@
     OrganizationsDB
   </a>
 
+    <nav class="md-nav" aria-label="OrganizationsDB">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#tm_admin.organizations.organizations.OrganizationsDB.getByName" class="md-nav__link">
+    getByName()
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
 </li>
 
         <li class="md-nav__item">
@@ -1720,6 +1733,19 @@
     OrganizationsDB
   </a>
 
+    <nav class="md-nav" aria-label="OrganizationsDB">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#tm_admin.organizations.organizations.OrganizationsDB.getByName" class="md-nav__link">
+    getByName()
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
 </li>
 
         <li class="md-nav__item">
@@ -3514,7 +3540,7 @@ <h3 id="tm_admin.dbsupport.DBSupport.getByWhere" class="doc doc-heading">
 <span class="sd">        (list): The results of the query</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">sql</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;SELECT * FROM </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="si">}</span><span class="s2"> WHERE </span><span class="si">{</span><span class="n">where</span><span class="si">}</span><span class="s2">&quot;</span>
-    <span class="c1"># print(sql)</span>
+    <span class="nb">print</span><span class="p">(</span><span class="n">sql</span><span class="p">)</span>
     <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">pg</span><span class="o">.</span><span class="n">dbcursor</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">sql</span><span class="p">)</span>
     <span class="n">data</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
     <span class="n">entry</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">pg</span><span class="o">.</span><span class="n">dbcursor</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
@@ -7497,10 +7523,7 @@ <h2 id="tm_admin.projects.projects.ProjectsDB" class="doc doc-heading">
 
                 <details class="quote">
                   <summary>Source code in <code>tm_admin/projects/projects.py</code></summary>
-                  <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">42</span>
-<span class="normal">43</span>
-<span class="normal">44</span>
-<span class="normal">45</span>
+                  <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">45</span>
 <span class="normal">46</span>
 <span class="normal">47</span>
 <span class="normal">48</span>
@@ -7512,7 +7535,10 @@ <h2 id="tm_admin.projects.projects.ProjectsDB" class="doc doc-heading">
 <span class="normal">54</span>
 <span class="normal">55</span>
 <span class="normal">56</span>
-<span class="normal">57</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
+<span class="normal">57</span>
+<span class="normal">58</span>
+<span class="normal">59</span>
+<span class="normal">60</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
              <span class="n">dburi</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;localhost/tm_admin&quot;</span><span class="p">,</span>
             <span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
@@ -7572,10 +7598,7 @@ <h2 id="tm_admin.projects.projects.main" class="doc doc-heading">
 
           <details class="quote">
             <summary>Source code in <code>tm_admin/projects/projects.py</code></summary>
-            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 59</span>
-<span class="normal"> 60</span>
-<span class="normal"> 61</span>
-<span class="normal"> 62</span>
+            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 62</span>
 <span class="normal"> 63</span>
 <span class="normal"> 64</span>
 <span class="normal"> 65</span>
@@ -7613,7 +7636,16 @@ <h2 id="tm_admin.projects.projects.main" class="doc doc-heading">
 <span class="normal"> 97</span>
 <span class="normal"> 98</span>
 <span class="normal"> 99</span>
-<span class="normal">100</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">main</span><span class="p">():</span>
+<span class="normal">100</span>
+<span class="normal">101</span>
+<span class="normal">102</span>
+<span class="normal">103</span>
+<span class="normal">104</span>
+<span class="normal">105</span>
+<span class="normal">106</span>
+<span class="normal">107</span>
+<span class="normal">108</span>
+<span class="normal">109</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">main</span><span class="p">():</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;This main function lets this class be run standalone by a bash script.&quot;&quot;&quot;</span>
     <span class="n">parser</span> <span class="o">=</span> <span class="n">argparse</span><span class="o">.</span><span class="n">ArgumentParser</span><span class="p">()</span>
     <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;-v&quot;</span><span class="p">,</span> <span class="s2">&quot;--verbose&quot;</span><span class="p">,</span> <span class="n">nargs</span><span class="o">=</span><span class="s2">&quot;?&quot;</span><span class="p">,</span> <span class="n">const</span><span class="o">=</span><span class="s2">&quot;0&quot;</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;verbose output&quot;</span><span class="p">)</span>
@@ -7641,6 +7673,12 @@ <h2 id="tm_admin.projects.projects.main" class="doc doc-heading">
         <span class="n">stream</span><span class="o">=</span><span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span>
     <span class="p">)</span>
 
+    <span class="n">gen</span> <span class="o">=</span> <span class="n">Generator</span><span class="p">()</span>
+    <span class="n">x</span> <span class="o">=</span> <span class="n">gen</span><span class="o">.</span><span class="n">readConfig</span><span class="p">(</span><span class="s2">&quot;projects/projects.yaml&quot;</span><span class="p">)</span>
+    <span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="n">gen</span><span class="o">.</span><span class="n">yaml</span><span class="o">.</span><span class="n">yaml</span><span class="p">:</span>
+        <span class="nb">print</span><span class="p">(</span><span class="n">entry</span><span class="p">)</span>
+    <span class="n">quit</span><span class="p">()</span>
+
     <span class="n">proj</span> <span class="o">=</span> <span class="n">ProjectsDB</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">uri</span><span class="p">)</span>
     <span class="c1"># user.resetSequence()</span>
     <span class="nb">all</span> <span class="o">=</span> <span class="n">proj</span><span class="o">.</span><span class="n">getAll</span><span class="p">()</span>
@@ -7813,31 +7851,77 @@ <h2 id="tm_admin.organizations.organizations.OrganizationsDB" class="doc doc-hea
 
 
 
+<div class="doc doc-object doc-function">
 
-  </div>
 
-  </div>
 
-</div>
 
+<h3 id="tm_admin.organizations.organizations.OrganizationsDB.getByName" class="doc doc-heading">
+          <span class="doc doc-object-name doc-function-name">getByName</span>
 
 
-<div class="doc doc-object doc-function">
+<a href="#tm_admin.organizations.organizations.OrganizationsDB.getByName" class="headerlink" title="Permanent link">&para;</a></h3>
+<div class="doc-signature highlight"><pre><span></span><code><span class="n">getByName</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
+</code></pre></div>
 
+  <div class="doc doc-contents ">
+
+      <p>Return the data for the name in the table. This overrides the version
+in the base class.</p>
 
 
 
-<h2 id="tm_admin.organizations.organizations.main" class="doc doc-heading">
-          <span class="doc doc-object-name doc-function-name">main</span>
+  <p><strong>Parameters:</strong></p>
+  <table>
+    <thead>
+      <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th>Description</th>
+        <th>Default</th>
+      </tr>
+    </thead>
+    <tbody>
+        <tr>
+          <td><code>name</code></td>
+          <td>
+                <code>str</code>
+          </td>
+          <td>
+            <div class="doc-md-description">
+              <p>The name of the dataset to retrieve.</p>
+            </div>
+          </td>
+          <td>
+              <em>required</em>
+          </td>
+        </tr>
+    </tbody>
+  </table>
 
 
-<a href="#tm_admin.organizations.organizations.main" class="headerlink" title="Permanent link">&para;</a></h2>
-<div class="doc-signature highlight"><pre><span></span><code><span class="n">main</span><span class="p">()</span>
-</code></pre></div>
 
-  <div class="doc doc-contents ">
-
-      <p>This main function lets this class be run standalone by a bash script.</p>
+  <p><strong>Returns:</strong></p>
+  <table>
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+        <tr>
+          <td>
+                <code>list</code>
+          </td>
+          <td>
+            <div class="doc-md-description">
+              <p>The results of the query</p>
+            </div>
+          </td>
+        </tr>
+    </tbody>
+  </table>
 
           <details class="quote">
             <summary>Source code in <code>tm_admin/organizations/organizations.py</code></summary>
@@ -7864,21 +7948,103 @@ <h2 id="tm_admin.organizations.organizations.main" class="doc doc-heading">
 <span class="normal">75</span>
 <span class="normal">76</span>
 <span class="normal">77</span>
-<span class="normal">78</span>
-<span class="normal">79</span>
-<span class="normal">80</span>
-<span class="normal">81</span>
-<span class="normal">82</span>
-<span class="normal">83</span>
-<span class="normal">84</span>
-<span class="normal">85</span>
-<span class="normal">86</span>
-<span class="normal">87</span>
-<span class="normal">88</span>
-<span class="normal">89</span>
-<span class="normal">90</span>
-<span class="normal">91</span>
-<span class="normal">92</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">main</span><span class="p">():</span>
+<span class="normal">78</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">getByName</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
+            <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+            <span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Return the data for the name in the table. This overrides the version</span>
+<span class="sd">    in the base class.</span>
+
+<span class="sd">    Args:</span>
+<span class="sd">        name (str): The name of the dataset to retrieve.</span>
+
+<span class="sd">    Returns:</span>
+<span class="sd">        (list): The results of the query</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">sql</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;SELECT * FROM </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="si">}</span><span class="s2"> WHERE name=&#39;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">&#39; LIMIT 1&quot;</span>
+    <span class="bp">self</span><span class="o">.</span><span class="n">pg</span><span class="o">.</span><span class="n">dbcursor</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">sql</span><span class="p">)</span>
+    <span class="n">data</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
+    <span class="n">entry</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">pg</span><span class="o">.</span><span class="n">dbcursor</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
+    <span class="k">for</span> <span class="n">column</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">profile</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+        <span class="n">index</span> <span class="o">=</span> <span class="mi">0</span>
+        <span class="k">for</span> <span class="n">column</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">profile</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+            <span class="n">data</span><span class="p">[</span><span class="n">column</span><span class="p">]</span> <span class="o">=</span> <span class="n">entry</span><span class="p">[</span><span class="n">index</span><span class="p">]</span>
+            <span class="n">index</span> <span class="o">+=</span> <span class="mi">1</span>
+
+    <span class="k">return</span> <span class="p">[</span><span class="n">data</span><span class="p">]</span>
+</code></pre></div></td></tr></table></div>
+          </details>
+  </div>
+
+</div>
+
+
+
+  </div>
+
+  </div>
+
+</div>
+
+
+
+<div class="doc doc-object doc-function">
+
+
+
+
+<h2 id="tm_admin.organizations.organizations.main" class="doc doc-heading">
+          <span class="doc doc-object-name doc-function-name">main</span>
+
+
+<a href="#tm_admin.organizations.organizations.main" class="headerlink" title="Permanent link">&para;</a></h2>
+<div class="doc-signature highlight"><pre><span></span><code><span class="n">main</span><span class="p">()</span>
+</code></pre></div>
+
+  <div class="doc doc-contents ">
+
+      <p>This main function lets this class be run standalone by a bash script.</p>
+
+          <details class="quote">
+            <summary>Source code in <code>tm_admin/organizations/organizations.py</code></summary>
+            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 80</span>
+<span class="normal"> 81</span>
+<span class="normal"> 82</span>
+<span class="normal"> 83</span>
+<span class="normal"> 84</span>
+<span class="normal"> 85</span>
+<span class="normal"> 86</span>
+<span class="normal"> 87</span>
+<span class="normal"> 88</span>
+<span class="normal"> 89</span>
+<span class="normal"> 90</span>
+<span class="normal"> 91</span>
+<span class="normal"> 92</span>
+<span class="normal"> 93</span>
+<span class="normal"> 94</span>
+<span class="normal"> 95</span>
+<span class="normal"> 96</span>
+<span class="normal"> 97</span>
+<span class="normal"> 98</span>
+<span class="normal"> 99</span>
+<span class="normal">100</span>
+<span class="normal">101</span>
+<span class="normal">102</span>
+<span class="normal">103</span>
+<span class="normal">104</span>
+<span class="normal">105</span>
+<span class="normal">106</span>
+<span class="normal">107</span>
+<span class="normal">108</span>
+<span class="normal">109</span>
+<span class="normal">110</span>
+<span class="normal">111</span>
+<span class="normal">112</span>
+<span class="normal">113</span>
+<span class="normal">114</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">main</span><span class="p">():</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;This main function lets this class be run standalone by a bash script.&quot;&quot;&quot;</span>
     <span class="n">parser</span> <span class="o">=</span> <span class="n">argparse</span><span class="o">.</span><span class="n">ArgumentParser</span><span class="p">()</span>
     <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;-v&quot;</span><span class="p">,</span> <span class="s2">&quot;--verbose&quot;</span><span class="p">,</span> <span class="n">nargs</span><span class="o">=</span><span class="s2">&quot;?&quot;</span><span class="p">,</span> <span class="n">const</span><span class="o">=</span><span class="s2">&quot;0&quot;</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;verbose output&quot;</span><span class="p">)</span>

diff --git a/objects.inv b/objects.inv
diff --git a/search/search_index.json b/search/search_index.json