Updated docs for 1.2.1 release

Author: rlabbeptc

docs/kepconfig.html

@@ -71,6 +71,8 @@ <h1 class="modulename">
 
 <p>This is a package to help create Python applications to conduct operations with the Kepware Configuration API. This package is designed to work with all versions of Kepware that support the Configuration API including Thingworx Kepware Server (TKS), Thingworx Kepware Edge (TKE) and KEPServerEX (KEP).</p>
 
+<p><strong>API reference documentation is available on <a href="https://ptcinc.github.io/Kepware-ConfigAPI-SDK-Python">Github Pages</a></strong></p>
+
 <h2 id="prerequisites">Prerequisites</h2>
 
 <p>Package supported and tested on Python 3.9 or later. Older versions support earlier Python 3 environments but have less functionality. All HTTP communication is handled by the <a href="https://docs.python.org/3/library/urllib.html#module-urllib">urllib</a> Python standard library.</p>
@@ -321,7 +323,6 @@ <h2 id="need-more-information">Need More Information</h2>
 </span><span id="L-20"><a href="#L-20"><span class="linenos">20</span></a><span class="sd">&quot;&quot;&quot;</span>
 </span><span id="L-21"><a href="#L-21"><span class="linenos">21</span></a><span class="n">__version__</span> <span class="o">=</span> <span class="s2">&quot;1.2.0&quot;</span>
 </span><span id="L-22"><a href="#L-22"><span class="linenos">22</span></a><span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">connection</span><span class="p">,</span> <span class="n">error</span>
-</span><span id="L-23"><a href="#L-23"><span class="linenos">23</span></a><span class="kn">from</span> <span class="nn">.utils</span> <span class="kn">import</span> <span class="n">path_split</span>
 </span></pre></div>
 
 

docs/kepconfig/admin/ua_server.html

@@ -80,9 +80,9 @@ <h1 class="modulename">
 </span><span id="L-9"><a href="#L-9"><span class="linenos">  9</span></a><span class="sd">exchange objects for EGD devices within the Kepware Configuration API</span>
 </span><span id="L-10"><a href="#L-10"><span class="linenos"> 10</span></a><span class="sd">&quot;&quot;&quot;</span>
 </span><span id="L-11"><a href="#L-11"><span class="linenos"> 11</span></a>
-</span><span id="L-12"><a href="#L-12"><span class="linenos"> 12</span></a><span class="kn">from</span> <span class="nn">...</span> <span class="kn">import</span> <span class="n">path_split</span>
-</span><span id="L-13"><a href="#L-13"><span class="linenos"> 13</span></a><span class="kn">from</span> <span class="nn">...connection</span> <span class="kn">import</span> <span class="n">server</span>
-</span><span id="L-14"><a href="#L-14"><span class="linenos"> 14</span></a><span class="kn">from</span> <span class="nn">...error</span> <span class="kn">import</span> <span class="n">KepHTTPError</span><span class="p">,</span> <span class="n">KepError</span>
+</span><span id="L-12"><a href="#L-12"><span class="linenos"> 12</span></a><span class="kn">from</span> <span class="nn">...connection</span> <span class="kn">import</span> <span class="n">server</span>
+</span><span id="L-13"><a href="#L-13"><span class="linenos"> 13</span></a><span class="kn">from</span> <span class="nn">...error</span> <span class="kn">import</span> <span class="n">KepHTTPError</span><span class="p">,</span> <span class="n">KepError</span>
+</span><span id="L-14"><a href="#L-14"><span class="linenos"> 14</span></a><span class="kn">from</span> <span class="nn">...utils</span> <span class="kn">import</span> <span class="n">_url_parse_object</span><span class="p">,</span> <span class="n">path_split</span>
 </span><span id="L-15"><a href="#L-15"><span class="linenos"> 15</span></a><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Union</span>
 </span><span id="L-16"><a href="#L-16"><span class="linenos"> 16</span></a><span class="kn">from</span> <span class="nn">..</span> <span class="kn">import</span> <span class="n">egd</span> <span class="k">as</span> <span class="n">EGD</span><span class="p">,</span> <span class="n">channel</span><span class="p">,</span> <span class="n">device</span>
 </span><span id="L-17"><a href="#L-17"><span class="linenos"> 17</span></a>
