python-terminusgps 31.0.0__tar.gz → 31.0.1__tar.gz

{python_terminusgps-31.0.0 → python_terminusgps-31.0.1}/PKG-INFO

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

{python_terminusgps-31.0.0 → python_terminusgps-31.0.1}/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 30.1.0 documentation</title>
-    <meta property="og:title" content="Overview: module code | python-terminusgps 30.1.0 documentation" />
-    <meta name="twitter:title" content="Overview: module code | python-terminusgps 30.1.0 documentation" />
+    <title>Overview: module code | python-terminusgps 31.0.1 documentation</title>
+    <meta property="og:title" content="Overview: module code | python-terminusgps 31.0.1 documentation" />
+    <meta name="twitter:title" content="Overview: module code | python-terminusgps 31.0.1 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 30.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.0.1 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 30.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.0.1 documentation</span>
     </a>
 
     <div class="relative overflow-hidden md:overflow-auto my-4 md:my-0 h-[calc(100vh-8rem)] md:h-auto">
@@ -119,6 +119,7 @@
 </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>
@@ -151,7 +152,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 30.1.0 documentation</span>
+    <span class="hidden md:inline">python-terminusgps 31.0.1 documentation</span>
     <svg xmlns="http://www.w3.org/2000/svg"
          height="18"
          width="18"
@@ -208,7 +209,7 @@
 </footer>
   </div>
   
-    <script src="../_static/documentation_options.js?v=a778edc8"></script>
+    <script src="../_static/documentation_options.js?v=8fa51cce"></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.0.0 → python_terminusgps-31.0.1}/docs/build/html/_modules/terminusgps/twilio/caller.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.twilio.caller | python-terminusgps 24.2.0 documentation</title>
-    <meta property="og:title" content="terminusgps.twilio.caller | python-terminusgps 24.2.0 documentation" />
-    <meta name="twitter:title" content="terminusgps.twilio.caller | python-terminusgps 24.2.0 documentation" />
+    <title>terminusgps.twilio.caller | python-terminusgps 31.0.0 documentation</title>
+    <meta property="og:title" content="terminusgps.twilio.caller | python-terminusgps 31.0.0 documentation" />
+    <meta name="twitter:title" content="terminusgps.twilio.caller | python-terminusgps 31.0.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 24.2.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.0.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 24.2.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.0.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>
@@ -113,8 +112,14 @@
 <li class="toctree-l2"><a class="reference internal" href="../../../aws/secrets.html">Secrets</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 +152,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 24.2.0 documentation</span>
+    <span class="hidden md:inline">python-terminusgps 31.0.0 documentation</span>
     <svg xmlns="http://www.w3.org/2000/svg"
          height="18"
          width="18"
@@ -190,98 +195,152 @@
 <div class="viewcode-block" id="TwilioCaller">
 <a class="viewcode-back" href="../../../twilio/caller.html#terminusgps.twilio.caller.TwilioCaller">[docs]</a>
 </span><span id="line-19"><span class="k">class</span><span class="w"> </span><span class="nc">TwilioCaller</span><span class="p">:</span>
