documentation and bug fix in demos

README.md

@@ -1,6 +1,14 @@
 BLUMYCELIUM: Async micro-services, 100% in python from Bluwr
 ============================================================
 
+This tool os provided for free by [bluwr.com](https://bluwr.com). We are building a 100% text based publication platform. A calm space free of any addictive feature.
+
+Here are a few things that you can do to support us:
+ - Register for early access on [bluwr.com](https://bluwr.com)
+ - Buy some awesoms merch on our [store](https://store.bluwr.com)
+ - Follow us on social media [instagram](https://www.instagram.com/bluwr_official/), [twitter](https://twitter.com/bluwr_official), [linkedin](https://www.linkedin.com/company/bluwr)
+
+
 **Machine Elf <- Mycelium -> Machine Elf**
 
 PLEASE NOTE: This documentation is a work in progress

blumycelium/docs/_build/html/_modules/blumycelium/graph_parameters.html

@@ -45,6 +45,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../machine_elf.html">Machine Elf</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../utils.html">Utils</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../exceptions.html">Exceptions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../async.html">Async demo</a></li>
 </ul>
 
         </div>
@@ -468,9 +469,7 @@ <h1>Source code for blumycelium.graph_parameters</h1><div class="highlight"><pre
 <span class="s2">            dct[key]=value</span>
 <span class="s2">            return dct&quot;&quot;&quot;</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
         <span class="n">return_statement</span> <span class="o">=</span> <span class="s2">&quot;add(</span><span class="si">{self_param}</span><span class="s2">, </span><span class="si">{key}</span><span class="s2">, </span><span class="si">{value}</span><span class="s2">)&quot;</span>
-
-        <span class="n">code</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">{self_param}</span><span class="s2">[</span><span class="si">{key}</span><span class="s2">]=</span><span class="si">{value}</span><span class="s2">&quot;</span>
-
+
         <span class="n">key_param</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_parameter</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
         <span class="n">value_param</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_parameter</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
 
@@ -654,9 +653,6 @@ <h1>Source code for blumycelium.graph_parameters</h1><div class="highlight"><pre
         <span class="k">return</span> <span class="n">unravel_dict</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
     <span class="k">else</span><span class="p">:</span>
         <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;Wrong type: &#39;</span><span class="si">%s</span><span class="s2">&#39;, except list or dict&quot;</span> <span class="o">%</span> <span class="nb">type</span><span class="p">(</span><span class="n">obj</span><span class="p">))</span>
-
-<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">&#39;__main__&#39;</span><span class="p">:</span>
-    <span class="n">test_rebuild_from_traversal</span><span class="p">()</span>
 </pre></div>
 
            </div>

blumycelium/docs/_build/html/_modules/blumycelium/machine_elf.html

@@ -45,6 +45,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../machine_elf.html">Machine Elf</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../utils.html">Utils</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../exceptions.html">Exceptions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../async.html">Async demo</a></li>
 </ul>
 
         </div>
@@ -75,9 +76,10 @@ <h1>Source code for blumycelium.machine_elf</h1><div class="highlight"><pre>
 <span></span><span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">utils</span> <span class="k">as</span> <span class="n">ut</span>
 <span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">custom_types</span>
 <span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">graph_parameters</span> <span class="k">as</span> <span class="n">gp</span>
-
 <span class="kn">from</span> <span class="nn">.the_exceptions</span> <span class="kn">import</span> <span class="o">*</span>
 
+<span class="kn">from</span> <span class="nn">.import</span> <span class="o">*</span>
+
 <span class="kn">from</span> <span class="nn">icecream</span> <span class="kn">import</span> <span class="n">ic</span>
 
 <div class="viewcode-block" id="ValuePlaceholder"><a class="viewcode-back" href="../../machine_elf.html#blumycelium.machine_elf.ValuePlaceholder">[docs]</a><span class="k">class</span> <span class="nc">ValuePlaceholder</span><span class="p">(</span><span class="n">gp</span><span class="o">.</span><span class="n">Value</span><span class="p">):</span>
@@ -439,8 +441,12 @@ <h1>Source code for blumycelium.machine_elf</h1><div class="highlight"><pre>
         <span class="k">for</span> <span class="n">job</span> <span class="ow">in</span> <span class="n">jobs</span><span class="p">:</span>
             <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">mycelium</span><span class="o">.</span><span class="n">is_job_ready</span><span class="p">(</span><span class="n">job</span><span class="p">[</span><span class="s2">&quot;id&quot;</span><span class="p">])</span> <span class="p">:</span>
                 <span class="n">params</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">mycelium</span><span class="o">.</span><span class="n">get_job_parameters</span><span class="p">(</span><span class="n">job</span><span class="p">[</span><span class="s2">&quot;id&quot;</span><span class="p">])</span>
-                <span class="n">params</span> <span class="o">=</span> <span class="n">TaskParameters</span><span class="o">.</span><span class="n">develop</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">mycelium</span><span class="p">,</span> <span class="n">params</span><span class="p">)</span>
-                <span class="bp">self</span><span class="o">.</span><span class="n">run_task</span><span class="p">(</span><span class="n">job</span><span class="p">[</span><span class="s2">&quot;id&quot;</span><span class="p">],</span> <span class="n">job</span><span class="p">[</span><span class="s2">&quot;task&quot;</span><span class="p">][</span><span class="s2">&quot;name&quot;</span><span class="p">],</span> <span class="n">params</span><span class="p">,</span> <span class="n">store_failures</span><span class="o">=</span><span class="n">store_failures</span><span class="p">,</span> <span class="n">raise_exceptions</span><span class="o">=</span><span class="n">raise_exceptions</span><span class="p">)</span></div>
+                <span class="k">try</span><span class="p">:</span>
+                    <span class="n">params</span> <span class="o">=</span> <span class="n">TaskParameters</span><span class="o">.</span><span class="n">develop</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">mycelium</span><span class="p">,</span> <span class="n">params</span><span class="p">)</span>
+                <span class="k">except</span> <span class="n">ResultNotFound</span><span class="p">:</span>
+                    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;&gt;&gt;Unable to retrieve result. Will try again later.&quot;</span><span class="p">)</span>
+                <span class="k">else</span><span class="p">:</span>
+                    <span class="bp">self</span><span class="o">.</span><span class="n">run_task</span><span class="p">(</span><span class="n">job</span><span class="p">[</span><span class="s2">&quot;id&quot;</span><span class="p">],</span> <span class="n">job</span><span class="p">[</span><span class="s2">&quot;task&quot;</span><span class="p">][</span><span class="s2">&quot;name&quot;</span><span class="p">],</span> <span class="n">params</span><span class="p">,</span> <span class="n">store_failures</span><span class="o">=</span><span class="n">store_failures</span><span class="p">,</span> <span class="n">raise_exceptions</span><span class="o">=</span><span class="n">raise_exceptions</span><span class="p">)</span></div>
 
 <div class="viewcode-block" id="MachineElf.run_task"><a class="viewcode-back" href="../../machine_elf.html#blumycelium.machine_elf.MachineElf.run_task">[docs]</a>    <span class="k">def</span> <span class="nf">run_task</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">job_id</span><span class="p">:</span><span class="nb">str</span><span class="p">,</span> <span class="n">task_name</span><span class="p">:</span><span class="nb">str</span><span class="p">,</span> <span class="n">parameters</span><span class="p">:</span><span class="nb">dict</span><span class="p">,</span> <span class="n">store_failures</span><span class="p">:</span><span class="nb">bool</span><span class="p">,</span> <span class="n">raise_exceptions</span><span class="p">:</span><span class="nb">bool</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;run a task for an elf&quot;&quot;&quot;</span>

blumycelium/docs/_build/html/_modules/blumycelium/models.html

@@ -45,6 +45,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../machine_elf.html">Machine Elf</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../utils.html">Utils</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../exceptions.html">Exceptions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../async.html">Async demo</a></li>
 </ul>
 
         </div>

blumycelium/docs/_build/html/_modules/blumycelium/mycelium.html

@@ -45,6 +45,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../machine_elf.html">Machine Elf</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../utils.html">Utils</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../exceptions.html">Exceptions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../async.html">Async demo</a></li>
 </ul>
 
         </div>
@@ -353,7 +354,7 @@ <h1>Source code for blumycelium.mycelium</h1><div class="highlight"><pre>
 <div class="viewcode-block" id="ArangoMycelium.is_job_ready"><a class="viewcode-back" href="../../mycelium.html#blumycelium.mycelium.ArangoMycelium.is_job_ready">[docs]</a>    <span class="k">def</span> <span class="nf">is_job_ready</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">job_id</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;return True if the job is ready to run&quot;&quot;&quot;</span>
         <span class="n">job_doc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_job</span><span class="p">(</span><span class="n">job_id</span><span class="p">)</span>
-        <span class="k">if</span> <span class="n">job_doc</span><span class="p">[</span><span class="s2">&quot;status&quot;</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="n">custom_types</span><span class="o">.</span><span class="n">STATUS</span><span class="p">[</span><span class="s2">&quot;PENDING&quot;</span><span class="p">],</span> <span class="n">custom_types</span><span class="o">.</span><span class="n">STATUS</span><span class="p">[</span><span class="s2">&quot;READY&quot;</span><span class="p">]]:</span>
+        <span class="k">if</span> <span class="n">job_doc</span><span class="p">[</span><span class="s2">&quot;status&quot;</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span> <span class="n">custom_types</span><span class="o">.</span><span class="n">STATUS</span><span class="p">[</span><span class="s2">&quot;PENDING&quot;</span><span class="p">],</span> <span class="n">custom_types</span><span class="o">.</span><span class="n">STATUS</span><span class="p">[</span><span class="s2">&quot;READY&quot;</span><span class="p">]</span> <span class="p">]:</span>
             <span class="k">return</span> <span class="kc">False</span>
 
         <span class="n">aql</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;</span>
@@ -373,7 +374,9 @@ <h1>Source code for blumycelium.mycelium</h1><div class="highlight"><pre>
             <span class="n">count</span> <span class="o">+=</span> <span class="mi">1</span>
             <span class="k">if</span> <span class="n">job</span><span class="p">[</span><span class="s2">&quot;status&quot;</span><span class="p">]</span> <span class="o">==</span> <span class="n">custom_types</span><span class="o">.</span><span class="n">STATUS</span><span class="p">[</span><span class="s2">&quot;DONE&quot;</span><span class="p">]:</span>
                 <span class="n">ready</span> <span class="o">+=</span> <span class="mi">1</span>
-        <span class="k">return</span> <span class="n">count</span> <span class="o">==</span> <span class="n">ready</span></div>
+
+        <span class="n">self_ready</span> <span class="o">=</span> <span class="n">count</span> <span class="o">==</span> <span class="n">ready</span>
+        <span class="k">return</span> <span class="n">self_ready</span></div>
 
 <div class="viewcode-block" id="ArangoMycelium.update_job_status"><a class="viewcode-back" href="../../mycelium.html#blumycelium.mycelium.ArangoMycelium.update_job_status">[docs]</a>    <span class="k">def</span> <span class="nf">update_job_status</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">job_id</span><span class="p">,</span> <span class="n">status</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;update the status of a job&quot;&quot;&quot;</span>
@@ -460,7 +463,11 @@ <h1>Source code for blumycelium.mycelium</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="ArangoMycelium.get_result"><a class="viewcode-back" href="../../mycelium.html#blumycelium.mycelium.ArangoMycelium.get_result">[docs]</a>    <span class="k">def</span> <span class="nf">get_result</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">result_id</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;return the result of a job&quot;&quot;&quot;</span>
-        <span class="n">result_doc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="p">[</span><span class="s2">&quot;Results&quot;</span><span class="p">][</span><span class="n">result_id</span><span class="p">]</span>
+        <span class="k">try</span><span class="p">:</span>
+            <span class="n">result_doc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="p">[</span><span class="s2">&quot;Results&quot;</span><span class="p">][</span><span class="n">result_id</span><span class="p">]</span>
+        <span class="k">except</span> <span class="n">a_exc</span><span class="o">.</span><span class="n">DocumentNotFoundError</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="n">ResultNotFound</span><span class="p">(</span><span class="s2">&quot;Unable to retrieve result: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">result_id</span><span class="p">)</span>
+
         <span class="k">return</span> <span class="n">result_doc</span><span class="o">.</span><span class="n">getStore</span><span class="p">()[</span><span class="s2">&quot;value&quot;</span><span class="p">]</span></div>
 
 <div class="viewcode-block" id="ArangoMycelium.get_job_status"><a class="viewcode-back" href="../../mycelium.html#blumycelium.mycelium.ArangoMycelium.get_job_status">[docs]</a>    <span class="k">def</span> <span class="nf">get_job_status</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">job_id</span><span class="p">):</span>

blumycelium/docs/_build/html/_modules/blumycelium/the_exceptions.html

@@ -45,6 +45,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../machine_elf.html">Machine Elf</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../utils.html">Utils</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../exceptions.html">Exceptions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../async.html">Async demo</a></li>
 </ul>
 
         </div>
@@ -117,6 +118,11 @@ <h1>Source code for blumycelium.the_exceptions</h1><div class="highlight"><pre>
     <span class="sd">&quot;&quot;&quot;&quot;&quot;&quot;</span>
     <span class="k">pass</span>
 
+
+<span class="k">class</span> <span class="nc">ResultNotFound</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot;&quot;&quot;&quot;</span>
+    <span class="k">pass</span>
+
 </pre></div>
 
            </div>

blumycelium/docs/_build/html/_modules/blumycelium/utils.html

@@ -45,6 +45,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../machine_elf.html">Machine Elf</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../utils.html">Utils</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../exceptions.html">Exceptions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../async.html">Async demo</a></li>
 </ul>
 
         </div>

blumycelium/docs/_build/html/_modules/index.html

@@ -45,6 +45,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../machine_elf.html">Machine Elf</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../utils.html">Utils</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../exceptions.html">Exceptions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../async.html">Async demo</a></li>
 </ul>
 
         </div>

blumycelium/docs/_build/html/_sources/async.rst.txt

@@ -0,0 +1,7 @@
+Async demo
+==========
+
+Here are some details about the demo provided in demos/daemons/async_orchestration.pyArango
+
+(WIP)
+

blumycelium/docs/_build/html/_sources/exceptions.rst.txt

@@ -1,7 +1,7 @@
 Exceptions
 =================
 
-Custom exceptions thrown by Blumycelium
+Custom exceptions thrown by BLUMYCELIUM
 
 Custom Exceptions
 -----------------

blumycelium/docs/_build/html/_sources/graph_parameters.rst.txt

@@ -1,6 +1,8 @@
 Graph Parameters
 ================
 
+This submodule handles the variable flow part of BLUMYCELIUM.
+This is what allows BLUMYCELIUM to derive the set of instructions necessary to compte a vriable.
 
 Graph Parameters
 ----------------