@@ -105,9 +105,9 @@ <h1 class="modulename">
 </span><span id="L-34"><a href="#L-34"><span class="linenos"> 34</span></a>            <span class="k">return</span> <span class="n">device_root</span> <span class="o">+</span> <span class="n">PRODUCER_ROOT</span>
 </span><span id="L-35"><a href="#L-35"><span class="linenos"> 35</span></a>    <span class="k">else</span><span class="p">:</span>
 </span><span id="L-36"><a href="#L-36"><span class="linenos"> 36</span></a>        <span class="k">if</span> <span class="n">ex_type</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> <span class="o">==</span> <span class="n">EGD</span><span class="o">.</span><span class="n">CONSUMER_EXCHANGE</span><span class="p">:</span>
-</span><span id="L-37"><a href="#L-37"><span class="linenos"> 37</span></a>            <span class="k">return</span> <span class="s1">&#39;</span><span class="si">{}{}</span><span class="s1">/</span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">device_root</span><span class="p">,</span><span class="n">CONSUMER_ROOT</span><span class="p">,</span><span class="n">exchange_name</span><span class="p">)</span>
+</span><span id="L-37"><a href="#L-37"><span class="linenos"> 37</span></a>            <span class="k">return</span> <span class="s1">&#39;</span><span class="si">{}{}</span><span class="s1">/</span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">device_root</span><span class="p">,</span><span class="n">CONSUMER_ROOT</span><span class="p">,</span><span class="n">_url_parse_object</span><span class="p">(</span><span class="n">exchange_name</span><span class="p">))</span>
 </span><span id="L-38"><a href="#L-38"><span class="linenos"> 38</span></a>        <span class="k">else</span><span class="p">:</span>
