ciocore 8.3.1__py2.py3-none-any.whl → 8.3.3__py2.py3-none-any.whl

ciocore/VERSION

@@ -1 +1 @@
-8.3.1
+8.3.3

ciocore/api_client.py

@@ -488,23 +488,26 @@ def account_name_from_jwt(token):
     return None
 
 
-def request_instance_types(as_dict=False):
+def request_instance_types(as_dict=False, filter_param=""):
     """
     Get the list of available instances types.
     
     Args:
         as_dict (bool): Whether or not to return the instance types as a dictionary.
+        filter_param (string): complex RHS string query ex:
+          "cpu=gte:8:int,operating_system=ne:windows,gpu.gpu_count=eq:1:int"
     
     Returns:
         list: The list of instance types.
     """
     api = ApiClient()
     response, response_code = api.make_request(
-        "api/v1/instance-types", use_api_key=True, raise_on_error=False
+        "api/v1/instance-types", use_api_key=True, raise_on_error=False,
+        params={"filter":filter_param}
     )
     if response_code not in (200,):
         msg = "Failed to get instance types"
-        msg += "\nError %s ...\n%s" % (response_code, response)
+        msg += "\nAPI responded with status code %s\n" % (response_code)
         raise Exception(msg)
 
     instance_types = json.loads(response).get("data", [])
@@ -554,7 +557,7 @@ def request_projects(statuses=("active",)):
 def request_software_packages():
     """
     Query Conductor for all software packages for the currently available sidecar.
-    
+
     Returns:
         list: The list of software packages.
     """

ciocore/data.py

@@ -51,12 +51,14 @@ def init(*products, **kwargs):
 
     __platforms__ = set(kwargs.get("platforms", ["windows", "linux"]))
 
