python-terminusgps 31.6.0__tar.gz → 31.7.0__tar.gz

{python_terminusgps-31.6.0 → python_terminusgps-31.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 31.6.0
+Version: 31.7.0
 Summary: Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more.
 Project-URL: Documentation, https://docs.terminusgps.com
 Project-URL: Repository, https://github.com/terminusgps/python-terminusgps

{python_terminusgps-31.6.0 → python_terminusgps-31.7.0}/docs/build/html/_modules/index.html

@@ -12,9 +12,9 @@
   <meta name="theme-color" media="(prefers-color-scheme: light)" content="white" />
   <meta name="theme-color" media="(prefers-color-scheme: dark)" content="black" />
   
-    <title>Overview: module code | python-terminusgps 31.5.1 documentation</title>
-    <meta property="og:title" content="Overview: module code | python-terminusgps 31.5.1 documentation" />
-    <meta name="twitter:title" content="Overview: module code | python-terminusgps 31.5.1 documentation" />
+    <title>Overview: module code | python-terminusgps 31.7.0 documentation</title>
+    <meta property="og:title" content="Overview: module code | python-terminusgps 31.7.0 documentation" />
+    <meta name="twitter:title" content="Overview: module code | python-terminusgps 31.7.0 documentation" />
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d691ff6c" />
       <link rel="stylesheet" type="text/css" href="../_static/theme.css?v=42baaae4" />
       <link rel="stylesheet" type="text/css" href="../_static/autoclasstoc.css?v=08871587" />
@@ -40,7 +40,7 @@
     </a><header
   class="sticky top-0 z-40 w-full border-b shadow-sm border-border supports-backdrop-blur:bg-background/60 bg-background/95 backdrop-blur"><div class="container flex items-center h-14">
     <div class="hidden mr-4 md:flex">
-      <a href="../index.html" class="flex items-center mr-6"><span class="hidden font-bold sm:inline-block text-clip whitespace-nowrap">python-terminusgps 31.5.1 documentation</span>
+      <a href="../index.html" class="flex items-center mr-6"><span class="hidden font-bold sm:inline-block text-clip whitespace-nowrap">python-terminusgps 31.7.0 documentation</span>
       </a></div><button
       class="inline-flex items-center justify-center h-10 px-0 py-2 mr-2 text-base font-medium transition-colors rounded-md hover:text-accent-foreground hover:bg-transparent md:hidden"
       type="button" @click="showSidebar = true">
@@ -95,7 +95,7 @@
   class="fixed inset-y-0 left-0 md:top-14 z-50 md:z-30 bg-background md:bg-transparent transition-all duration-100 -translate-x-full md:translate-x-0 ml-0 p-6 md:p-0 md:-ml-2 md:h-[calc(100vh-3.5rem)] w-5/6 md:w-full shrink-0 overflow-y-auto border-r border-border md:sticky"
   :aria-hidden="!showSidebar" :class="{ 'translate-x-0': showSidebar }">
 
-    <a href="../index.html" class="!justify-start text-sm md:!hidden bg-background"><span class="font-bold text-clip whitespace-nowrap">python-terminusgps 31.5.1 documentation</span>
+    <a href="../index.html" class="!justify-start text-sm md:!hidden bg-background"><span class="font-bold text-clip whitespace-nowrap">python-terminusgps 31.7.0 documentation</span>
     </a>
 
     <div class="relative overflow-hidden md:overflow-auto my-4 md:my-0 h-[calc(100vh-8rem)] md:h-auto">
@@ -153,7 +153,7 @@
      class="flex items-center mb-4 space-x-1 text-sm text-muted-foreground">
   <a class="overflow-hidden text-ellipsis whitespace-nowrap hover:text-foreground"
      href="../index.html">
-    <span class="hidden md:inline">python-terminusgps 31.5.1 documentation</span>
+    <span class="hidden md:inline">python-terminusgps 31.7.0 documentation</span>
     <svg xmlns="http://www.w3.org/2000/svg"
          height="18"
          width="18"
@@ -210,7 +210,7 @@
 </footer>
   </div>
   
-    <script src="../_static/documentation_options.js?v=e25479b2"></script>
+    <script src="../_static/documentation_options.js?v=a5866919"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script defer="defer" src="../_static/theme.js?v=073f68d9"></script>

{python_terminusgps-31.6.0 → python_terminusgps-31.7.0}/docs/build/html/_modules/terminusgps/authorizenet/auth.html

@@ -12,9 +12,9 @@
   <meta name="theme-color" media="(prefers-color-scheme: light)" content="white" />
   <meta name="theme-color" media="(prefers-color-scheme: dark)" content="black" />
   
-    <title>terminusgps.authorizenet.auth | python-terminusgps 21.1.0 documentation</title>
-    <meta property="og:title" content="terminusgps.authorizenet.auth | python-terminusgps 21.1.0 documentation" />
-    <meta name="twitter:title" content="terminusgps.authorizenet.auth | python-terminusgps 21.1.0 documentation" />
+    <title>terminusgps.authorizenet.auth | python-terminusgps 31.6.0 documentation</title>
+    <meta property="og:title" content="terminusgps.authorizenet.auth | python-terminusgps 31.6.0 documentation" />
+    <meta name="twitter:title" content="terminusgps.authorizenet.auth | python-terminusgps 31.6.0 documentation" />
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d691ff6c" />
       <link rel="stylesheet" type="text/css" href="../../../_static/theme.css?v=42baaae4" />
       <link rel="stylesheet" type="text/css" href="../../../_static/autoclasstoc.css?v=08871587" />
@@ -40,7 +40,7 @@
     </a><header
   class="sticky top-0 z-40 w-full border-b shadow-sm border-border supports-backdrop-blur:bg-background/60 bg-background/95 backdrop-blur"><div class="container flex items-center h-14">
     <div class="hidden mr-4 md:flex">
-      <a href="../../../index.html" class="flex items-center mr-6"><span class="hidden font-bold sm:inline-block text-clip whitespace-nowrap">python-terminusgps 21.1.0 documentation</span>
+      <a href="../../../index.html" class="flex items-center mr-6"><span class="hidden font-bold sm:inline-block text-clip whitespace-nowrap">python-terminusgps 31.6.0 documentation</span>
       </a></div><button
       class="inline-flex items-center justify-center h-10 px-0 py-2 mr-2 text-base font-medium transition-colors rounded-md hover:text-accent-foreground hover:bg-transparent md:hidden"
       type="button" @click="showSidebar = true">
@@ -95,14 +95,13 @@
   class="fixed inset-y-0 left-0 md:top-14 z-50 md:z-30 bg-background md:bg-transparent transition-all duration-100 -translate-x-full md:translate-x-0 ml-0 p-6 md:p-0 md:-ml-2 md:h-[calc(100vh-3.5rem)] w-5/6 md:w-full shrink-0 overflow-y-auto border-r border-border md:sticky"
   :aria-hidden="!showSidebar" :class="{ 'translate-x-0': showSidebar }">
 
-    <a href="../../../index.html" class="!justify-start text-sm md:!hidden bg-background"><span class="font-bold text-clip whitespace-nowrap">python-terminusgps 21.1.0 documentation</span>
+    <a href="../../../index.html" class="!justify-start text-sm md:!hidden bg-background"><span class="font-bold text-clip whitespace-nowrap">python-terminusgps 31.6.0 documentation</span>
     </a>
 
     <div class="relative overflow-hidden md:overflow-auto my-4 md:my-0 h-[calc(100vh-8rem)] md:h-auto">
       <div class="overflow-y-auto h-full w-full relative pr-6"><nav class="table w-full min-w-full my-6 lg:my-8">
   <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../../settings.html">Settings</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../authorizenet/index.html">Authorizenet API</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="../../../authorizenet/auth.html">Authorizenet API Authentication</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../../authorizenet/profiles.html">Profiles</a></li>
@@ -111,10 +110,17 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../../aws/index.html">AWS API</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="../../../aws/secrets.html">Secrets</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../aws/utils.html">Utilities</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../../../django/index.html">Django</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../../django/mixins.html">Mixins</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../django/settings.html">Settings</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../../twilio/index.html">Twilio API</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="../../../twilio/caller.html">Caller object</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../twilio/examples.html">Usage Examples</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../../wialon/index.html">Wialon API</a><ul>
@@ -147,7 +153,7 @@
      class="flex items-center mb-4 space-x-1 text-sm text-muted-foreground">
   <a class="overflow-hidden text-ellipsis whitespace-nowrap hover:text-foreground"
      href="../../../index.html">
-    <span class="hidden md:inline">python-terminusgps 21.1.0 documentation</span>
+    <span class="hidden md:inline">python-terminusgps 31.6.0 documentation</span>
     <svg xmlns="http://www.w3.org/2000/svg"
          height="18"
          width="18"
@@ -171,31 +177,56 @@
       <h1>Source code for terminusgps.authorizenet.auth</h1><div class="highlight"><pre>
 <span></span><code><span id="line-1"><span class="kn">from</span><span class="w"> </span><span class="nn">authorizenet.apicontractsv1</span><span class="w"> </span><span class="kn">import</span> <span class="n">merchantAuthenticationType</span>
 </span><span id="line-2"><span class="kn">from</span><span class="w"> </span><span class="nn">authorizenet.constants</span><span class="w"> </span><span class="kn">import</span> <span class="n">constants</span>
-</span><span id="line-3">
-</span><span id="line-4"><span class="kn">from</span><span class="w"> </span><span class="nn">django.conf</span><span class="w"> </span><span class="kn">import</span> <span class="n">settings</span>
-</span><span id="line-5">
+</span><span id="line-3"><span class="kn">from</span><span class="w"> </span><span class="nn">django.conf</span><span class="w"> </span><span class="kn">import</span> <span class="n">settings</span>
+</span><span id="line-4">
+</span><span id="line-5"><span class="kn">from</span><span class="w"> </span><span class="nn">terminusgps.django</span><span class="w"> </span><span class="kn">import</span> <span class="n">settings</span> <span class="k">as</span> <span class="n">default_settings</span>
 </span><span id="line-6">
+</span><span id="line-7"><span class="k">if</span> <span class="ow">not</span> <span class="n">settings</span><span class="o">.</span><span class="n">configured</span><span class="p">:</span>
+</span><span id="line-8">    <span class="n">settings</span><span class="o">.</span><span class="n">configure</span><span class="p">(</span><span class="n">default_settings</span><span class="p">)</span>
+</span><span id="line-9">
+</span><span id="line-10">
 <div class="viewcode-block" id="get_merchant_auth">
 <a class="viewcode-back" href="../../../authorizenet/auth.html#terminusgps.authorizenet.auth.get_merchant_auth">[docs]</a>
-</span><span id="line-7"><span class="k">def</span><span class="w"> </span><span class="nf">get_merchant_auth</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">merchantAuthenticationType</span><span class="p">:</span>
-</span><span id="line-8">    <span class="k">return</span> <span class="n">merchantAuthenticationType</span><span class="p">(</span>
-</span><span id="line-9">        <span class="n">name</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">settings</span><span class="o">.</span><span class="n">MERCHANT_AUTH_LOGIN_ID</span><span class="p">),</span>
-</span><span id="line-10">        <span class="n">transactionKey</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">settings</span><span class="o">.</span><span class="n">MERCHANT_AUTH_TRANSACTION_KEY</span><span class="p">),</span>
-</span><span id="line-11">    <span class="p">)</span></div>
+</span><span id="line-11"><span class="k">def</span><span class="w"> </span><span class="nf">get_merchant_auth</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">merchantAuthenticationType</span><span class="p">:</span>
+</span><span id="line-12"><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+</span><span id="line-13"><span class="sd">    Returns the merchant authentication information for Authorizenet API requests.</span>
+</span><span id="line-14">
+</span><span id="line-15"><span class="sd">    :returns: A merchant authentication object.</span>
+</span><span id="line-16"><span class="sd">    :rtype: :py:obj:`~authorizenet.apicontractsv1.merchantAuthenticationType`</span>
+</span><span id="line-17">
+</span><span id="line-18"><span class="sd">    &quot;&quot;&quot;</span>
+</span><span id="line-19">    <span class="k">return</span> <span class="n">merchantAuthenticationType</span><span class="p">(</span>
+</span><span id="line-20">        <span class="n">name</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">settings</span><span class="o">.</span><span class="n">MERCHANT_AUTH_LOGIN_ID</span><span class="p">),</span>
+</span><span id="line-21">        <span class="n">transactionKey</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">settings</span><span class="o">.</span><span class="n">MERCHANT_AUTH_TRANSACTION_KEY</span><span class="p">),</span>
+</span><span id="line-22">    <span class="p">)</span></div>
 
-</span><span id="line-12">
-</span><span id="line-13">
+</span><span id="line-23">
+</span><span id="line-24">
 <div class="viewcode-block" id="get_environment">
 <a class="viewcode-back" href="../../../authorizenet/auth.html#terminusgps.authorizenet.auth.get_environment">[docs]</a>
-</span><span id="line-14"><span class="k">def</span><span class="w"> </span><span class="nf">get_environment</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
-</span><span id="line-15">    <span class="k">return</span> <span class="n">constants</span><span class="o">.</span><span class="n">SANDBOX</span> <span class="k">if</span> <span class="n">settings</span><span class="o">.</span><span class="n">DEBUG</span> <span class="k">else</span> <span class="n">constants</span><span class="o">.</span><span class="n">PRODUCTION</span></div>
+</span><span id="line-25"><span class="k">def</span><span class="w"> </span><span class="nf">get_environment</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
+</span><span id="line-26"><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+</span><span id="line-27"><span class="sd">    Returns the environment for Authorizenet API requests.</span>
+</span><span id="line-28">
+</span><span id="line-29"><span class="sd">    :returns: An Authorizenet API environment string.</span>
+</span><span id="line-30"><span class="sd">    :rtype: :py:obj:`str`</span>
+</span><span id="line-31">
+</span><span id="line-32"><span class="sd">    &quot;&quot;&quot;</span>
+</span><span id="line-33">    <span class="k">return</span> <span class="n">constants</span><span class="o">.</span><span class="n">SANDBOX</span> <span class="k">if</span> <span class="n">settings</span><span class="o">.</span><span class="n">DEBUG</span> <span class="k">else</span> <span class="n">constants</span><span class="o">.</span><span class="n">PRODUCTION</span></div>
 
-</span><span id="line-16">
-</span><span id="line-17">
+</span><span id="line-34">
+</span><span id="line-35">
 <div class="viewcode-block" id="get_validation_mode">
 <a class="viewcode-back" href="../../../authorizenet/auth.html#terminusgps.authorizenet.auth.get_validation_mode">[docs]</a>
-</span><span id="line-18"><span class="k">def</span><span class="w"> </span><span class="nf">get_validation_mode</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
-</span><span id="line-19">    <span class="k">return</span> <span class="s2">&quot;testMode&quot;</span> <span class="k">if</span> <span class="n">settings</span><span class="o">.</span><span class="n">DEBUG</span> <span class="k">else</span> <span class="s2">&quot;liveMode&quot;</span></div>
+</span><span id="line-36"><span class="k">def</span><span class="w"> </span><span class="nf">get_validation_mode</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
+</span><span id="line-37"><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+</span><span id="line-38"><span class="sd">    Returns the validation mode for Authorizenet API requests.</span>
+</span><span id="line-39">
+</span><span id="line-40"><span class="sd">    :returns: An Authorizenet API validation string.</span>
+</span><span id="line-41"><span class="sd">    :rtype: :py:obj:`str`</span>
+</span><span id="line-42">
+</span><span id="line-43"><span class="sd">    &quot;&quot;&quot;</span>
+</span><span id="line-44">    <span class="k">return</span> <span class="s2">&quot;testMode&quot;</span> <span class="k">if</span> <span class="n">settings</span><span class="o">.</span><span class="n">DEBUG</span> <span class="k">else</span> <span class="s2">&quot;liveMode&quot;</span></div>
 
 </span></code></pre></div>
     </div></div>
@@ -212,7 +243,7 @@
 </footer>
   </div>
   
-    <script src="../../../_static/documentation_options.js?v=c54a4614"></script>
+    <script src="../../../_static/documentation_options.js?v=d4532340"></script>
     <script src="../../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script defer="defer" src="../../../_static/theme.js?v=073f68d9"></script>