Merge pull request #13 from thcasey3/development

added version history to docs
thcasey3 · Apr 2, 2021 · 6543812 · 6543812
2 parents 4a13f56 + d1f865c
commit 6543812
Show file tree

Hide file tree

Showing 40 changed files with 362 additions and 37 deletions.
diff --git a/docs/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip b/docs/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip
diff --git a/docs/_downloads/48f5b2de565d2bbd86b583bf6a124052/template.ipynb b/docs/_downloads/48f5b2de565d2bbd86b583bf6a124052/template.ipynb
@@ -69,7 +69,7 @@
       },
       "outputs": [],
       "source": [
-        "def function_handle(directory, args_dict):\n\n    # insert code that acts on each file or sub-directory and makes output(s)\n    # output1 =\n    # output2 =\n\n    return [output1, output2] # make sure outputs are in a list\n                              # len() outputs list must = len() classifiers list"
+        "def function_handle(directory, args_dict):\n\n    # insert code that acts on each file or sub-directory and makes output(s)\n    # output1 =\n    # output2 =\n\n    return [output1, output2]  # make sure outputs are in a list\n    # len() outputs list must = len() classifiers list"
       ]
     },
     {

diff --git a/docs/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip b/docs/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip
diff --git a/docs/_downloads/a8e7960d7e22f5dfa3f08b444c80d88c/template.py b/docs/_downloads/a8e7960d7e22f5dfa3f08b444c80d88c/template.py
@@ -32,9 +32,10 @@ def function_handle(directory, args_dict):
     # output1 =
     # output2 =
 
-    return [output1, output2] # make sure outputs are in a list
-                              # len() outputs list must = len() classifiers list
-
+    return [output1, output2]  # make sure outputs are in a list
+    # len() outputs list must = len() classifiers list
+
+
 # %%
 
 # %% [markdown]

diff --git a/docs/_sources/auto_examples/template.rst.txt b/docs/_sources/auto_examples/template.rst.txt
@@ -52,7 +52,7 @@ Define a function that accepts the parent directory and any additional arguments
 returns a list of outputs. The list must have a single value for each member of the list and have **len()**
 equal to the list of **'classifiers'** given during the creation of the **start** object below.
 
-.. GENERATED FROM PYTHON SOURCE LINES 29-38
+.. GENERATED FROM PYTHON SOURCE LINES 29-39
 
 .. code-block:: default
 
@@ -62,15 +62,16 @@ equal to the list of **'classifiers'** given during the creation of the **start*
         # output1 =
         # output2 =
 
-        return [output1, output2] # make sure outputs are in a list
-                                  # len() outputs list must = len() classifiers list
-                              
+        return [output1, output2]  # make sure outputs are in a list
+        # len() outputs list must = len() classifiers list
 
-.. GENERATED FROM PYTHON SOURCE LINES 41-42
+
+
+.. GENERATED FROM PYTHON SOURCE LINES 42-43
 
 Create the **start** object,
 
-.. GENERATED FROM PYTHON SOURCE LINES 42-54
+.. GENERATED FROM PYTHON SOURCE LINES 43-55
 
 .. code-block:: default
 
@@ -87,36 +88,36 @@ Create the **start** object,
         date_format="YYYYMMDD",  # format of any date strings in the file or folder names
     )
 
-.. GENERATED FROM PYTHON SOURCE LINES 57-59
+.. GENERATED FROM PYTHON SOURCE LINES 58-60
 
 Pass the **start** object to the user defined function to add classifiers to the **.frame**,
 then print the **.head()** of **.frame**,
 
-.. GENERATED FROM PYTHON SOURCE LINES 59-61
+.. GENERATED FROM PYTHON SOURCE LINES 60-62
 
 .. code-block:: default
 
     lrobject.drive()
     print(lrobject.frame.head())
 
-.. GENERATED FROM PYTHON SOURCE LINES 64-65
+.. GENERATED FROM PYTHON SOURCE LINES 65-66
 
 Add a dictionary to the **start** object that is a map of the parent directory,
 
-.. GENERATED FROM PYTHON SOURCE LINES 65-66
+.. GENERATED FROM PYTHON SOURCE LINES 66-67
 
 .. code-block:: default
 
     lrobject.map_directory()
 
-.. GENERATED FROM PYTHON SOURCE LINES 69-73
+.. GENERATED FROM PYTHON SOURCE LINES 70-74
 
 Create a seaborn.relplot correlating the two outputs. Replace **'None'** for hue with date_delta if it exists in
 your **.frame**, or maybe with a third output if you have more than two. The **'seaborn_args'** dictionary should have
 keys that are the arguments that would be given to **seaborn.relplot** and any allowed values according to **seaborn.relplot**
 documentation,
 
