deploy: c181037

Author: stuqdog

_modules/viam/app/viam_client.html

@@ -87,7 +87,8 @@
            <div itemprop="articleBody">
 
   <h1>Source code for viam.app.viam_client</h1><div class="highlight"><pre>
-<span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Mapping</span><span class="p">,</span> <span class="n">Optional</span>
+<span></span><span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Mapping</span><span class="p">,</span> <span class="n">Optional</span>
 
 <span class="kn">from</span> <span class="nn">grpclib.client</span> <span class="kn">import</span> <span class="n">Channel</span>
 <span class="kn">from</span> <span class="nn">typing_extensions</span> <span class="kn">import</span> <span class="n">Self</span>
@@ -99,7 +100,7 @@ <h1>Source code for viam.app.viam_client</h1><div class="highlight"><pre>
 <span class="kn">from</span> <span class="nn">viam.app.ml_training_client</span> <span class="kn">import</span> <span class="n">MLTrainingClient</span>
 <span class="kn">from</span> <span class="nn">viam.app.provisioning_client</span> <span class="kn">import</span> <span class="n">ProvisioningClient</span>
 <span class="kn">from</span> <span class="nn">viam.robot.client</span> <span class="kn">import</span> <span class="n">RobotClient</span>
-<span class="kn">from</span> <span class="nn">viam.rpc.dial</span> <span class="kn">import</span> <span class="n">DialOptions</span><span class="p">,</span> <span class="n">_dial_app</span><span class="p">,</span> <span class="n">_get_access_token</span>
+<span class="kn">from</span> <span class="nn">viam.rpc.dial</span> <span class="kn">import</span> <span class="n">Credentials</span><span class="p">,</span> <span class="n">DialOptions</span><span class="p">,</span> <span class="n">_dial_app</span><span class="p">,</span> <span class="n">_get_access_token</span>
 
 <span class="n">LOGGER</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
 
@@ -113,14 +114,46 @@ <h1>Source code for viam.app.viam_client</h1><div class="highlight"><pre>
 <span class="sd">        ViamClient.create_from_dial_options(...)</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
+<div class="viewcode-block" id="ViamClient.create_from_env_vars"><a class="viewcode-back" href="../../../autoapi/viam/app/viam_client/index.html#viam.app.viam_client.ViamClient.create_from_env_vars">[docs]</a>    <span class="nd">@classmethod</span>
+    <span class="k">async</span> <span class="k">def</span> <span class="nf">create_from_env_vars</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">dial_options</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">DialOptions</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">app_url</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Self</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Create `ViamClient` using credentials set in the environment as `VIAM_API_KEY` and `VIAM_API_KEY_ID`.</span>
+
+<span class="sd">        ::</span>
+
+<span class="sd">            client = await ViamClient.create_from_env_vars()</span>
+
+<span class="sd">        Args:</span>
+<span class="sd">            dial_options (Optional[viam.rpc.dial.DialOptions]): Options for authorization and connection to app.</span>
+<span class="sd">                If not provided, default options will be selected. Note that `creds` and `auth_entity`</span>
+<span class="sd">                fields will be overwritten by the values set by a module.</span>
+<span class="sd">            app_url: (Optional[str]): URL of app. Uses app.viam.com if not specified.</span>
+
+<span class="sd">        Raises:</span>
+<span class="sd">            ValueError: If there are no env vars set by the module, or if they are set improperly</span>
+
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="n">dial_options</span> <span class="o">=</span> <span class="n">dial_options</span> <span class="k">if</span> <span class="n">dial_options</span> <span class="k">else</span> <span class="n">DialOptions</span><span class="p">()</span>
+        <span class="n">api_key</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;VIAM_API_KEY&quot;</span><span class="p">)</span>
+        <span class="k">if</span> <span class="n">api_key</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;api key cannot be None&quot;</span><span class="p">)</span>
+        <span class="n">api_key_id</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;VIAM_API_KEY_ID&quot;</span><span class="p">)</span>
+        <span class="k">if</span> <span class="n">api_key_id</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;api key ID cannot be None&quot;</span><span class="p">)</span>
+        <span class="n">credentials</span> <span class="o">=</span> <span class="n">Credentials</span><span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="s2">&quot;api-key&quot;</span><span class="p">,</span> <span class="n">payload</span><span class="o">=</span><span class="n">api_key</span><span class="p">)</span>
+        <span class="n">dial_options</span><span class="o">.</span><span class="n">credentials</span> <span class="o">=</span> <span class="n">credentials</span>
+        <span class="n">dial_options</span><span class="o">.</span><span class="n">auth_entity</span> <span class="o">=</span> <span class="n">api_key_id</span>
+
+        <span class="k">return</span> <span class="k">await</span> <span class="bp">cls</span><span class="o">.</span><span class="n">create_from_dial_options</span><span class="p">(</span><span class="n">dial_options</span><span class="p">,</span> <span class="n">app_url</span><span class="p">)</span></div>
+
+
 <div class="viewcode-block" id="ViamClient.create_from_dial_options"><a class="viewcode-back" href="../../../autoapi/viam/app/viam_client/index.html#viam.app.viam_client.ViamClient.create_from_dial_options">[docs]</a>    <span class="nd">@classmethod</span>
     <span class="k">async</span> <span class="k">def</span> <span class="nf">create_from_dial_options</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">dial_options</span><span class="p">:</span> <span class="n">DialOptions</span><span class="p">,</span> <span class="n">app_url</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Self</span><span class="p">:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Create `ViamClient` that establishes a connection to the Viam app.</span>
 
 <span class="sd">        ::</span>
 
 <span class="sd">            dial_options = DialOptions.with_api_key(&quot;&lt;API-KEY&gt;&quot;, &quot;&lt;API-KEY-ID&gt;&quot;)</span>
