Deploying to gh-pages from @ 1ebc054 🚀

_sources/autoapi/index.rst.txt

@@ -6,7 +6,7 @@ This page contains auto-generated API reference documentation [#f1]_.
 .. toctree::
    :titlesonly:
 
-   /autoapi/orderly/index
    /autoapi/outpack/index
+   /autoapi/orderly/index
 
 .. [#f1] Created with `sphinx-autoapi <https://github.com/readthedocs/sphinx-autoapi>`_

_sources/autoapi/outpack/filestore/index.rst.txt

@@ -23,16 +23,22 @@ Classes
    .. py:method:: filename(hash)
 
 
-   .. py:method:: get(hash, dst)
+   .. py:method:: get(hash, dst, *, overwrite=False)
 
 
    .. py:method:: exists(hash)
 
 
-   .. py:method:: put(src, hash)
+   .. py:method:: put(src, hash, *, move=False)
 
 
    .. py:method:: ls()
 
 
+   .. py:method:: destroy() -> None
+
+
+   .. py:method:: tmp()
+
+
 

_sources/autoapi/outpack/index.rst.txt

@@ -29,6 +29,7 @@ Submodules
    init/index.rst
    location/index.rst
    location_path/index.rst
+   location_pull/index.rst
    metadata/index.rst
    packet/index.rst
    root/index.rst

_sources/autoapi/outpack/index/index.rst.txt

@@ -22,12 +22,12 @@ Classes
 
 
    .. py:attribute:: metadata
-      :type: dict
+      :type: Dict[str, outpack.metadata.MetadataCore]
 
 
 
    .. py:attribute:: location
-      :type: dict
+      :type: Dict[str, Dict[str, outpack.metadata.PacketLocation]]
 
 
 
@@ -50,19 +50,22 @@ Classes
    .. py:method:: refresh()
 
 
-   .. py:method:: all_metadata()
+   .. py:method:: all_metadata() -> Dict[str, outpack.metadata.MetadataCore]
 
 
-   .. py:method:: metadata(id)
+   .. py:method:: metadata(id) -> outpack.metadata.MetadataCore
 
 
-   .. py:method:: all_locations()
+   .. py:method:: all_locations() -> Dict[str, Dict[str, outpack.metadata.PacketLocation]]
 
 
-   .. py:method:: location(name)
+   .. py:method:: location(name) -> Dict[str, outpack.metadata.PacketLocation]
 
 
-   .. py:method:: unpacked()
+   .. py:method:: packets_in_location(name) -> List[str]
+
+
+   .. py:method:: unpacked() -> List[str]
 
 
 

_sources/autoapi/outpack/location/index.rst.txt

@@ -18,7 +18,6 @@ Functions
    outpack.location.outpack_location_remove
    outpack.location.outpack_location_rename
    outpack.location.location_resolve_valid
-   outpack.location.outpack_location_pull_metadata
 
 
 
@@ -37,6 +36,3 @@ Functions
 .. py:function:: location_resolve_valid(location, root, *, include_local, include_orphan, allow_no_locations)
 
 
-.. py:function:: outpack_location_pull_metadata(location=None, root=None, *, locate=True)
-
-

_sources/autoapi/outpack/location_pull/index.rst.txt

@@ -0,0 +1,98 @@
+:py:mod:`outpack.location_pull`
+===============================
+
+.. py:module:: outpack.location_pull
+
+
+Module Contents
+---------------
+
+Classes
+~~~~~~~
+
+.. autoapisummary::
+
+   outpack.location_pull.PullPlanInfo
+   outpack.location_pull.LocationPullPlan
+   outpack.location_pull.PullPlanPackets
+
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   outpack.location_pull.outpack_location_pull_metadata
+   outpack.location_pull.outpack_location_pull_packet
+
+
+
+.. py:function:: outpack_location_pull_metadata(location=None, root=None, *, locate=True)
+
+
+.. py:function:: outpack_location_pull_packet(ids: Union[str, List[str]], *, options=None, recursive=None, root=None, locate=True)
+
+
+.. py:class:: PullPlanInfo
+
+
+   .. py:attribute:: n_extra
+      :type: int
+
+
+
+   .. py:attribute:: n_skip
+      :type: int
+
+
+
+   .. py:attribute:: n_total
+      :type: int
+
+
+
+
+.. py:class:: LocationPullPlan
+
+
+   .. py:attribute:: packets
+      :type: Dict[str, outpack.metadata.PacketLocation]
+
+
+
+   .. py:attribute:: files
+      :type: List[outpack.metadata.PacketFileWithLocation]
+
+
+
+   .. py:attribute:: info
+      :type: PullPlanInfo
+
+
+
+
+.. py:class:: PullPlanPackets
+
+
+   .. py:attribute:: requested
+      :type: List[str]
+
+
+
+   .. py:attribute:: full
+      :type: List[str]
+
+
+
+   .. py:attribute:: skip
+      :type: Set[str]
+
+
+
+   .. py:attribute:: fetch
+      :type: Set[str]
+
+
+
+

_sources/autoapi/outpack/metadata/index.rst.txt

@@ -13,6 +13,7 @@ Classes
 .. autoapisummary::
 
    outpack.metadata.PacketFile
+   outpack.metadata.PacketFileWithLocation
    outpack.metadata.PacketDependsPath
    outpack.metadata.PacketDepends
    outpack.metadata.MetadataCore
@@ -61,6 +62,34 @@ Attributes
 
 
 
+.. py:class:: PacketFileWithLocation
+
+
+   .. py:attribute:: path
+      :type: str
+
+
+
+   .. py:attribute:: size
+      :type: float
+
+
+
+   .. py:attribute:: hash
+      :type: str
+
+
+
+   .. py:attribute:: location
+      :type: str
+
+
+
+   .. py:method:: from_packet_file(file: PacketFile, location: str)
+      :staticmethod:
+
+
+
 .. py:class:: PacketDependsPath
 
 
@@ -173,9 +202,9 @@ Attributes
 
 
 
-.. py:function:: read_metadata_core(path)
+.. py:function:: read_metadata_core(path) -> MetadataCore
 
 
-.. py:function:: read_packet_location(path)
+.. py:function:: read_packet_location(path) -> PacketLocation
 
 

_sources/autoapi/outpack/root/index.rst.txt

@@ -30,6 +30,7 @@ Functions
 
 
    .. py:attribute:: files
+      :type: Optional[outpack.filestore.FileStore]
 
 
 

_sources/autoapi/outpack/util/index.rst.txt

@@ -25,6 +25,9 @@ Functions
    outpack.util.match_value
    outpack.util.relative_path_array
    outpack.util.read_string
+   outpack.util.format_list
+   outpack.util.pl
+   outpack.util.partition
 
 
 
@@ -64,3 +67,18 @@ Functions
 .. py:function:: read_string(path)
 
 
+.. py:function:: format_list(x)
+
+
+.. py:function:: pl(x, singular, plural=None)
+
+
+.. py:function:: partition(pred, iterable)
+
+   Partition entries into false entries and true entries.
+
+   This is slightly modified version of partition from itertools
+   recipes https://docs.python.org/dev/library/itertools.html#itertools-recipes
+   If *pred* is slow, consider wrapping it with functools.lru_cache().
+
+

autoapi/index.html

@@ -25,7 +25,7 @@
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="orderly" href="orderly/index.html" />
+    <link rel="next" title="outpack" href="outpack/index.html" />
     <link rel="prev" title="Code examples" href="../code.html" /> 
 </head>
 
@@ -53,8 +53,8 @@
 <li class="toctree-l1"><a class="reference internal" href="../readme.html">outpack</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../code.html">Code examples</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">API Reference</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="orderly/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">orderly</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="outpack/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">outpack</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="orderly/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">orderly</span></code></a></li>
 </ul>
 </li>
 </ul>
@@ -88,13 +88,6 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Link to this
 <p>This page contains auto-generated API reference documentation <a class="footnote-reference brackets" href="#f1" id="id1" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a>.</p>
 <div class="toctree-wrapper compound">
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="orderly/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">orderly</span></code></a><ul>
-<li class="toctree-l2"><a class="reference internal" href="orderly/core/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">orderly.core</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="orderly/current/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">orderly.current</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="orderly/read/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">orderly.read</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="orderly/run/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">orderly.run</span></code></a></li>
-</ul>
-</li>
 <li class="toctree-l1"><a class="reference internal" href="outpack/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">outpack</span></code></a><ul>
 <li class="toctree-l2"><a class="reference internal" href="outpack/schema/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">outpack.schema</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="outpack/__about__/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">outpack.__about__</span></code></a></li>
@@ -107,6 +100,7 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Link to this
 <li class="toctree-l2"><a class="reference internal" href="outpack/init/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">outpack.init</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="outpack/location/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">outpack.location</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="outpack/location_path/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">outpack.location_path</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="outpack/location_pull/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">outpack.location_pull</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="outpack/metadata/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">outpack.metadata</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="outpack/packet/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">outpack.packet</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="outpack/root/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">outpack.root</span></code></a></li>
@@ -117,6 +111,13 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Link to this
 <li class="toctree-l2"><a class="reference internal" href="outpack/util/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">outpack.util</span></code></a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="orderly/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">orderly</span></code></a><ul>
+<li class="toctree-l2"><a class="reference internal" href="orderly/core/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">orderly.core</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="orderly/current/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">orderly.current</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="orderly/read/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">orderly.read</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="orderly/run/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">orderly.run</span></code></a></li>
+</ul>
+</li>
 </ul>
 </div>
 <aside class="footnote-list brackets">
@@ -132,7 +133,7 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Link to this
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="../code.html" class="btn btn-neutral float-left" title="Code examples" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="orderly/index.html" class="btn btn-neutral float-right" title="orderly" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="outpack/index.html" class="btn btn-neutral float-right" title="outpack" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>

autoapi/orderly/core/index.html

@@ -53,6 +53,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../readme.html">outpack</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../code.html">Code examples</a></li>
 <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">API Reference</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../../outpack/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">outpack</span></code></a></li>
 <li class="toctree-l2 current"><a class="reference internal" href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">orderly</span></code></a><ul class="current">
 <li class="toctree-l3 current"><a class="reference internal" href="../index.html#submodules">Submodules</a><ul class="current">
 <li class="toctree-l4 current"><a class="current reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">orderly.core</span></code></a></li>
@@ -64,7 +65,6 @@
 <li class="toctree-l3"><a class="reference internal" href="../index.html#package-contents">Package Contents</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../../outpack/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">outpack</span></code></a></li>
 </ul>
 </li>
 </ul>

autoapi/orderly/current/index.html

@@ -53,6 +53,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../readme.html">outpack</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../code.html">Code examples</a></li>
 <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">API Reference</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../../outpack/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">outpack</span></code></a></li>
 <li class="toctree-l2 current"><a class="reference internal" href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">orderly</span></code></a><ul class="current">
 <li class="toctree-l3 current"><a class="reference internal" href="../index.html#submodules">Submodules</a><ul class="current">
 <li class="toctree-l4"><a class="reference internal" href="../core/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">orderly.core</span></code></a></li>
@@ -64,7 +65,6 @@
 <li class="toctree-l3"><a class="reference internal" href="../index.html#package-contents">Package Contents</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../../outpack/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">outpack</span></code></a></li>
 </ul>
 </li>
 </ul>