-.. GENERATED FROM PYTHON SOURCE LINES 73-74
+.. GENERATED FROM PYTHON SOURCE LINES 74-75
 
 .. code-block:: default
 

diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -59,4 +59,5 @@ Features
    classes
    auto_examples/index
    planned
+   version_history
 
diff --git a/docs/_sources/version_history.rst.txt b/docs/_sources/version_history.rst.txt
@@ -0,0 +1,18 @@
+===============
+Version History
+===============
+
+Version 0.0.2
+-------------
+* Added option to use a dict and re expressions to define patterns
+* Added new methods **find_patterns()** and **reduce_names()**
+* some code cleanup
+* added to unittests
+* improved documentation and template script
+
+Version 0.0.1
+-------------
+* First release
+
+
+
diff --git a/docs/auto_examples/index.html b/docs/auto_examples/index.html
@@ -111,6 +111,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../planned.html">Planned Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../version_history.html">Version History</a></li>
 </ul>
 
 

diff --git a/docs/auto_examples/template.html b/docs/auto_examples/template.html
@@ -111,6 +111,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../planned.html">Planned Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../version_history.html">Version History</a></li>
 </ul>
 
 
@@ -206,8 +207,8 @@
     <span class="c1"># output1 =</span>
     <span class="c1"># output2 =</span>
 
-    <span class="k">return</span> <span class="p">[</span><span class="n">output1</span><span class="p">,</span> <span class="n">output2</span><span class="p">]</span> <span class="c1"># make sure outputs are in a list</span>
-                              <span class="c1"># len() outputs list must = len() classifiers list</span>
+    <span class="k">return</span> <span class="p">[</span><span class="n">output1</span><span class="p">,</span> <span class="n">output2</span><span class="p">]</span>  <span class="c1"># make sure outputs are in a list</span>
+    <span class="c1"># len() outputs list must = len() classifiers list</span>
 </pre></div>
 </div>
 <p>Create the <strong>start</strong> object,</p>

diff --git a/docs/classes.html b/docs/classes.html
@@ -114,6 +114,7 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">lrengine Template</a></li>
 <li class="toctree-l1"><a class="reference internal" href="planned.html">Planned Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="version_history.html">Version History</a></li>
 </ul>
 
 

diff --git a/docs/create.html b/docs/create.html
@@ -108,6 +108,7 @@
 <li class="toctree-l1"><a class="reference internal" href="classes.html">Classes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">lrengine Template</a></li>
 <li class="toctree-l1"><a class="reference internal" href="planned.html">Planned Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="version_history.html">Version History</a></li>
 </ul>
 
 

diff --git a/docs/define_patterns.html b/docs/define_patterns.html
@@ -108,6 +108,7 @@
 <li class="toctree-l1"><a class="reference internal" href="classes.html">Classes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">lrengine Template</a></li>
 <li class="toctree-l1"><a class="reference internal" href="planned.html">Planned Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="version_history.html">Version History</a></li>
 </ul>
 
 

diff --git a/docs/drive.html b/docs/drive.html
@@ -108,6 +108,7 @@
 <li class="toctree-l1"><a class="reference internal" href="classes.html">Classes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">lrengine Template</a></li>
 <li class="toctree-l1"><a class="reference internal" href="planned.html">Planned Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="version_history.html">Version History</a></li>
 </ul>
 
 

diff --git a/docs/engine.html b/docs/engine.html
@@ -114,6 +114,7 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">lrengine Template</a></li>
 <li class="toctree-l1"><a class="reference internal" href="planned.html">Planned Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="version_history.html">Version History</a></li>
 </ul>
 
 

diff --git a/docs/find_dates.html b/docs/find_dates.html
@@ -108,6 +108,7 @@
 <li class="toctree-l1"><a class="reference internal" href="classes.html">Classes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">lrengine Template</a></li>
 <li class="toctree-l1"><a class="reference internal" href="planned.html">Planned Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="version_history.html">Version History</a></li>
 </ul>
 
 

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -106,6 +106,7 @@
 <li class="toctree-l1"><a class="reference internal" href="classes.html">Classes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">lrengine Template</a></li>
 <li class="toctree-l1"><a class="reference internal" href="planned.html">Planned Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="version_history.html">Version History</a></li>
 </ul>
 
 

diff --git a/docs/index.html b/docs/index.html
@@ -107,6 +107,7 @@
 <li class="toctree-l1"><a class="reference internal" href="classes.html">Classes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">lrengine Template</a></li>
 <li class="toctree-l1"><a class="reference internal" href="planned.html">Planned Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="version_history.html">Version History</a></li>
 </ul>
 
 
@@ -187,7 +188,7 @@ <h1>Welcome to lrengine<a class="headerlink" href="#welcome-to-lrengine" title="
 <td><p>0.0.2</p></td>
 </tr>
 <tr class="row-even"><td><p>Documentation Build Date</p></td>