-<span class="sd">            ViamClient.create_from_dial_options(dial_options)</span>
+<span class="sd">            client = await ViamClient.create_from_dial_options(dial_options)</span>
 
 <span class="sd">        Args:</span>
 <span class="sd">            dial_options (viam.rpc.dial.DialOptions): Required information for authorization and connection to app.</span>

_sources/autoapi/viam/app/viam_client/index.rst.txt

@@ -35,6 +35,28 @@ Module Contents
        ViamClient.create_from_dial_options(...)
 
 
+   .. py:method:: create_from_env_vars(dial_options: Optional[viam.rpc.dial.DialOptions] = None, app_url: Optional[str] = None) -> typing_extensions.Self
+      :classmethod:
+
+      :async:
+
+
+      Create `ViamClient` using credentials set in the environment as `VIAM_API_KEY` and `VIAM_API_KEY_ID`.
+
+      ::
+
+          client = await ViamClient.create_from_env_vars()
+
+      :param dial_options: Options for authorization and connection to app.
+                           If not provided, default options will be selected. Note that `creds` and `auth_entity`
+                           fields will be overwritten by the values set by a module.
+      :type dial_options: Optional[viam.rpc.dial.DialOptions]
+      :param app_url: (Optional[str]): URL of app. Uses app.viam.com if not specified.
+
+      :raises ValueError: If there are no env vars set by the module, or if they are set improperly
+
+
+
    .. py:method:: create_from_dial_options(dial_options: viam.rpc.dial.DialOptions, app_url: Optional[str] = None) -> typing_extensions.Self
       :classmethod:
 
@@ -46,7 +68,7 @@ Module Contents
       ::
 
           dial_options = DialOptions.with_api_key("<API-KEY>", "<API-KEY-ID>")
-          ViamClient.create_from_dial_options(dial_options)
+          client = await ViamClient.create_from_dial_options(dial_options)
 
       :param dial_options: Required information for authorization and connection to app.
                            `creds` and `auth_entity` fields are required.

autoapi/viam/app/viam_client/index.html

@@ -70,6 +70,7 @@
 <li class="toctree-l4"><a class="reference internal" href="#module-contents">Module Contents</a><ul>
 <li class="toctree-l5"><a class="reference internal" href="#viam.app.viam_client.LOGGER"><code class="docutils literal notranslate"><span class="pre">LOGGER</span></code></a></li>
 <li class="toctree-l5"><a class="reference internal" href="#viam.app.viam_client.ViamClient"><code class="docutils literal notranslate"><span class="pre">ViamClient</span></code></a><ul>
