python-ntfy 0.4.1__tar.gz → 0.4.3__tar.gz

{python_ntfy-0.4.1 → python_ntfy-0.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-ntfy
-Version: 0.4.1
+Version: 0.4.3
 Summary: An ntfy library aiming for feature completeness
 Home-page: https://github.com/MatthewCane/python-ntfy
 License: MIT
@@ -13,6 +13,7 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: mkdocstrings[python] (>=0.26.2,<0.27.0)
 Requires-Dist: requests (>=2.31.0,<3.0.0)
 Project-URL: Documentation, https://matthewcane.github.io/python-ntfy/
 Project-URL: Repository, https://github.com/MatthewCane/python-ntfy
@@ -93,7 +94,7 @@ These tools are also run in the CI pipeline and must pass before merging.
 
 ### Tests
 
-This project is aiming for 95% code coverage. Any added features must include comprihensive tests.
+This project is aiming for 95% code coverage. Any added features must include comprehensive tests.
 
 #### Testing Steps
 

{python_ntfy-0.4.1 → python_ntfy-0.4.3}/README.md

@@ -73,7 +73,7 @@ These tools are also run in the CI pipeline and must pass before merging.
 
 ### Tests
 
-This project is aiming for 95% code coverage. Any added features must include comprihensive tests.
+This project is aiming for 95% code coverage. Any added features must include comprehensive tests.
 
 #### Testing Steps
 

{python_ntfy-0.4.1 → python_ntfy-0.4.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-ntfy"
-version = "0.4.1"
+version = "0.4.3"
 description = "An ntfy library aiming for feature completeness"
 authors = ["Matthew Cane <matthew.cane0@gmail.com>"]
 readme = "README.md"
@@ -17,6 +17,7 @@ classifiers = [
 [tool.poetry.dependencies]
 python = ">=3.12, <=3.13"
 requests = "^2.31.0"
+mkdocstrings = {extras = ["python"], version = "^0.26.2"}
 
 [tool.poetry.group.dev.dependencies]
 mypy = "^1.12.0"
@@ -31,6 +32,7 @@ types-pygments = "^2.18.0.20240506"
 types-colorama = "^0.4.15.20240311"
 types-requests = "^2.32.0.20241016"
 types-setuptools = "^75.2.0.20241018"
+black = "^24.10.0"
 
 [build-system]
 requires = ["poetry-core"]

python_ntfy-0.4.3/python_ntfy/__init__.py

@@ -0,0 +1,3 @@
+from ._ntfy import NtfyClient as NtfyClient
+
+__all__ = ["NtfyClient"]

{python_ntfy-0.4.1 → python_ntfy-0.4.3}/python_ntfy/_get_functions.py

@@ -20,10 +20,13 @@ def get_cached_messages(
         A list of messages.
 
     Examples:
-        response = client.get(since="all")
-        response = client.get(since="all", scheduled=True)
-        response = client.get(since="2019-01-01")
-        response = client.get(since="2019-01-01", scheduled=True)
+        >>> response = client.get(since="all")
+
+        >>> response = client.get(since="all", scheduled=True)
+
+        >>> response = client.get(since="2019-01-01")
+
+        >>> response = client.get(since="2019-01-01", scheduled=True)
     """
     params = {"poll": "1"}
     if scheduled:

python_ntfy-0.4.1/python_ntfy/__init__.py → python_ntfy-0.4.3/python_ntfy/_ntfy.py

@@ -11,24 +11,36 @@ Typical usage example:
 
 import os
 
+from ._get_functions import get_cached_messages
+from ._send_functions import (
+    BroadcastAction,
+    HttpAction,
+    MessagePriority,
+    ViewAction,
+    send,
+    send_file,
+)
+
+
+class GetFunctionsMixin:
+    """Mixin for getting messages."""
+
+    get_cached_messages = get_cached_messages
 
-class NtfyClient:
-    """A class for interacting with the ntfy notification service."""
 
-    # The functions need to be imported here to:
-    # 1. Keep the functions in a separate file
-    # 2. Keep the docstrings working in the IDE
-    # 3. Allow the functions to be called with self
-    # MyPy does not like this, but it works
-    from ._get_functions import get_cached_messages  # type: ignore
-    from ._send_functions import (  # type: ignore
-        BroadcastAction,
-        HttpAction,
-        MessagePriority,
-        ViewAction,
-        send,
-        send_file,
-    )
+class SendFunctionsMixin:
+    """Mixin for sending messages."""
+
+    send = send
+    send_file = send_file
+    BroadcastAction = BroadcastAction
+    HttpAction = HttpAction
+    MessagePriority = MessagePriority
+    ViewAction = ViewAction
+
+
+class NtfyClient(GetFunctionsMixin, SendFunctionsMixin):
+    """A class for interacting with the ntfy notification service."""
 
     def __init__(
         self,

{python_ntfy-0.4.1 → python_ntfy-0.4.3}/python_ntfy/_send_functions.py

@@ -8,7 +8,16 @@ import requests
 
 
 class MessagePriority(Enum):
-    """Ntfy message priority levels."""
+    """Ntfy message priority levels.
+
+    Attributes:
+        MIN: The minimum priority.
+        LOW: A low priority.
+        DEFAULT: The default priority.
+        HIGH: A high priority.
+        MAX: The maximum priority.
+        URGENT: The maximum priority.
+    """
 
     MIN = "1"
     LOW = "2"
@@ -19,7 +28,13 @@ class MessagePriority(Enum):
 
 
 class ActionType(Enum):
-    """Action button types."""
+    """Action button types.
+
+    Attributes:
+        VIEW: A view action button.
+        BROADCAST: A broadcast action button.
+        HTTP: An HTTP action button.
+    """
 
     VIEW = "view"
     BROADCAST = "broadcast"
@@ -35,7 +50,19 @@ class Action:
 
 
 class ViewAction(Action):
+    """A view action button.
+
+    The view action opens a website or app when the action button is tapped.
+    """
+
     def __init__(self, label: str, url: str, clear: bool = False) -> None:
+        """Initialize a ViewAction.
+
+        Args:
+            label: Label of the action button in the notification.
+            url: URL to open when action is tapped.
+            clear: Clear notification after action button is tapped.
+        """
         self.action = ActionType.VIEW
         super().__init__(label=label, url=url, clear=clear)
 
@@ -52,6 +79,11 @@ class ViewAction(Action):
 
 
 class BroadcastAction(Action):
+    """A broadcast action button.
+
+    The broadcast action sends an Android broadcast intent when the action button is tapped.
+    """
+
     def __init__(
         self,
         label: str,
@@ -59,6 +91,14 @@ class BroadcastAction(Action):
         extras: Optional[dict[str, str]] = None,
         clear: bool = False,
     ) -> None:
+        """Initialize a BroadcastAction.
+
+        Args:
+            label: Label of the action button in the notification.
+            intent: Android intent name.
+            extras: Android intent extras.
+            clear: Clear notification after action button is tapped.
+        """
         self.action = ActionType.BROADCAST
         self.intent = intent
         self.extras = extras
@@ -85,6 +125,11 @@ class BroadcastAction(Action):
 
 
 class HttpAction(Action):
+    """An HTTP action button.
+
+    The http action sends a HTTP request when the action button is tapped.
+    """
+
     def __init__(
         self,
         label: str,
@@ -94,6 +139,16 @@ class HttpAction(Action):
         body: Optional[str] = None,
         clear: bool = False,
     ) -> None:
+        """Initialize an HttpAction.
+
+        Args:
+            label: Label of the action button in the notification.
+            url: URL to open when action is tapped.
+            method: HTTP method to use for request.
+            headers: HTTP headers to send with the request.
+            body: HTTP body to send with the request.
+            clear: Clear notification after HTTP request succeeds. If the request fails, the notification is not cleared.
+        """
         self.action = ActionType.HTTP
         self.method = method
         self.headers = headers
@@ -161,9 +216,11 @@ def send(
         ToDo
 
     Examples:
-        response = client.send(message="Example message")
-        response = client.send(message="Example message", title="Example title", priority=MessagePriority.HIGH, tags=["fire", "warning"])
-        response = client.send(message="*Example markdown*", format_as_markdown=True)
+        >>> response = client.send(message="Example message")
+
+        >>> response = client.send(message="Example message", title="Example title", priority=MessagePriority.HIGH, tags=["fire", "warning"])
+
+        >>> response = client.send(message="*Example markdown*", format_as_markdown=True)
     """
     if tags is None:
         tags = []
@@ -221,7 +278,7 @@ def send_file(
         ToDo
 
     Examples:
-        response = client.send_file(file="example.txt")
+        >>> response = client.send_file(file="example.txt")
     """
     if actions is None:
         actions = []