-<td><p>04/01/2021, 18:00:52</p></td>
+<td><p>04/02/2021, 09:20:43</p></td>
 </tr>
 <tr class="row-odd"><td><p>Author</p></td>
 <td><p>Thomas Casey</p></td>
@@ -232,6 +233,11 @@ <h2>Features<a class="headerlink" href="#features" title="Permalink to this head
 </li>
 <li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">lrengine Template</a></li>
 <li class="toctree-l1"><a class="reference internal" href="planned.html">Planned Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="version_history.html">Version History</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="version_history.html#version-0-0-2">Version 0.0.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="version_history.html#version-0-0-1">Version 0.0.1</a></li>
+</ul>
+</li>
 </ul>
 </div>
 </div>

diff --git a/docs/install.html b/docs/install.html
@@ -113,6 +113,7 @@
 <li class="toctree-l1"><a class="reference internal" href="classes.html">Classes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">lrengine Template</a></li>
 <li class="toctree-l1"><a class="reference internal" href="planned.html">Planned Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="version_history.html">Version History</a></li>
 </ul>
 
 

diff --git a/docs/intake.html b/docs/intake.html
@@ -114,6 +114,7 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">lrengine Template</a></li>
 <li class="toctree-l1"><a class="reference internal" href="planned.html">Planned Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="version_history.html">Version History</a></li>
 </ul>
 
 

diff --git a/docs/introduction.html b/docs/introduction.html
@@ -111,6 +111,7 @@
 <li class="toctree-l1"><a class="reference internal" href="classes.html">Classes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">lrengine Template</a></li>
 <li class="toctree-l1"><a class="reference internal" href="planned.html">Planned Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="version_history.html">Version History</a></li>
 </ul>
 
 

diff --git a/docs/map_directory.html b/docs/map_directory.html
@@ -108,6 +108,7 @@
 <li class="toctree-l1"><a class="reference internal" href="classes.html">Classes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">lrengine Template</a></li>
 <li class="toctree-l1"><a class="reference internal" href="planned.html">Planned Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="version_history.html">Version History</a></li>
 </ul>
 
 

diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/planned.html b/docs/planned.html
@@ -40,6 +40,7 @@
 
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="Version History" href="version_history.html" />
     <link rel="prev" title="lrengine Template" href="auto_examples/template.html" /> 
 </head>
 
@@ -107,6 +108,7 @@
 <li class="toctree-l1"><a class="reference internal" href="classes.html">Classes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">lrengine Template</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Planned Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="version_history.html">Version History</a></li>
 </ul>
 
 
@@ -190,6 +192,8 @@ <h1>Planned Features<a class="headerlink" href="#planned-features" title="Permal
 
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
+        <a href="version_history.html" class="btn btn-neutral float-right" title="Version History" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+
 
         <a href="auto_examples/template.html" class="btn btn-neutral float-left" title="lrengine Template" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 

diff --git a/docs/reduce_dates.html b/docs/reduce_dates.html
@@ -108,6 +108,7 @@
 <li class="toctree-l1"><a class="reference internal" href="classes.html">Classes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">lrengine Template</a></li>
 <li class="toctree-l1"><a class="reference internal" href="planned.html">Planned Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="version_history.html">Version History</a></li>
 </ul>
 
 

diff --git a/docs/reduce_names.html b/docs/reduce_names.html
@@ -108,6 +108,7 @@
 <li class="toctree-l1"><a class="reference internal" href="classes.html">Classes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">lrengine Template</a></li>
 <li class="toctree-l1"><a class="reference internal" href="planned.html">Planned Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="version_history.html">Version History</a></li>
 </ul>
 
 

diff --git a/docs/save.html b/docs/save.html
@@ -108,6 +108,7 @@
 <li class="toctree-l1"><a class="reference internal" href="classes.html">Classes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">lrengine Template</a></li>
 <li class="toctree-l1"><a class="reference internal" href="planned.html">Planned Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="version_history.html">Version History</a></li>
 </ul>
 
 

diff --git a/docs/sea.html b/docs/sea.html
@@ -108,6 +108,7 @@
 <li class="toctree-l1"><a class="reference internal" href="classes.html">Classes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">lrengine Template</a></li>
 <li class="toctree-l1"><a class="reference internal" href="planned.html">Planned Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="version_history.html">Version History</a></li>
 </ul>
 
 

diff --git a/docs/search.html b/docs/search.html
@@ -108,6 +108,7 @@
 <li class="toctree-l1"><a class="reference internal" href="classes.html">Classes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">lrengine Template</a></li>
 <li class="toctree-l1"><a class="reference internal" href="planned.html">Planned Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="version_history.html">Version History</a></li>
 </ul>
-Original file line number
+Diff line change
@@ Expand Up / @@ -59,4 +59,5 @@ Features @@
        classes
        auto_examples/index
        planned
+       version_history