-def data(force=False):
+def data(force=False, instances_filter=""):
     """
     Provide projects, instance types, and software package data.
 
     Keyword Args:
         force: (bool) If `True`, then force the system to fetch fresh data -- Defaults to `False`.
+        instances_filter: (str) complex RHS string query ex:
+          "cpu=gte:8:int,operating_system=ne:windows,gpu.gpu_count=eq:1:int"
 
     Raises:
         ValueError:  Module was not initialized with [init()](/data/#ciocore.data.init).
@@ -118,7 +120,7 @@ def data(force=False):
         # PROJECTS
         __data__["projects"] = sorted(api_client.request_projects())
         # INST_TYPES
-        instance_types = api_client.request_instance_types()
+        instance_types = api_client.request_instance_types(filter_param=instances_filter)
         # SOFTWARE
         software = api_client.request_software_packages()
 

ciocore/docsite/apidoc/api_client/index.html

@@ -2393,7 +2393,7 @@ prompt the user to log in. </p>
 
 
 <h2 id="ciocore.api_client.request_instance_types" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">request_instance_types</span><span class="p">(</span><span class="n">as_dict</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></code>
+<code class="highlight language-python"><span class="n">request_instance_types</span><span class="p">(</span><span class="n">as_dict</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">filter_param</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">)</span></code>
 
 
 </h2>
@@ -2419,6 +2419,13 @@ prompt the user to log in. </p>
         <td><p>Whether or not to return the instance types as a dictionary.</p></td>
         <td><code>False</code></td>
       </tr>
+      <tr>
+        <td><code>filter_param</code></td>
+        <td><code>string</code></td>
+        <td><p>complex RHS string query ex:
+"cpu=gte:8:int,operating_system=ne:windows,gpu.gpu_count=eq:1:int"</p></td>
+        <td><code>&#39;&#39;</code></td>
+      </tr>
   </tbody>
 </table>
 <p><strong>Returns:</strong></p>
@@ -2438,23 +2445,26 @@ prompt the user to log in. </p>
 </table>
         <details class="quote">
           <summary>Source code in <code>ciocore/api_client.py</code></summary>
-          <div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">request_instance_types</span><span class="p">(</span><span class="n">as_dict</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+          <div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">request_instance_types</span><span class="p">(</span><span class="n">as_dict</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">filter_param</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Get the list of available instances types.</span>
 
 <span class="sd">    Args:</span>
 <span class="sd">        as_dict (bool): Whether or not to return the instance types as a dictionary.</span>
+<span class="sd">        filter_param (string): complex RHS string query ex:</span>
+<span class="sd">          &quot;cpu=gte:8:int,operating_system=ne:windows,gpu.gpu_count=eq:1:int&quot;</span>
 
 <span class="sd">    Returns:</span>
 <span class="sd">        list: The list of instance types.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">api</span> <span class="o">=</span> <span class="n">ApiClient</span><span class="p">()</span>
     <span class="n">response</span><span class="p">,</span> <span class="n">response_code</span> <span class="o">=</span> <span class="n">api</span><span class="o">.</span><span class="n">make_request</span><span class="p">(</span>
-        <span class="s2">&quot;api/v1/instance-types&quot;</span><span class="p">,</span> <span class="n">use_api_key</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">raise_on_error</span><span class="o">=</span><span class="kc">False</span>
+        <span class="s2">&quot;api/v1/instance-types&quot;</span><span class="p">,</span> <span class="n">use_api_key</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">raise_on_error</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
+        <span class="n">params</span><span class="o">=</span><span class="p">{</span><span class="s2">&quot;filter&quot;</span><span class="p">:</span><span class="n">filter_param</span><span class="p">}</span>
     <span class="p">)</span>
     <span class="k">if</span> <span class="n">response_code</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span><span class="mi">200</span><span class="p">,):</span>
         <span class="n">msg</span> <span class="o">=</span> <span class="s2">&quot;Failed to get instance types&quot;</span>
-        <span class="n">msg</span> <span class="o">+=</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">Error </span><span class="si">%s</span><span class="s2"> ...</span><span class="se">\n</span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">response_code</span><span class="p">,</span> <span class="n">response</span><span class="p">)</span>
+        <span class="n">msg</span> <span class="o">+=</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">API responded with status code </span><span class="si">%s</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">response_code</span><span class="p">)</span>
         <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
 
     <span class="n">instance_types</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">response</span><span class="p">)</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;data&quot;</span><span class="p">,</span> <span class="p">[])</span>

ciocore/docsite/apidoc/data/index.html

@@ -984,7 +984,7 @@
 
 
 <h2 id="ciocore.data.data" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">data</span><span class="p">(</span><span class="n">force</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></code>
+<code class="highlight language-python"><span class="n">data</span><span class="p">(</span><span class="n">force</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">instances_filter</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">)</span></code>
 
 
 </h2>
@@ -1008,6 +1008,12 @@
         <td></td>
         <td><p>(bool) If <code>True</code>, then force the system to fetch fresh data -- Defaults to <code>False</code>.</p></td>
       </tr>
+      <tr>
+        <td><code>instances_filter</code></td>
+        <td></td>
+        <td><p>(str) complex RHS string query ex:
+"cpu=gte:8:int,operating_system=ne:windows,gpu.gpu_count=eq:1:int"</p></td>
+      </tr>
   </tbody>
 </table>
 <p><strong>Exceptions:</strong></p>
@@ -1079,12 +1085,14 @@ the software available at Conductor, or a subset based on specified products.</p
 
         <details class="quote">
           <summary>Source code in <code>ciocore/data.py</code></summary>
-          <div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">data</span><span class="p">(</span><span class="n">force</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+          <div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">data</span><span class="p">(</span><span class="n">force</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">instances_filter</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Provide projects, instance types, and software package data.</span>
 
 <span class="sd">    Keyword Args:</span>
 <span class="sd">        force: (bool) If `True`, then force the system to fetch fresh data -- Defaults to `False`.</span>
+<span class="sd">        instances_filter: (str) complex RHS string query ex:</span>
+<span class="sd">          &quot;cpu=gte:8:int,operating_system=ne:windows,gpu.gpu_count=eq:1:int&quot;</span>
 
 <span class="sd">    Raises:</span>
 <span class="sd">        ValueError:  Module was not initialized with [init()](/data/#ciocore.data.init).</span>
@@ -1146,7 +1154,7 @@ the software available at Conductor, or a subset based on specified products.</p
         <span class="c1"># PROJECTS</span>
         <span class="n">__data__</span><span class="p">[</span><span class="s2">&quot;projects&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">api_client</span><span class="o">.</span><span class="n">request_projects</span><span class="p">())</span>
         <span class="c1"># INST_TYPES</span>
-        <span class="n">instance_types</span> <span class="o">=</span> <span class="n">api_client</span><span class="o">.</span><span class="n">request_instance_types</span><span class="p">()</span>
+        <span class="n">instance_types</span> <span class="o">=</span> <span class="n">api_client</span><span class="o">.</span><span class="n">request_instance_types</span><span class="p">(</span><span class="n">filter_param</span><span class="o">=</span><span class="n">instances_filter</span><span class="p">)</span>
         <span class="c1"># SOFTWARE</span>
         <span class="n">software</span> <span class="o">=</span> <span class="n">api_client</span><span class="o">.</span><span class="n">request_software_packages</span><span class="p">()</span>