-</span><span id="line-20">    <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
-</span><span id="line-21"><span class="w">        </span><span class="sd">&quot;&quot;&quot;Sets Twilio messaging session variables.&quot;&quot;&quot;</span>
-</span><span id="line-22">        <span class="bp">self</span><span class="o">.</span><span class="n">client_sid</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">TWILIO_SID</span>
-</span><span id="line-23">        <span class="bp">self</span><span class="o">.</span><span class="n">client_token</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">TWILIO_TOKEN</span>
-</span><span id="line-24">        <span class="bp">self</span><span class="o">.</span><span class="n">from_number</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">TWILIO_FROM_NUMBER</span>
-</span><span id="line-25">        <span class="bp">self</span><span class="o">.</span><span class="n">messaging_sid</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">TWILIO_MESSAGING_SID</span>
-</span><span id="line-26">
-</span><span id="line-27">    <span class="k">def</span><span class="w"> </span><span class="fm">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s2">&quot;TwilioCaller&quot;</span><span class="p">:</span>
-</span><span id="line-28"><span class="w">        </span><span class="sd">&quot;&quot;&quot;Creates an asyncronous Twilio client.&quot;&quot;&quot;</span>
-</span><span id="line-29">        <span class="bp">self</span><span class="o">.</span><span class="n">client</span> <span class="o">=</span> <span class="n">twilio</span><span class="o">.</span><span class="n">rest</span><span class="o">.</span><span class="n">Client</span><span class="p">(</span>
-</span><span id="line-30">            <span class="bp">self</span><span class="o">.</span><span class="n">client_sid</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">client_token</span><span class="p">,</span> <span class="n">http_client</span><span class="o">=</span><span class="n">AsyncTwilioHttpClient</span><span class="p">()</span>
-</span><span id="line-31">        <span class="p">)</span>
-</span><span id="line-32">        <span class="k">return</span> <span class="bp">self</span>
-</span><span id="line-33">
-</span><span id="line-34">    <span class="k">def</span><span class="w"> </span><span class="fm">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exc_type</span><span class="p">,</span> <span class="n">exc_value</span><span class="p">,</span> <span class="n">exc_tb</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
-</span><span id="line-35">        <span class="k">return</span> <span class="kc">None</span>
-</span><span id="line-36">
+</span><span id="line-20">    <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
+</span><span id="line-21">        <span class="bp">self</span><span class="p">,</span>
+</span><span id="line-22">        <span class="n">client_sid</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
+</span><span id="line-23">        <span class="n">client_token</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
+</span><span id="line-24">        <span class="n">from_number</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
+</span><span id="line-25">        <span class="n">messaging_sid</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
+</span><span id="line-26">    <span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+</span><span id="line-27"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+</span><span id="line-28"><span class="sd">        Sets Twilio client session variables.</span>
+</span><span id="line-29">
+</span><span id="line-30"><span class="sd">        All parameters are optional, default values are pulled from a Django settings module.</span>
+</span><span id="line-31">
+</span><span id="line-32"><span class="sd">        :param client_sid: A Twilio client session id.</span>
+</span><span id="line-33"><span class="sd">        :type client_sid: :py:obj:`str` | :py:obj:`None`</span>
+</span><span id="line-34"><span class="sd">        :param client_token: A Twilio client API token.</span>
+</span><span id="line-35"><span class="sd">        :type client_token: :py:obj:`str` | :py:obj:`None`</span>
+</span><span id="line-36"><span class="sd">        :param from_number: Phone number used to send notifications.</span>
+</span><span id="line-37"><span class="sd">        :type from_number: :py:obj:`str` | :py:obj:`None`</span>
+</span><span id="line-38"><span class="sd">        :param messaging_sid: A Twilio client messaging service session id.</span>
+</span><span id="line-39"><span class="sd">        :type messaging_sid: :py:obj:`str` | :py:obj:`None`</span>
+</span><span id="line-40"><span class="sd">        :returns: Nothing.</span>
+</span><span id="line-41"><span class="sd">        :rtype: :py:obj:`None`</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="bp">self</span><span class="o">.</span><span class="n">_client_sid</span> <span class="o">=</span> <span class="n">client_sid</span> <span class="ow">or</span> <span class="n">settings</span><span class="o">.</span><span class="n">TWILIO_SID</span>
+</span><span id="line-45">        <span class="bp">self</span><span class="o">.</span><span class="n">_client_token</span> <span class="o">=</span> <span class="n">client_token</span> <span class="ow">or</span> <span class="n">settings</span><span class="o">.</span><span class="n">TWILIO_TOKEN</span>
+</span><span id="line-46">        <span class="bp">self</span><span class="o">.</span><span class="n">_from_number</span> <span class="o">=</span> <span class="n">from_number</span> <span class="ow">or</span> <span class="n">settings</span><span class="o">.</span><span class="n">TWILIO_FROM_NUMBER</span>
+</span><span id="line-47">        <span class="bp">self</span><span class="o">.</span><span class="n">_messaging_sid</span> <span class="o">=</span> <span class="n">messaging_sid</span> <span class="ow">or</span> <span class="n">settings</span><span class="o">.</span><span class="n">TWILIO_MESSAGING_SID</span>
+</span><span id="line-48">
+</span><span id="line-49">    <span class="k">def</span><span class="w"> </span><span class="fm">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s2">&quot;TwilioCaller&quot;</span><span class="p">:</span>
+</span><span id="line-50"><span class="w">        </span><span class="sd">&quot;&quot;&quot;Opens a context manager and creates an asyncronous Twilio client.&quot;&quot;&quot;</span>
+</span><span id="line-51">        <span class="bp">self</span><span class="o">.</span><span class="n">client</span> <span class="o">=</span> <span class="n">twilio</span><span class="o">.</span><span class="n">rest</span><span class="o">.</span><span class="n">Client</span><span class="p">(</span>
+</span><span id="line-52">            <span class="bp">self</span><span class="o">.</span><span class="n">client_sid</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client_token</span><span class="p">,</span> <span class="n">http_client</span><span class="o">=</span><span class="n">AsyncTwilioHttpClient</span><span class="p">()</span>
+</span><span id="line-53">        <span class="p">)</span>
+</span><span id="line-54">        <span class="k">return</span> <span class="bp">self</span>
+</span><span id="line-55">
+</span><span id="line-56">    <span class="k">def</span><span class="w"> </span><span class="fm">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exc_type</span><span class="p">,</span> <span class="n">exc_value</span><span class="p">,</span> <span class="n">exc_tb</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+</span><span id="line-57"><span class="w">        </span><span class="sd">&quot;&quot;&quot;Closes the context manager.&quot;&quot;&quot;</span>
+</span><span id="line-58">        <span class="k">return</span> <span class="kc">None</span>
+</span><span id="line-59">
 <div class="viewcode-block" id="TwilioCaller.create_notification">
 <a class="viewcode-back" href="../../../twilio/caller.html#terminusgps.twilio.caller.TwilioCaller.create_notification">[docs]</a>