+<li class="toctree-l6"><a class="reference internal" href="#viam.app.viam_client.ViamClient.create_from_env_vars"><code class="docutils literal notranslate"><span class="pre">ViamClient.create_from_env_vars()</span></code></a></li>
 <li class="toctree-l6"><a class="reference internal" href="#viam.app.viam_client.ViamClient.create_from_dial_options"><code class="docutils literal notranslate"><span class="pre">ViamClient.create_from_dial_options()</span></code></a></li>
 <li class="toctree-l6"><a class="reference internal" href="#viam.app.viam_client.ViamClient.data_client"><code class="docutils literal notranslate"><span class="pre">ViamClient.data_client</span></code></a></li>
 <li class="toctree-l6"><a class="reference internal" href="#viam.app.viam_client.ViamClient.app_client"><code class="docutils literal notranslate"><span class="pre">ViamClient.app_client</span></code></a></li>
@@ -158,6 +159,32 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalin
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ViamClient</span><span class="o">.</span><span class="n">create_from_dial_options</span><span class="p">(</span><span class="o">...</span><span class="p">)</span>
 </pre></div>
 </div>
+<dl class="py method">
+<dt class="sig sig-object py" id="viam.app.viam_client.ViamClient.create_from_env_vars">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_env_vars</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dial_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../rpc/dial/index.html#viam.rpc.dial.DialOptions" title="viam.rpc.dial.DialOptions"><span class="pre">viam.rpc.dial.DialOptions</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">app_url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">typing_extensions.Self</span></span></span><a class="reference internal" href="../../../../_modules/viam/app/viam_client.html#ViamClient.create_from_env_vars"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#viam.app.viam_client.ViamClient.create_from_env_vars" title="Permalink to this definition"></a></dt>
+<dd><dl class="field-list simple">
+<dt class="field-odd">Async<span class="colon">:</span></dt>
+<dd class="field-odd"><p></p></dd>
+</dl>
+<p>Create <cite>ViamClient</cite> using credentials set in the environment as <cite>VIAM_API_KEY</cite> and <cite>VIAM_API_KEY_ID</cite>.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">client</span> <span class="o">=</span> <span class="k">await</span> <span class="n">ViamClient</span><span class="o">.</span><span class="n">create_from_env_vars</span><span class="p">()</span>
+</pre></div>
+</div>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>dial_options</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="../../rpc/dial/index.html#viam.rpc.dial.DialOptions" title="viam.rpc.dial.DialOptions"><em>viam.rpc.dial.DialOptions</em></a><em>]</em>) – Options for authorization and connection to app.
+If not provided, default options will be selected. Note that <cite>creds</cite> and <cite>auth_entity</cite>
+fields will be overwritten by the values set by a module.</p></li>
+<li><p><strong>app_url</strong> – (Optional[str]): URL of app. Uses app.viam.com if not specified.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Raises<span class="colon">:</span></dt>
+<dd class="field-even"><p><strong>ValueError</strong> – If there are no env vars set by the module, or if they are set improperly</p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="viam.app.viam_client.ViamClient.create_from_dial_options">
 <em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_dial_options</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dial_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../rpc/dial/index.html#viam.rpc.dial.DialOptions" title="viam.rpc.dial.DialOptions"><span class="pre">viam.rpc.dial.DialOptions</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">app_url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">typing_extensions.Self</span></span></span><a class="reference internal" href="../../../../_modules/viam/app/viam_client.html#ViamClient.create_from_dial_options"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#viam.app.viam_client.ViamClient.create_from_dial_options" title="Permalink to this definition"></a></dt>
@@ -167,7 +194,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalin
 </dl>
 <p>Create <cite>ViamClient</cite> that establishes a connection to the Viam app.</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">dial_options</span> <span class="o">=</span> <span class="n">DialOptions</span><span class="o">.</span><span class="n">with_api_key</span><span class="p">(</span><span class="s2">&quot;&lt;API-KEY&gt;&quot;</span><span class="p">,</span> <span class="s2">&quot;&lt;API-KEY-ID&gt;&quot;</span><span class="p">)</span>
-<span class="n">ViamClient</span><span class="o">.</span><span class="n">create_from_dial_options</span><span class="p">(</span><span class="n">dial_options</span><span class="p">)</span>
+<span class="n">client</span> <span class="o">=</span> <span class="k">await</span> <span class="n">ViamClient</span><span class="o">.</span><span class="n">create_from_dial_options</span><span class="p">(</span><span class="n">dial_options</span><span class="p">)</span>
 </pre></div>
 </div>
 <dl class="field-list simple">