-</span><span id="L-39"><a href="#L-39"><span class="linenos"> 39</span></a>            <span class="k">return</span> <span class="s1">&#39;</span><span class="si">{}{}</span><span class="s1">/</span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">device_root</span><span class="p">,</span><span class="n">PRODUCER_ROOT</span><span class="p">,</span><span class="n">exchange_name</span><span class="p">)</span>
+</span><span id="L-39"><a href="#L-39"><span class="linenos"> 39</span></a>            <span class="k">return</span> <span class="s1">&#39;</span><span class="si">{}{}</span><span class="s1">/</span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">device_root</span><span class="p">,</span><span class="n">PRODUCER_ROOT</span><span class="p">,</span><span class="n">_url_parse_object</span><span class="p">(</span><span class="n">exchange_name</span><span class="p">))</span>
 </span><span id="L-40"><a href="#L-40"><span class="linenos"> 40</span></a>
 </span><span id="L-41"><a href="#L-41"><span class="linenos"> 41</span></a><span class="k">def</span> <span class="nf">add_exchange</span><span class="p">(</span><span class="n">server</span><span class="p">:</span> <span class="n">server</span><span class="p">,</span> <span class="n">device_path</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">ex_type</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">DATA</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">dict</span><span class="p">,</span> <span class="nb">list</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">Union</span><span class="p">[</span><span class="nb">bool</span><span class="p">,</span> <span class="nb">list</span><span class="p">]:</span>
 </span><span id="L-42"><a href="#L-42"><span class="linenos"> 42</span></a><span class="w">    </span><span class="sd">&#39;&#39;&#39;Add a `&quot;exchange&quot;` or multiple `&quot;exchange&quot;` objects to Kepware. Can be used to pass children of a exchange object </span>

docs/kepconfig/admin/user_groups.html

@@ -77,7 +77,7 @@ <h1 class="modulename">
 </span><span id="L-9"><a href="#L-9"><span class="linenos">  9</span></a><span class="sd">name resolution objects for EGD devices within the Kepware Configuration API</span>
 </span><span id="L-10"><a href="#L-10"><span class="linenos"> 10</span></a><span class="sd">&quot;&quot;&quot;</span>
 </span><span id="L-11"><a href="#L-11"><span class="linenos"> 11</span></a>
-</span><span id="L-12"><a href="#L-12"><span class="linenos"> 12</span></a><span class="kn">from</span> <span class="nn">...</span> <span class="kn">import</span> <span class="n">path_split</span>
+</span><span id="L-12"><a href="#L-12"><span class="linenos"> 12</span></a><span class="kn">from</span> <span class="nn">...utils</span> <span class="kn">import</span> <span class="n">_url_parse_object</span><span class="p">,</span> <span class="n">path_split</span>
 </span><span id="L-13"><a href="#L-13"><span class="linenos"> 13</span></a><span class="kn">from</span> <span class="nn">...connection</span> <span class="kn">import</span> <span class="n">server</span>
 </span><span id="L-14"><a href="#L-14"><span class="linenos"> 14</span></a><span class="kn">from</span> <span class="nn">...error</span> <span class="kn">import</span> <span class="n">KepHTTPError</span><span class="p">,</span> <span class="n">KepError</span>
 </span><span id="L-15"><a href="#L-15"><span class="linenos"> 15</span></a><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Union</span>
@@ -97,7 +97,7 @@ <h1 class="modulename">
 </span><span id="L-29"><a href="#L-29"><span class="linenos"> 29</span></a>    <span class="k">if</span> <span class="n">name</span> <span class="o">==</span> <span class="kc">None</span><span class="p">:</span>
 </span><span id="L-30"><a href="#L-30"><span class="linenos"> 30</span></a>        <span class="k">return</span> <span class="s1">&#39;</span><span class="si">{}</span><span class="s1">/</span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">device_root</span><span class="p">,</span> <span class="n">NAMES_ROOT</span><span class="p">)</span>
 </span><span id="L-31"><a href="#L-31"><span class="linenos"> 31</span></a>    <span class="k">else</span><span class="p">:</span>
-</span><span id="L-32"><a href="#L-32"><span class="linenos"> 32</span></a>        <span class="k">return</span> <span class="s1">&#39;</span><span class="si">{}</span><span class="s1">/</span><span class="si">{}</span><span class="s1">/</span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">device_root</span><span class="p">,</span> <span class="n">NAMES_ROOT</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
+</span><span id="L-32"><a href="#L-32"><span class="linenos"> 32</span></a>        <span class="k">return</span> <span class="s1">&#39;</span><span class="si">{}</span><span class="s1">/</span><span class="si">{}</span><span class="s1">/</span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">device_root</span><span class="p">,</span> <span class="n">NAMES_ROOT</span><span class="p">,</span> <span class="n">_url_parse_object</span><span class="p">(</span><span class="n">name</span><span class="p">))</span>
 </span><span id="L-33"><a href="#L-33"><span class="linenos"> 33</span></a>
 </span><span id="L-34"><a href="#L-34"><span class="linenos"> 34</span></a><span class="k">def</span> <span class="nf">add_name_resolution</span><span class="p">(</span><span class="n">server</span><span class="p">:</span> <span class="n">server</span><span class="p">,</span> <span class="n">device_path</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">DATA</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">dict</span><span class="p">,</span> <span class="nb">list</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">Union</span><span class="p">[</span><span class="nb">bool</span><span class="p">,</span> <span class="nb">list</span><span class="p">]:</span>
 </span><span id="L-35"><a href="#L-35"><span class="linenos"> 35</span></a><span class="w">    </span><span class="sd">&#39;&#39;&#39;Add a `&quot;name resolution&quot;` or multiple `&quot;name resolution&quot;` objects to Kepware. This allows you to </span>