-</span><span id="line-37">    <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">create_notification</span><span class="p">(</span>
-</span><span id="line-38">        <span class="bp">self</span><span class="p">,</span> <span class="n">to_number</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">message</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">method</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;sms&quot;</span>
-</span><span id="line-39">    <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">Task</span><span class="p">[</span><span class="n">Any</span><span class="p">]:</span>
-</span><span id="line-40"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
-</span><span id="line-41"><span class="sd">        Returns an awaitable notification task.</span>
-</span><span id="line-42">
-</span><span id="line-43"><span class="sd">        Available methods are ``&quot;sms&quot;``, ``&quot;call&quot;`` and ``&quot;phone&quot;``.</span>
-</span><span id="line-44">
-</span><span id="line-45"><span class="sd">        :param to_number: A phone number to notify.</span>
-</span><span id="line-46"><span class="sd">        :type to_number: :py:obj:`str`</span>
-</span><span id="line-47"><span class="sd">        :param message: A notification message.</span>
-</span><span id="line-48"><span class="sd">        :type message: :py:obj:`str`</span>
-</span><span id="line-49"><span class="sd">        :param method: A notification method. Default is ``&quot;sms&quot;``.</span>
-</span><span id="line-50"><span class="sd">        :type method: :py:obj:`str`</span>
-</span><span id="line-51"><span class="sd">        :returns: An awaitable task.</span>
-</span><span id="line-52"><span class="sd">        :rtype: :py:obj:`~asyncio.Task`</span>
-</span><span id="line-53">
-</span><span id="line-54"><span class="sd">        &quot;&quot;&quot;</span>
-</span><span id="line-55">        <span class="k">match</span> <span class="n">method</span><span class="p">:</span>
-</span><span id="line-56">            <span class="k">case</span> <span class="s2">&quot;sms&quot;</span><span class="p">:</span>
-</span><span id="line-57">                <span class="k">return</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">create_task</span><span class="p">(</span>
-</span><span id="line-58">                    <span class="bp">self</span><span class="o">.</span><span class="n">create_sms</span><span class="p">(</span><span class="n">to_number</span><span class="o">=</span><span class="n">to_number</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="n">message</span><span class="p">)</span>
-</span><span id="line-59">                <span class="p">)</span>
-</span><span id="line-60">            <span class="k">case</span> <span class="s2">&quot;call&quot;</span> <span class="o">|</span> <span class="s2">&quot;phone&quot;</span><span class="p">:</span>
-</span><span id="line-61">                <span class="k">return</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">create_task</span><span class="p">(</span>
-</span><span id="line-62">                    <span class="bp">self</span><span class="o">.</span><span class="n">create_call</span><span class="p">(</span><span class="n">to_number</span><span class="o">=</span><span class="n">to_number</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="n">message</span><span class="p">)</span>
-</span><span id="line-63">                <span class="p">)</span>
-</span><span id="line-64">            <span class="k">case</span><span class="w"> </span><span class="k">_</span><span class="p">:</span>
-</span><span id="line-65">                <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Unsupported TwilioCaller method &#39;</span><span class="si">{</span><span class="n">method</span><span class="si">}</span><span class="s2">&#39;.&quot;</span><span class="p">)</span></div>
+</span><span id="line-60">    <span class="k">def</span><span class="w"> </span><span class="nf">create_notification</span><span class="p">(</span>
+</span><span id="line-61">        <span class="bp">self</span><span class="p">,</span> <span class="n">to_number</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">message</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">method</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;sms&quot;</span>
+</span><span id="line-62">    <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">Task</span><span class="p">[</span><span class="n">Any</span><span class="p">]:</span>
+</span><span id="line-63"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+</span><span id="line-64"><span class="sd">        Returns an awaitable notification task.</span>
+</span><span id="line-65">
+</span><span id="line-66"><span class="sd">        Valid methods are ``&quot;sms&quot;``, ``&quot;call&quot;`` and ``&quot;phone&quot;``.</span>
+</span><span id="line-67">
+</span><span id="line-68"><span class="sd">        :param to_number: A phone number to notify.</span>
+</span><span id="line-69"><span class="sd">        :type to_number: :py:obj:`str`</span>
+</span><span id="line-70"><span class="sd">        :param message: A notification message.</span>
+</span><span id="line-71"><span class="sd">        :type message: :py:obj:`str`</span>
+</span><span id="line-72"><span class="sd">        :param method: A notification method. Default is ``&quot;sms&quot;``.</span>
+</span><span id="line-73"><span class="sd">        :type method: :py:obj:`str`</span>
+</span><span id="line-74"><span class="sd">        :raises ValueError: If ``method`` is invalid.</span>
+</span><span id="line-75"><span class="sd">        :returns: An awaitable task.</span>
+</span><span id="line-76"><span class="sd">        :rtype: :py:obj:`~asyncio.Task`</span>
+</span><span id="line-77">
+</span><span id="line-78"><span class="sd">        &quot;&quot;&quot;</span>
+</span><span id="line-79">        <span class="k">match</span> <span class="n">method</span><span class="p">:</span>
+</span><span id="line-80">            <span class="k">case</span> <span class="s2">&quot;sms&quot;</span><span class="p">:</span>
+</span><span id="line-81">                <span class="k">return</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">create_task</span><span class="p">(</span>
+</span><span id="line-82">                    <span class="bp">self</span><span class="o">.</span><span class="n">create_sms</span><span class="p">(</span><span class="n">to_number</span><span class="o">=</span><span class="n">to_number</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="n">message</span><span class="p">)</span>
+</span><span id="line-83">                <span class="p">)</span>
+</span><span id="line-84">            <span class="k">case</span> <span class="s2">&quot;call&quot;</span> <span class="o">|</span> <span class="s2">&quot;phone&quot;</span><span class="p">:</span>
+</span><span id="line-85">                <span class="k">return</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">create_task</span><span class="p">(</span>
+</span><span id="line-86">                    <span class="bp">self</span><span class="o">.</span><span class="n">create_call</span><span class="p">(</span><span class="n">to_number</span><span class="o">=</span><span class="n">to_number</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="n">message</span><span class="p">)</span>
+</span><span id="line-87">                <span class="p">)</span>
+</span><span id="line-88">            <span class="k">case</span><span class="w"> </span><span class="k">_</span><span class="p">:</span>
+</span><span id="line-89">                <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Unsupported TwilioCaller method &#39;</span><span class="si">{</span><span class="n">method</span><span class="si">}</span><span class="s2">&#39;.&quot;</span><span class="p">)</span></div>
 
