0.23.3

theNewFlesh · Jul 11, 2022 · 6896914 · 6896914
1 parent d47e9b8
commit 6896914
Show file tree

Hide file tree

Showing 28 changed files with 85 additions and 85 deletions.
diff --git a/docker/frozen_requirements.txt b/docker/frozen_requirements.txt
@@ -5,15 +5,15 @@ APScheduler==3.9.1
 argon2-cffi==21.3.0
 argon2-cffi-bindings==21.2.0
 async-generator==1.10
-atomicwrites==1.4.0
+atomicwrites==1.4.1
 attrs==21.4.0
 Babel==2.10.3
 backcall==0.2.0
 beautifulsoup4==4.11.1
 bleach==5.0.1
 bokeh==2.4.3
-boto3==1.24.25
-botocore==1.27.25
+boto3==1.24.26
+botocore==1.27.26
 Brotli==1.0.9
 certifi==2022.6.15
 cffi==1.15.1
@@ -67,7 +67,7 @@ imageio==2.19.3
 imagesize==1.4.1
 importlib-metadata==4.2.0
 importlib-resources==5.8.0
-ipykernel==6.15.0
+ipykernel==6.15.1
 ipysheet==0.5.0
 ipython==7.34.0
 ipython-genutils==0.2.0
@@ -81,9 +81,9 @@ json-logging==1.3.0
 json-spec==0.10.1
 json5==0.9.8
 jsoncomment==0.4.2
-jsonschema==4.6.2
+jsonschema==4.7.1
 jupyter-client==7.3.4
-jupyter-core==4.11.0
+jupyter-core==4.11.1
 jupyter-server==1.18.1
 jupyter-server-mathjax==0.2.5
 jupyterlab==3.4.3
@@ -166,7 +166,7 @@ requests==2.28.1
 requests-toolbelt==0.9.1
 responses==0.21.0
 rfc3986==2.0.0
-rich==12.4.4
+rich==12.5.1
 rolling-pin==0.4.2
 s3transfer==0.6.0
 schematics==2.1.1
@@ -199,7 +199,7 @@ tifffile==2021.11.2
 tinycss2==1.1.1
 toml==0.10.2
 tomli==2.0.1
-toolz==0.11.2
+toolz==0.12.0
 tornado==6.2
 tox==3.25.1
 traitlets==5.3.0

diff --git a/docs/.doctrees/core.doctree b/docs/.doctrees/core.doctree
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/intro.doctree b/docs/.doctrees/intro.doctree
diff --git a/docs/_modules/hidebound/core/config.html b/docs/_modules/hidebound/core/config.html
@@ -28,7 +28,7 @@
             <a href="../../../index.html" class="icon icon-home"> hidebound
           </a>
               <div class="version">
-                0.23.2
+                0.23.3
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -176,7 +176,7 @@ <h1>Source code for hidebound.core.config</h1><div class="highlight"><pre>
 <span class="sd">    A class for validating configurations supplied to Database.</span>
 
 <span class="sd">    Attributes:</span>
-<span class="sd">        root_directory (str or Path): Root directory to recurse.</span>
+<span class="sd">        ingress_directory (str or Path): Root directory to recurse.</span>
 <span class="sd">        staging_directory (str or Path): Directory where hidebound data will be</span>
 <span class="sd">            staged.</span>
 <span class="sd">        specification_files (list[str], optional): List of asset specification</span>
@@ -190,7 +190,7 @@ <h1>Source code for hidebound.core.config</h1><div class="highlight"><pre>
 <span class="sd">        exporters (dict, optional): Dictionary of exporter configs, where the</span>
 <span class="sd">            key is the exporter name and the value is its config. Default: {}.</span>
 <span class="sd">    &#39;&#39;&#39;</span>
