Added docs to cpl.utils
This commit is contained in:
BIN
docs/build/doctrees/cpl.utils.doctree
vendored
BIN
docs/build/doctrees/cpl.utils.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/environment.pickle
vendored
BIN
docs/build/doctrees/environment.pickle
vendored
Binary file not shown.
166
docs/build/html/cpl.utils.html
vendored
166
docs/build/html/cpl.utils.html
vendored
@@ -179,30 +179,52 @@
|
||||
<dt id="cpl.utils.credential_manager.CredentialManager">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.utils.credential_manager.</span></code><code class="sig-name descname"><span class="pre">CredentialManager</span></code><a class="headerlink" href="#cpl.utils.credential_manager.CredentialManager" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>Handles credentials</p>
|
||||
<p>Handles credential encryption and decryption</p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl.utils.credential_manager.CredentialManager.build_string">
|
||||
<em class="property"><span class="pre">static</span> </em><code class="sig-name descname"><span class="pre">build_string</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.utils.credential_manager.CredentialManager.build_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Builds string with credentials in it
|
||||
:param string:
|
||||
:param credentials:
|
||||
:return:</p>
|
||||
<dd><p>Builds string with credentials in it</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>string: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>String in which the variable is replaced by credentials</p>
|
||||
</dd>
|
||||
<dt>credentials: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>String to encode</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<blockquote>
|
||||
<div><p>Decoded string</p>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.utils.credential_manager.CredentialManager.decrypt">
|
||||
<em class="property"><span class="pre">static</span> </em><code class="sig-name descname"><span class="pre">decrypt</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> → <span class="pre">str</span><a class="headerlink" href="#cpl.utils.credential_manager.CredentialManager.decrypt" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Decode with base64
|
||||
:param string:
|
||||
:return:</p>
|
||||
<dd><p>Decode with base64</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>string: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>String to decode</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<blockquote>
|
||||
<div><p>Decoded string</p>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.utils.credential_manager.CredentialManager.encrypt">
|
||||
<em class="property"><span class="pre">static</span> </em><code class="sig-name descname"><span class="pre">encrypt</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> → <span class="pre">str</span><a class="headerlink" href="#cpl.utils.credential_manager.CredentialManager.encrypt" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Encode with base64
|
||||
:param string:
|
||||
:return:</p>
|
||||
<dd><p>Encode with base64</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>string: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>String to encode</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<blockquote>
|
||||
<div><p>Encoded string</p>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@@ -223,53 +245,76 @@
|
||||
<dl class="py method">
|
||||
<dt id="cpl.utils.pip.Pip.get_outdated">
|
||||
<em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">get_outdated</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <span class="pre">bytes</span><a class="headerlink" href="#cpl.utils.pip.Pip.get_outdated" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Gets table of outdated packages
|
||||
:return:</p>
|
||||
<dd><p>Gets table of outdated packages</p>
|
||||
<blockquote>
|
||||
<div><p>Bytes string of the command result</p>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.utils.pip.Pip.get_package">
|
||||
<em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">get_package</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">package</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> → <span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl.utils.pip.Pip.get_package" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Gets given package py local pip list
|
||||
:param package:
|
||||
:return:</p>
|
||||
<dd><p>Gets given package py local pip list</p>
|
||||
<blockquote>
|
||||
<div><p>package: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</div></blockquote>
|
||||
<blockquote>
|
||||
<div><p>The package name as string</p>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.utils.pip.Pip.install">
|
||||
<em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">install</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">package</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stdout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stderr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.utils.pip.Pip.install" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Installs given package
|
||||
:param package:
|
||||
:param args:
|
||||
:param source:
|
||||
:param stdout:
|
||||
:param stderr:
|
||||
:return:</p>
|
||||
<dd><p>Installs given package</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>package: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>The name of the package</p>
|
||||
</dd>
|
||||
<dt>args: <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></dt><dd><p>Arguments for the command</p>
|
||||
</dd>
|
||||
<dt>source: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Extra index URL</p>
|
||||
</dd>
|
||||
<dt>stdout: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Stdout of subprocess.run</p>
|
||||
</dd>
|
||||
<dt>stderr: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Stderr of subprocess.run</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.utils.pip.Pip.reset_executable">
|
||||
<em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">reset_executable</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.utils.pip.Pip.reset_executable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Resets the executable to system standard
|
||||
:return:</p>
|
||||
<dd><p>Resets the executable to system standard</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.utils.pip.Pip.set_executable">
|
||||
<em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">set_executable</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">executable</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.utils.pip.Pip.set_executable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets the executable
|
||||
:param executable:
|
||||
:return:</p>
|
||||
<dd><p>Sets the executable</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>executable: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>The python command</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.utils.pip.Pip.uninstall">
|
||||
<em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">uninstall</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">package</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stdout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stderr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.utils.pip.Pip.uninstall" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Uninstalls given package
|
||||
:param package:
|
||||
:param stdout:
|
||||
:param stderr:
|
||||
:return:</p>
|
||||
<dd><p>Uninstalls given package</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>package: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>The name of the package</p>
|
||||
</dd>
|
||||
<dt>stdout: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Stdout of subprocess.run</p>
|
||||
</dd>
|
||||
<dt>stderr: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Stderr of subprocess.run</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@@ -285,39 +330,70 @@
|
||||
<dl class="py method">
|
||||
<dt id="cpl.utils.string.String.convert_to_camel_case">
|
||||
<em class="property"><span class="pre">static</span> </em><code class="sig-name descname"><span class="pre">convert_to_camel_case</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chars</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> → <span class="pre">str</span><a class="headerlink" href="#cpl.utils.string.String.convert_to_camel_case" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Converts string to camel case
|
||||
:param chars:
|
||||
:return:</p>
|
||||
<dd><p>Converts string to camel case</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>chars: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>String to convert</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<blockquote>
|
||||
<div><p>String converted to CamelCase</p>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.utils.string.String.convert_to_snake_case">
|
||||
<em class="property"><span class="pre">static</span> </em><code class="sig-name descname"><span class="pre">convert_to_snake_case</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chars</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> → <span class="pre">str</span><a class="headerlink" href="#cpl.utils.string.String.convert_to_snake_case" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Converts string to snake case
|
||||
:param chars:
|
||||
:return:</p>
|
||||
<dd><p>Converts string to snake case</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>chars: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>String to convert</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<blockquote>
|
||||
<div><p>String converted to snake_case</p>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.utils.string.String.first_to_lower">
|
||||
<em class="property"><span class="pre">static</span> </em><code class="sig-name descname"><span class="pre">first_to_lower</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chars</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> → <span class="pre">str</span><a class="headerlink" href="#cpl.utils.string.String.first_to_lower" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Converts first char to lower
|
||||
:param chars:
|
||||
:return:</p>
|
||||
<dd><p>Converts first char to lower</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>chars: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>String to convert</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<blockquote>
|
||||
<div><p>String with first char as lower</p>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.utils.string.String.first_to_upper">
|
||||
<em class="property"><span class="pre">static</span> </em><code class="sig-name descname"><span class="pre">first_to_upper</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chars</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> → <span class="pre">str</span><a class="headerlink" href="#cpl.utils.string.String.first_to_upper" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Converts first char to upper
|
||||
:param chars:
|
||||
:return:</p>
|
||||
<dd><p>Converts first char to upper</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>chars: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>String to convert</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<blockquote>
|
||||
<div><p>String with first char as upper</p>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.utils.string.String.random_string">
|
||||
<em class="property"><span class="pre">static</span> </em><code class="sig-name descname"><span class="pre">random_string</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chars</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">length</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> → <span class="pre">str</span><a class="headerlink" href="#cpl.utils.string.String.random_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates random string by given chars and length</p>
|
||||
<blockquote>
|
||||
<div><p>String of random chars</p>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
2
docs/build/html/searchindex.js
vendored
2
docs/build/html/searchindex.js
vendored
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user