-</span><span id="line-66">
+</span><span id="line-90">
 <div class="viewcode-block" id="TwilioCaller.create_call">
 <a class="viewcode-back" href="../../../twilio/caller.html#terminusgps.twilio.caller.TwilioCaller.create_call">[docs]</a>
-</span><span id="line-67">    <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">create_call</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">to_number</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">message</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
-</span><span id="line-68"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
-</span><span id="line-69"><span class="sd">        Calls ``to_number`` and reads ``message`` aloud.</span>
-</span><span id="line-70">
-</span><span id="line-71"><span class="sd">        :param to_number: A phone number.</span>
-</span><span id="line-72"><span class="sd">        :type to_number: :py:obj:`str`</span>
-</span><span id="line-73"><span class="sd">        :param message: A message to be read aloud.</span>
-</span><span id="line-74"><span class="sd">        :type message: :py:obj:`str`</span>
-</span><span id="line-75"><span class="sd">        :returns: Nothing.</span>
-</span><span id="line-76"><span class="sd">        :rtype: :py:obj:`None`</span>
-</span><span id="line-77">
-</span><span id="line-78"><span class="sd">        &quot;&quot;&quot;</span>
-</span><span id="line-79">        <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">calls</span><span class="o">.</span><span class="n">create_async</span><span class="p">(</span>
-</span><span id="line-80">            <span class="n">to</span><span class="o">=</span><span class="n">to_number</span><span class="p">,</span>
-</span><span id="line-81">            <span class="n">from_</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">from_number</span><span class="p">,</span>
-</span><span id="line-82">            <span class="n">twiml</span><span class="o">=</span><span class="sa">f</span><span class="s2">&quot;&lt;Response&gt;&lt;Say&gt;</span><span class="si">{</span><span class="n">message</span><span class="si">}</span><span class="s2">&lt;/Say&gt;&lt;/Response&gt;&quot;</span><span class="p">,</span>
-</span><span id="line-83">        <span class="p">)</span></div>
+</span><span id="line-91">    <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">create_call</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">to_number</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">message</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+</span><span id="line-92"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+</span><span id="line-93"><span class="sd">        Calls ``to_number`` and reads ``message`` aloud.</span>
+</span><span id="line-94">
+</span><span id="line-95"><span class="sd">        :param to_number: A phone number.</span>
+</span><span id="line-96"><span class="sd">        :type to_number: :py:obj:`str`</span>
+</span><span id="line-97"><span class="sd">        :param message: A message to be read aloud.</span>
+</span><span id="line-98"><span class="sd">        :type message: :py:obj:`str`</span>
+</span><span id="line-99"><span class="sd">        :returns: Nothing.</span>
+</span><span id="line-100"><span class="sd">        :rtype: :py:obj:`None`</span>
+</span><span id="line-101">
+</span><span id="line-102"><span class="sd">        &quot;&quot;&quot;</span>
+</span><span id="line-103">        <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">calls</span><span class="o">.</span><span class="n">create_async</span><span class="p">(</span>
+</span><span id="line-104">            <span class="n">to</span><span class="o">=</span><span class="n">to_number</span><span class="p">,</span>
+</span><span id="line-105">            <span class="n">from_</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">from_number</span><span class="p">,</span>
+</span><span id="line-106">            <span class="n">twiml</span><span class="o">=</span><span class="sa">f</span><span class="s2">&quot;&lt;Response&gt;&lt;Say&gt;</span><span class="si">{</span><span class="n">message</span><span class="si">}</span><span class="s2">&lt;/Say&gt;&lt;/Response&gt;&quot;</span><span class="p">,</span>
+</span><span id="line-107">        <span class="p">)</span></div>
 
