feat(crosswalk): publish crosswalk initial support, tests, and docs (#151)

* feat(crosswalk): publish crosswalk initial support, tests, and docs

* chore(crosswalk): order imports, new version

* Apply automatic documentation changes

* fix(crosswalk): fix metadata API interactions to update/create when necessary, placeholders for future functionality

* Apply automatic documentation changes

* feat(crosswalk): implement crosswalk read functionality

* Apply automatic documentation changes

* docs(crosswalk): update command

* Apply automatic documentation changes

* Update gen3/tools/metadata/crosswalk.py

Co-authored-by: Pauline Ribeyre <[email protected]>

* Apply automatic documentation changes

* feat(crosswalk): response to review

* Apply automatic documentation changes

Co-authored-by: Alexander VT <[email protected]>
Co-authored-by: Pauline Ribeyre <[email protected]>

Author: 3 people

README.md

@@ -5,7 +5,6 @@ The Gen3 Software Development Kit (SDK) for Python provides classes and function
 The API for a commons can be overwhelming, so this SDK/CLI aims
 to simplify communication with various microservices.
 
-This [blog](https://documentation.divio.com/introduction/) introduces the different types of documentation (explanation, how-to, tutorial, reference).
 The docs here contain general descriptions of the different pieces of the SDK and example scripts. For detailed API documentation, see the link below:
 
 * [Detailed API Documentation](https://uc-cdis.github.io/gen3sdk-python/_build/html/index.html)
@@ -20,9 +19,10 @@ The docs here contain general descriptions of the different pieces of the SDK an
   - [Available Classes](docs/reference/sdkClasses.md)
   - [Indexing Tools](docs/howto/diirmIndexing.md)
   - [Metadata Tools](docs/howto/metadataTools.md)
+  - [Metadata Crosswalk Tools](docs/howto/crosswalk.md)
   - [Bundle Tools](docs/howto/bundleTools.md)
   - [Development](docs/howto/devTest.md)
-  
+
 ---
 
 ## Installation

docs/_build/doctrees/environment.pickle

@@ -845,7 +845,37 @@ <h1>Source code for gen3.index</h1><div class="highlight"><pre>
                 <span class="n">raise_for_status_and_print_error</span><span class="p">(</span><span class="n">response</span><span class="p">)</span>
                 <span class="n">response</span> <span class="o">=</span> <span class="k">await</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
 
-        <span class="k">return</span> <span class="n">response</span></div></div>
+        <span class="k">return</span> <span class="n">response</span></div>
+
+    <span class="c1">## Mint GUID Requests</span>
+
+<div class="viewcode-block" id="Gen3Index.get_valid_guids"><a class="viewcode-back" href="../../indexing.html#gen3.index.Gen3Index.get_valid_guids">[docs]</a>    <span class="nd">@backoff</span><span class="o">.</span><span class="n">on_exception</span><span class="p">(</span><span class="n">backoff</span><span class="o">.</span><span class="n">expo</span><span class="p">,</span> <span class="ne">Exception</span><span class="p">,</span> <span class="o">**</span><span class="n">DEFAULT_BACKOFF_SETTINGS</span><span class="p">)</span>
+    <span class="k">def</span> <span class="nf">get_valid_guids</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">count</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Get a list of valid GUIDs without indexing</span>
+<span class="sd">        Args:</span>
+<span class="sd">            count (int): number of GUIDs to request</span>
+<span class="sd">        Returns:</span>
+<span class="sd">            List[str]: list of valid indexd GUIDs</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="n">url</span> <span class="o">=</span> <span class="s2">&quot;/guid/mint&quot;</span>
+        <span class="k">if</span> <span class="n">count</span><span class="p">:</span>
+            <span class="n">url</span> <span class="o">+=</span> <span class="sa">f</span><span class="s2">&quot;?count=</span><span class="si">{</span><span class="n">count</span><span class="si">}</span><span class="s2">&quot;</span>
+
+        <span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">_get</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
+        <span class="n">response</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span>
+        <span class="k">return</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;guids&quot;</span><span class="p">,</span> <span class="p">[])</span></div>
+
+<div class="viewcode-block" id="Gen3Index.get_guids_prefix"><a class="viewcode-back" href="../../indexing.html#gen3.index.Gen3Index.get_guids_prefix">[docs]</a>    <span class="nd">@backoff</span><span class="o">.</span><span class="n">on_exception</span><span class="p">(</span><span class="n">backoff</span><span class="o">.</span><span class="n">expo</span><span class="p">,</span> <span class="ne">Exception</span><span class="p">,</span> <span class="o">**</span><span class="n">DEFAULT_BACKOFF_SETTINGS</span><span class="p">)</span>
+    <span class="k">def</span> <span class="nf">get_guids_prefix</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Get the prefix for GUIDs if there is one</span>
+<span class="sd">        Returns:</span>
+<span class="sd">            str: prefix for this instance</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">_get</span><span class="p">(</span><span class="s2">&quot;/guid/prefix&quot;</span><span class="p">)</span>
+        <span class="n">response</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span>
+        <span class="k">return</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;prefix&quot;</span><span class="p">)</span></div></div>
 
 
 <span class="k">def</span> <span class="nf">_print_func_name</span><span class="p">(</span><span class="n">function</span><span class="p">):</span>