python-terminusgps 24.4.0__tar.gz → 25.0.0__tar.gz

{python_terminusgps-24.4.0 → python_terminusgps-25.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 24.4.0
+Version: 25.0.0
 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-24.4.0 → python_terminusgps-25.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "24.4.0"
+version = "25.0.0"
 description = "Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more."
 readme = "README.md"
 authors = [ {name = "Blake Nall", email = "blake@terminusgps.com" } ]

python_terminusgps-25.0.0/terminusgps/twilio/caller.py

@@ -0,0 +1,102 @@
+import asyncio
+from typing import Any
+
+import twilio.rest
+from django.conf import settings
+from django.core.exceptions import ImproperlyConfigured
+from twilio.http.async_http_client import AsyncTwilioHttpClient
+
+if not hasattr(settings, "TWILIO_SID"):
+    raise ImproperlyConfigured("'TWILIO_SID' setting is required.")
+if not hasattr(settings, "TWILIO_TOKEN"):
+    raise ImproperlyConfigured("'TWILIO_TOKEN' setting is required.")
+if not hasattr(settings, "TWILIO_FROM_NUMBER"):
+    raise ImproperlyConfigured("'TWILIO_FROM_NUMBER' setting is required.")
+if not hasattr(settings, "TWILIO_MESSAGING_SID"):
+    raise ImproperlyConfigured("'TWILIO_MESSAGING_SID' setting is required.")
+
+
+class TwilioCaller:
+    def __init__(self) -> None:
+        """Sets Twilio messaging session variables."""
+        self.client_sid = settings.TWILIO_SID
+        self.client_token = settings.TWILIO_TOKEN
+        self.from_number = settings.TWILIO_FROM_NUMBER
+        self.messaging_sid = settings.TWILIO_MESSAGING_SID
+
+    def __enter__(self) -> "TwilioCaller":
+        """Creates an asyncronous Twilio client."""
+        self.client = twilio.rest.Client(
+            self.client_sid, self.client_token, http_client=AsyncTwilioHttpClient()
+        )
+        return self
+
+    def __exit__(self, exc_type, exc_value, exc_tb) -> None:
+        return None
+
+    async def create_notification(
+        self, to_number: str, message: str, method: str = "sms"
+    ) -> asyncio.Task[Any]:
+        """
+        Returns an awaitable notification task.
+
+        Available methods are ``"sms"``, ``"call"`` and ``"phone"``.
+
+        :param to_number: A phone number to notify.
+        :type to_number: :py:obj:`str`
+        :param message: A notification message.
+        :type message: :py:obj:`str`
+        :param method: A notification method. Default is ``"sms"``.
+        :type method: :py:obj:`str`
+        :returns: An awaitable task.
+        :rtype: :py:obj:`~asyncio.Task`
+
+        """
+        match method:
+            case "sms":
+                return asyncio.create_task(
+                    self.create_sms(to_number=to_number, message=message)
+                )
+            case "call" | "phone":
+                return asyncio.create_task(
+                    self.create_call(to_number=to_number, message=message)
+                )
+            case _:
+                raise ValueError(f"Unsupported TwilioCaller method '{method}'.")
+
+    async def create_call(self, to_number: str, message: str) -> None:
+        """
+        Calls ``to_number`` and reads ``message`` aloud.
+
+        :param to_number: A phone number.
+        :type to_number: :py:obj:`str`
+        :param message: A message to be read aloud.
+        :type message: :py:obj:`str`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        await self.client.calls.create_async(
+            to=to_number,
+            from_=self.from_number,
+            twiml=f"<Response><Say>{message}</Say></Response>",
+        )
+
+    async def create_sms(self, to_number: str, message: str) -> None:
+        """
+        Texts ``message`` to ``to_number``.
+
+        :param to_number: A phone number.
+        :type to_number: :py:obj:`str`
+        :param message: A message to be texted.
+        :type message: :py:obj:`str`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        await self.client.messages.create_async(
+            to=to_number,
+            from_=self.from_number,
+            body=message,
+            messaging_service_sid=self.messaging_sid,
+        )

{python_terminusgps-24.4.0 → python_terminusgps-25.0.0}/uv.lock

@@ -848,7 +848,7 @@ wheels = [
 
 [[package]]
 name = "python-terminusgps"
-version = "24.4.0"
+version = "25.0.0"
 source = { editable = "." }
 dependencies = [
     { name = "argparse" },

python_terminusgps-24.4.0/terminusgps/twilio/caller.py

@@ -1,63 +0,0 @@
-import asyncio
-import logging
-from typing import Any
-
-import twilio.rest
-from django.conf import settings
-from twilio.http.async_http_client import AsyncTwilioHttpClient
-
-from terminusgps.twilio.logger import TwilioLogger
-
-
-class TwilioCaller:
-    def __init__(self, log_level: int = logging.CRITICAL) -> None:
-        self.client_sid = settings.TWILIO_SID
-        self.client_token = settings.TWILIO_TOKEN
-        self.from_number = settings.TWILIO_FROM_NUMBER
-        self.messaging_sid = settings.TWILIO_MESSAGING_SID
-        self.logger = TwilioLogger(
-            logging.getLogger(self.__class__.__name__), level=log_level
-        ).get_logger()
-
-    def __enter__(self) -> "TwilioCaller":
-        self.client = twilio.rest.Client(
-            self.client_sid, self.client_token, http_client=AsyncTwilioHttpClient()
-        )
-        return self
-
-    def __exit__(self, exc_type, exc_value, exc_tb) -> None:
-        return None
-
-    async def create_notification(
-        self, to_number: str, message: str, method: str = "sms"
-    ) -> asyncio.Task[Any]:
-        self.logger.debug(
-            f"Creating '{method}' notification targeting '{to_number}'..."
-        )
-        match method:
-            case "sms":
-                task = asyncio.create_task(
-                    self.create_sms(to_number=to_number, message=message)
-                )
-            case "call" | "phone":
-                task = asyncio.create_task(
-                    self.create_call(to_number=to_number, message=message)
-                )
-            case _:
-                raise ValueError(f"Unsupported TwilioCaller method '{method}'.")
-        return task
-
-    async def create_call(self, to_number: str, message: str) -> None:
-        await self.client.calls.create_async(
-            to=to_number,
-            from_=self.from_number,
-            twiml=f"<Response><Say>{message}</Say></Response>",
-        )
-
-    async def create_sms(self, to_number: str, message: str) -> None:
-        await self.client.messages.create_async(
-            to=to_number,
-            from_=self.from_number,
-            body=message,
-            messaging_service_sid=self.messaging_sid,
-        )

python_terminusgps-24.4.0/terminusgps/twilio/logger.py

@@ -1,29 +0,0 @@
-import logging
-
-
-class TwilioLogger:
-    def __init__(
-        self,
-        logger: logging.Logger,
-        level: int = logging.DEBUG,
-        format: str = "%(name)s - %(levelname)s - %(asctime)s - %(message)s",
-        use_stream_handler: bool = True,
-        use_file_handler: bool = False,
-        filename: str = "twilio_debug.log",
-    ) -> None:
-        self.logger = logger
-        self.logger.setLevel(level)
-        formatter = logging.Formatter(format)
-
-        if use_stream_handler and not self.logger.handlers:
-            stream_handler = logging.StreamHandler()
-            stream_handler.setFormatter(formatter)
-            self.logger.addHandler(stream_handler)
-
-        if use_file_handler and not self.logger.handlers:
-            file_handler = logging.FileHandler(filename)
-            file_handler.setFormatter(formatter)
-            self.logger.addHandler(file_handler)
-
-    def get_logger(self) -> logging.Logger:
-        return self.logger