-</span><span id="line-84">
+</span><span id="line-108">
 <div class="viewcode-block" id="TwilioCaller.create_sms">
 <a class="viewcode-back" href="../../../twilio/caller.html#terminusgps.twilio.caller.TwilioCaller.create_sms">[docs]</a>
-</span><span id="line-85">    <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">create_sms</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">to_number</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">message</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
-</span><span id="line-86"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
-</span><span id="line-87"><span class="sd">        Texts ``message`` to ``to_number``.</span>
-</span><span id="line-88">
-</span><span id="line-89"><span class="sd">        :param to_number: A phone number.</span>
-</span><span id="line-90"><span class="sd">        :type to_number: :py:obj:`str`</span>
-</span><span id="line-91"><span class="sd">        :param message: A message to be texted.</span>
-</span><span id="line-92"><span class="sd">        :type message: :py:obj:`str`</span>
-</span><span id="line-93"><span class="sd">        :returns: Nothing.</span>
-</span><span id="line-94"><span class="sd">        :rtype: :py:obj:`None`</span>
-</span><span id="line-95">
-</span><span id="line-96"><span class="sd">        &quot;&quot;&quot;</span>
-</span><span id="line-97">        <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">messages</span><span class="o">.</span><span class="n">create_async</span><span class="p">(</span>
-</span><span id="line-98">            <span class="n">to</span><span class="o">=</span><span class="n">to_number</span><span class="p">,</span>
-</span><span id="line-99">            <span class="n">from_</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">from_number</span><span class="p">,</span>
-</span><span id="line-100">            <span class="n">body</span><span class="o">=</span><span class="n">message</span><span class="p">,</span>
-</span><span id="line-101">            <span class="n">messaging_service_sid</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">messaging_sid</span><span class="p">,</span>
-</span><span id="line-102">        <span class="p">)</span></div>
-</div>
+</span><span id="line-109">    <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">create_sms</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">to_number</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">message</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+</span><span id="line-110"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+</span><span id="line-111"><span class="sd">        Texts ``message`` to ``to_number``.</span>
+</span><span id="line-112">
+</span><span id="line-113"><span class="sd">        :param to_number: A phone number.</span>
+</span><span id="line-114"><span class="sd">        :type to_number: :py:obj:`str`</span>
+</span><span id="line-115"><span class="sd">        :param message: A message to be texted.</span>
+</span><span id="line-116"><span class="sd">        :type message: :py:obj:`str`</span>
+</span><span id="line-117"><span class="sd">        :returns: Nothing.</span>
+</span><span id="line-118"><span class="sd">        :rtype: :py:obj:`None`</span>
+</span><span id="line-119">
+</span><span id="line-120"><span class="sd">        &quot;&quot;&quot;</span>
+</span><span id="line-121">        <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">messages</span><span class="o">.</span><span class="n">create_async</span><span class="p">(</span>
+</span><span id="line-122">            <span class="n">to</span><span class="o">=</span><span class="n">to_number</span><span class="p">,</span>
+</span><span id="line-123">            <span class="n">from_</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">from_number</span><span class="p">,</span>
+</span><span id="line-124">            <span class="n">body</span><span class="o">=</span><span class="n">message</span><span class="p">,</span>
+</span><span id="line-125">            <span class="n">messaging_service_sid</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">messaging_sid</span><span class="p">,</span>
+</span><span id="line-126">        <span class="p">)</span></div>
+
+</span><span id="line-127">
+</span><span id="line-128">    <span class="nd">@property</span>
+</span><span id="line-129">    <span class="k">def</span><span class="w"> </span><span class="nf">client_sid</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
+</span><span id="line-130"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+</span><span id="line-131"><span class="sd">        Client session id.</span>
+</span><span id="line-132">
+</span><span id="line-133"><span class="sd">        :type: :py:obj:`str`</span>
+</span><span id="line-134">
+</span><span id="line-135"><span class="sd">        &quot;&quot;&quot;</span>
+</span><span id="line-136">        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client_sid</span>
+</span><span id="line-137">
+</span><span id="line-138">    <span class="nd">@property</span>
+</span><span id="line-139">    <span class="k">def</span><span class="w"> </span><span class="nf">from_number</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
+</span><span id="line-140"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+</span><span id="line-141"><span class="sd">        Origin phone number.</span>
+</span><span id="line-142">
+</span><span id="line-143"><span class="sd">        :type: :py:obj:`str`</span>
+</span><span id="line-144">
+</span><span id="line-145"><span class="sd">        &quot;&quot;&quot;</span>
+</span><span id="line-146">        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_from_number</span>
+</span><span id="line-147">
+</span><span id="line-148">    <span class="nd">@property</span>
+</span><span id="line-149">    <span class="k">def</span><span class="w"> </span><span class="nf">messaging_sid</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
+</span><span id="line-150"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+</span><span id="line-151"><span class="sd">        Messaging service session id.</span>
+</span><span id="line-152">
+</span><span id="line-153"><span class="sd">        :type: :py:obj:`str`</span>
+</span><span id="line-154">
+</span><span id="line-155"><span class="sd">        &quot;&quot;&quot;</span>
+</span><span id="line-156">        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_messaging_sid</span></div>
 
 </span></code></pre></div>
     </div></div>