-    <span class="n">root_directory</span> <span class="o">=</span> <span class="n">StringType</span><span class="p">(</span>
+    <span class="n">ingress_directory</span> <span class="o">=</span> <span class="n">StringType</span><span class="p">(</span>
         <span class="n">required</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">validators</span><span class="o">=</span><span class="p">[</span><span class="n">vd</span><span class="o">.</span><span class="n">is_directory</span><span class="p">]</span>
     <span class="p">)</span>  <span class="c1"># type: StringType</span>
     <span class="n">staging_directory</span> <span class="o">=</span> <span class="n">StringType</span><span class="p">(</span>

diff --git a/docs/_modules/hidebound/core/database.html b/docs/_modules/hidebound/core/database.html
@@ -28,7 +28,7 @@
             <a href="../../../index.html" class="icon icon-home"> hidebound
           </a>
               <div class="version">
-                0.23.2
+                0.23.3
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -154,7 +154,7 @@ <h1>Source code for hidebound.core.database</h1><div class="highlight"><pre>
         <span class="n">config</span><span class="p">[</span><span class="s1">&#39;specifications&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">specs</span>
 
         <span class="k">return</span> <span class="n">Database</span><span class="p">(</span>
-            <span class="n">config</span><span class="p">[</span><span class="s1">&#39;root_directory&#39;</span><span class="p">],</span>
+            <span class="n">config</span><span class="p">[</span><span class="s1">&#39;ingress_directory&#39;</span><span class="p">],</span>
             <span class="n">config</span><span class="p">[</span><span class="s1">&#39;staging_directory&#39;</span><span class="p">],</span>
             <span class="n">specifications</span><span class="o">=</span><span class="n">specs</span><span class="p">,</span>
             <span class="n">include_regex</span><span class="o">=</span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;include_regex&#39;</span><span class="p">],</span>
@@ -200,23 +200,23 @@ <h1>Source code for hidebound.core.database</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="Database.__init__"><a class="viewcode-back" href="../../../core.html#hidebound.core.database.Database.__init__">[docs]</a>    <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">root_dir</span><span class="p">,</span>                     <span class="c1"># type: Union[str, Path]</span>
-        <span class="n">staging_dir</span><span class="p">,</span>                <span class="c1"># type: Union[str, Path]</span>
+        <span class="n">ingress_dir</span><span class="p">,</span>                  <span class="c1"># type: Union[str, Path]</span>
+        <span class="n">staging_dir</span><span class="p">,</span>                  <span class="c1"># type: Union[str, Path]</span>
         <span class="n">specifications</span><span class="o">=</span><span class="p">[],</span>            <span class="c1"># type: List[SpecificationBase]</span>
         <span class="n">include_regex</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">,</span>             <span class="c1"># type: str</span>
         <span class="n">exclude_regex</span><span class="o">=</span><span class="sa">r</span><span class="s1">&#39;\.DS_Store&#39;</span><span class="p">,</span>  <span class="c1"># type: str</span>
         <span class="n">write_mode</span><span class="o">=</span><span class="s1">&#39;copy&#39;</span><span class="p">,</span>            <span class="c1"># type: str</span>
         <span class="n">exporters</span><span class="o">=</span><span class="p">{},</span>                 <span class="c1"># type: Dict[str, Any]</span>
         <span class="n">webhooks</span><span class="o">=</span><span class="p">[],</span>                  <span class="c1"># type: List[Dict]</span>
-        <span class="n">dask_enabled</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>            <span class="c1"># type: bool</span>
-        <span class="n">dask_workers</span><span class="o">=</span><span class="mi">8</span><span class="p">,</span>             <span class="c1"># type: int</span>
+        <span class="n">dask_enabled</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>           <span class="c1"># type: bool</span>
+        <span class="n">dask_workers</span><span class="o">=</span><span class="mi">8</span><span class="p">,</span>               <span class="c1"># type: int</span>
     <span class="p">):</span>
         <span class="c1"># type: (...) -&gt; None</span>
         <span class="sa">r</span><span class="sd">&#39;&#39;&#39;</span>
 <span class="sd">        Creates an instance of Database but does not populate it with data.</span>
 
 <span class="sd">        Args:</span>
-<span class="sd">            root_dir (str or Path): Root directory to recurse.</span>
+<span class="sd">            ingress_dir (str or Path): Root directory to recurse.</span>
 <span class="sd">            staging_dir (str or Path): Directory where hidebound data will be</span>
 <span class="sd">                staged.</span>
 <span class="sd">            specifications (list[SpecificationBase], optional): List of asset</span>
@@ -273,7 +273,7 @@ <h1>Source code for hidebound.core.database</h1><div class="highlight"><pre>
             <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
 
         <span class="c1"># validate root dir</span>
-        <span class="n">root</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">root_dir</span><span class="p">)</span>
+        <span class="n">root</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">ingress_dir</span><span class="p">)</span>
         <span class="k">if</span> <span class="ow">not</span> <span class="n">root</span><span class="o">.</span><span class="n">is_dir</span><span class="p">():</span>
             <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">root</span><span class="si">}</span><span class="s1"> is not a directory or does not exist.&#39;</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>

diff --git a/docs/_modules/hidebound/server/extension.html b/docs/_modules/hidebound/server/extension.html
@@ -28,7 +28,7 @@
             <a href="../../../index.html" class="icon icon-home"> hidebound
           </a>
               <div class="version">
-                0.23.2
+                0.23.3
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -170,7 +170,7 @@ <h1>Source code for hidebound.server.extension</h1><div class="highlight"><pre>
 <span class="sd">            dict: Database config.</span>
 <span class="sd">        &#39;&#39;&#39;</span>
         <span class="k">return</span> <span class="nb">dict</span><span class="p">(</span>
-            <span class="n">root_directory</span><span class="o">=</span><span class="n">app</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;ROOT_DIRECTORY&#39;</span><span class="p">),</span>
+            <span class="n">ingress_directory</span><span class="o">=</span><span class="n">app</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;INGRESS_DIRECTORY&#39;</span><span class="p">),</span>
             <span class="n">staging_directory</span><span class="o">=</span><span class="n">app</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;STAGING_DIRECTORY&#39;</span><span class="p">),</span>
             <span class="n">include_regex</span><span class="o">=</span><span class="n">app</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;INCLUDE_REGEX&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">),</span>
             <span class="n">exclude_regex</span><span class="o">=</span><span class="n">app</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;EXCLUDE_REGEX&#39;</span><span class="p">,</span> <span class="sa">r</span><span class="s1">&#39;\.DS_Store&#39;</span><span class="p">),</span>

diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -28,7 +28,7 @@
             <a href="../index.html" class="icon icon-home"> hidebound
           </a>
               <div class="version">
-                0.23.2
+                0.23.3
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">

diff --git a/docs/_sources/intro.rst.txt b/docs/_sources/intro.rst.txt
@@ -568,7 +568,7 @@ Hidebound configs consist of three main sections:
 Base
 ~~~~
 
--  root\_directory - the directory hidebound parses for assets that
+-  ingress\_directory - the directory hidebound parses for assets that
    comprise its database
 -  staging\_directory - the staging directory valid assets are created
    in
@@ -609,7 +609,7 @@ config file.
 +===================================+==========+==========================================+
 | HIDEBOUND\_CONFIG\_FILEPATH       | str      | Entire Hidebound config file             |
 +-----------------------------------+----------+------------------------------------------+
-| HIDEBOUND\_ROOT\_DIRECTORY        | str      | root\_directory parameter of config      |
+| HIDEBOUND\_INGRESS\_DIRECTORY     | str      | ingress\_directory parameter of config   |
 +-----------------------------------+----------+------------------------------------------+
 | HIDEBOUND\_STAGING\_DIRECTORY     | str      | staging\_directory parameter of config   |
 +-----------------------------------+----------+------------------------------------------+
@@ -636,8 +636,8 @@ Here is a full example config with comments:
 
 .. code:: yaml
 
-    root_directory: /mnt/storage/projects                        # where hb looks for assets
-    staging_directory: /mnt/storage/hidebound                  # hb staging directory
+    ingress_directory: /mnt/storage/projects                     # where hb looks for assets
+    staging_directory: /mnt/storage/hidebound                    # hb staging directory
     specification_files:                                         # list of spec files
       - /mnt/storage/specs/image_specs.py
       - /mnt/storage/specs/video_specs.py

diff --git a/docs/cli.html b/docs/cli.html
@@ -30,7 +30,7 @@
             <a href="index.html" class="icon icon-home"> hidebound
           </a>
               <div class="version">
-                0.23.2
+                0.23.3
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">