@@ -298,7 +357,7 @@
 </footer>
   </div>
   
-    <script src="../../../_static/documentation_options.js?v=e9675623"></script>
+    <script src="../../../_static/documentation_options.js?v=2bdd98d7"></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.0.1/docs/build/html/_sources/django/index.rst.txt

@@ -0,0 +1,11 @@
+Django
+======
+
+:py:mod:`terminusgps` offers the :py:mod:`~terminusgps.django` package that offers mixins, templatetags and more for use in Django web applications.
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Contents:
+
+    mixins.rst
+    settings.rst

python_terminusgps-31.0.1/docs/build/html/_sources/twilio/examples.rst.txt

@@ -0,0 +1,77 @@
+Usage Examples
+==============
+
+=====================================
+Send an SMS message to a phone number
+=====================================
+
+.. code:: python
+
+    import asyncio
+
+    from terminusgps.twilio.caller import TwilioCaller
+
+
+    async def main() -> None:
+        phone: str = "+15555555555"
+        msg: str = "Hello from Terminus GPS!"
+        method: str = "sms" # Optional in this case, "sms" is default.
+        with TwilioCaller() as caller:
+            task = caller.create_notification(to_number=phone, message=msg)
+            await task
+
+
+    if __name__ == "__main__":
+        asyncio.run(main())
+
+===========================================
+Send SMS messages to multiple phone numbers
+===========================================
+
+.. code:: python
+
+    import asyncio
+
+    from terminusgps.twilio.caller import TwilioCaller
+
+    def main() -> None:
+        phones: str = ["+17135555555", "+18325555555"]
+        msg: str = "Hello from Terminus GPS!"
+        method: str = "sms" # Optional in this case, "sms" is default.
+        with TwilioCaller() as caller:
+            tasks = [
+                caller.create_notification(
+                    to_number=num, message="Hello from Terminus GPS!", method=method
+                )
+                for num in phones
+            ]
+            asyncio.gather(*tasks)
+
+    if __name__ == "__main__":
+        main()
+
+========================================
+Call phone number and read message aloud
+========================================
+
+.. code:: python
+
+    import asyncio
+
+    from terminusgps.twilio.caller import TwilioCaller
+
+    def main() -> None:
+        phone: str = "+15555555555"
+        msg: str = "Hello from Terminus GPS!"
+        method: str = "call" # "phone" is an alias for "call", so "phone" would work, too
+        with TwilioCaller() as caller:
+            tasks = [
+                caller.create_notification(
+                    to_number=num, message="Hello from Terminus GPS!", method=method
+                )
+                for num in phones
+            ]
+            asyncio.gather(*tasks)
+
+    if __name__ == "__main__":
+        main()

{python_terminusgps-31.0.0 → python_terminusgps-31.0.1}/docs/build/html/_sources/twilio/index.rst.txt

@@ -8,3 +8,4 @@ Twilio API
     :caption: Contents:
 
     caller.rst
+    examples.rst

{python_terminusgps-31.0.0 → python_terminusgps-31.0.1}/docs/build/html/_static/documentation_options.js

@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '30.1.0',
+    VERSION: '31.0.1',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',