python-ntfy 0.2.3__tar.gz → 0.2.5__tar.gz

{python_ntfy-0.2.3 → python_ntfy-0.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-ntfy
-Version: 0.2.3
+Version: 0.2.5
 Summary: An ntfy library aiming for feature completeness
 Home-page: https://github.com/MatthewCane/python-ntfy
 License: MIT
@@ -14,6 +14,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: mypy (>=1.12.0,<2.0.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
@@ -62,21 +63,25 @@ See the full documentation site at [https://matthewcane.github.io/python-ntfy/](
 - Email notifications
 - Send to multiple topics at once
 
-## Test and Development
+## Testing and Development
 
 This project uses:
 
 - Poetry as it's dependency manager
 - Ruff for linting and code formatting
+- MyPy for static type checking
 
 To install dev dependencies, run `poetry install --with dev`.
 
-### Linting and Formatting
+### Linting, Formatting and Type Checking
 
 These can be run with:
 
 - `poetry run ruff format`
 - `poetry run ruff check`
+- `poetry run mypy .`
+
+These tools are also run in the CI pipeline and must pass before merging.
 
 ### Tests
 
@@ -87,11 +92,11 @@ You can run the tests against a local instance of `ntfy` *or* `ntfy.sh`.
 #### Setup Steps
 
 1. To test against a *local* `ntfy` instance:
-  i. Create a container using `docker run -p 80:80 -it binwiederhier/ntfy serve --attachment-cache-dir=/cache --base-url=http://localhost`
-  ii. Set the following key in the `.env` file: `NTFY_SERVER=http://localhost`
-  iii. Add a dummy username and password to `.env` (see example.env)
-2. To test against https://ntfy.sh:
-  i. Add username and password for ntfy.sh to `.env` (see example.env)
+    i. Create a container using `docker run -p 80:80 -it binwiederhier/ntfy serve --attachment-cache-dir=/cache --base-url=http://localhost`
+    ii. Set the following key in the `.env` file: `NTFY_SERVER=http://localhost`
+    iii. Add a dummy username and password to `.env` (see example.env)
+2. To test against `https://ntfy.sh`:
+    i. Add username and password for ntfy.sh to `.env` (see example.env)
 3. Run the tests with `poetry run pytest --cov`
 
 The tests will sent messages to the `python_ntfy_testing` topic so you will need to subcribe to that topic to see the test messages.

{python_ntfy-0.2.3 → python_ntfy-0.2.5}/README.md

@@ -41,21 +41,25 @@ See the full documentation site at [https://matthewcane.github.io/python-ntfy/](
 - Email notifications
 - Send to multiple topics at once
 
-## Test and Development
+## Testing and Development
 
 This project uses:
 
 - Poetry as it's dependency manager
 - Ruff for linting and code formatting
+- MyPy for static type checking
 
 To install dev dependencies, run `poetry install --with dev`.
 
-### Linting and Formatting
+### Linting, Formatting and Type Checking
 
 These can be run with:
 
 - `poetry run ruff format`
 - `poetry run ruff check`
+- `poetry run mypy .`
+
+These tools are also run in the CI pipeline and must pass before merging.
 
 ### Tests
 
@@ -66,11 +70,11 @@ You can run the tests against a local instance of `ntfy` *or* `ntfy.sh`.
 #### Setup Steps
 
 1. To test against a *local* `ntfy` instance:
-  i. Create a container using `docker run -p 80:80 -it binwiederhier/ntfy serve --attachment-cache-dir=/cache --base-url=http://localhost`
-  ii. Set the following key in the `.env` file: `NTFY_SERVER=http://localhost`
-  iii. Add a dummy username and password to `.env` (see example.env)
-2. To test against https://ntfy.sh:
-  i. Add username and password for ntfy.sh to `.env` (see example.env)
+    i. Create a container using `docker run -p 80:80 -it binwiederhier/ntfy serve --attachment-cache-dir=/cache --base-url=http://localhost`
+    ii. Set the following key in the `.env` file: `NTFY_SERVER=http://localhost`
+    iii. Add a dummy username and password to `.env` (see example.env)
+2. To test against `https://ntfy.sh`:
+    i. Add username and password for ntfy.sh to `.env` (see example.env)
 3. Run the tests with `poetry run pytest --cov`
 
 The tests will sent messages to the `python_ntfy_testing` topic so you will need to subcribe to that topic to see the test messages.

{python_ntfy-0.2.3 → python_ntfy-0.2.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-ntfy"
-version = "0.2.3"
+version = "0.2.5"
 description = "An ntfy library aiming for feature completeness"
 authors = ["Matthew Cane <matthew.cane0@gmail.com>"]
 readme = "README.md"
@@ -15,6 +15,7 @@ classifiers = [
 [tool.poetry.dependencies]
 python = "^3.11"
 requests = "^2.31.0"
+mypy = "^1.12.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = ">=7.4.1,<9.0.0"
@@ -24,6 +25,10 @@ pytest-codecov = ">=0.5.1,<0.7.0"
 ruff = "^0.7.0"
 mkdocs-material = "^9.5.41"
 mkdocstrings-python = "^1.12.1"
+types-pygments = "^2.18.0.20240506"
+types-colorama = "^0.4.15.20240311"
+types-requests = "^2.32.0.20241016"
+types-setuptools = "^75.2.0.20241018"
 
 [build-system]
 requires = ["poetry-core"]

{python_ntfy-0.2.3 → python_ntfy-0.2.5}/python_ntfy/__init__.py

@@ -2,7 +2,12 @@ import os
 
 
 class NtfyClient:
-    from ._send_functions import (
+    # 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 ._send_functions import (  # type: ignore
         send,
         send_file,
         MessagePriority,
@@ -10,18 +15,19 @@ class NtfyClient:
         BroadcastAction,
         HttpAction,
     )
-    from ._get_functions import get_cached_messages
+    from ._get_functions import get_cached_messages  # type: ignore
 
     def __init__(
         self,
         topic: str,
         server: str = "https://ntfy.sh",
-    ):
+    ) -> None:
         """
         :param topic: The topic to use for this client
         :param server: The server to connect to. Must include the protocol (http/https)
-        :return:
+        :return None:
         """
+
         self._server = os.environ.get("NTFY_SERVER") or server
         self._topic = topic
         self.__set_url(self._server, topic)
@@ -45,3 +51,11 @@ class NtfyClient:
         """
         self._topic = topic
         self.__set_url(self._server, self._topic)
+
+    def get_topic(self):
+        """
+        Get the current topic
+
+        :return: str
+        """
+        return self._topic

{python_ntfy-0.2.3 → python_ntfy-0.2.5}/python_ntfy/_get_functions.py

@@ -21,7 +21,7 @@ def get_cached_messages(
 
     params = {"poll": "1"}
     if scheduled:
-        params.update({"scheduled": scheduled})
+        params.update({"scheduled": str(scheduled)})
     if since:
         params.update({"since": since})
 

{python_ntfy-0.2.3 → python_ntfy-0.2.5}/python_ntfy/_send_functions.py

@@ -57,13 +57,13 @@ class BroadcastAction(Action):
         self,
         label: str,
         intent: str = "io.heckel.ntfy.USER_ACTION",
-        extras: Optional[dict] = None,
+        extras: Optional[dict[str, str]] = None,
         clear: bool = False,
     ):
         self.action = ActionType.BROADCAST
         self.intent = intent
         self.extras = extras
-        super().__init__(label, ActionType.BROADCAST, clear)
+        super().__init__(label, ActionType.BROADCAST.value, clear)
 
     def to_dict(self) -> dict:
         return {
@@ -71,14 +71,18 @@ class BroadcastAction(Action):
             "label": self.label,
             "extras": self.extras,
             "clear": self.clear,
+            "intent": self.intent,
         }
 
     def to_header(self) -> str:
-        extras = ""
-        if self.extras is not None:
-            for key, value in self.extras.items():
-                extras += f"{key}={value},"
-        return f"action={self.action.value}, label={self.label}, url={self.url}, clear={self.clear}"
+        if self.extras:
+            extras_str = ", ".join([f"extras.{k}={v}" for k, v in self.extras.items()])
+        return (
+            f"action={self.action.value}, label={self.label}, url={self.url}, clear={self.clear}, intent={self.intent}"
+            + extras_str
+            if self.extras
+            else ""
+        )
 
 
 class HttpAction(Action):
@@ -87,7 +91,7 @@ class HttpAction(Action):
         label: str,
         url: str,
         method: str = "POST",
-        headers: Optional[dict] = None,
+        headers: Optional[dict[str, str]] = None,
         body: Optional[str] = None,
         clear: bool = False,
     ):
@@ -97,8 +101,8 @@ class HttpAction(Action):
         self.body = body
         super().__init__(label, url, clear)
 
-    def to_dict(self) -> dict:
-        action_dict = {
+    def to_dict(self) -> dict[str, Union[str, bool, dict[str, str]]]:
+        action_dict: dict[str, Union[str, bool, dict[str, str]]] = {
             "action": self.action.value,
             "label": self.label,
             "url": self.url,
@@ -127,10 +131,10 @@ class HttpAction(Action):
 def send(
     self,
     message: str,
-    title: str = None,
-    priority: Optional[MessagePriority] = MessagePriority.DEFAULT,
+    title: Optional[str] = None,
+    priority: MessagePriority = MessagePriority.DEFAULT,
     tags: list = [],
-    actions: list[Union[ViewAction, BroadcastAction, HttpAction, None]] = [],
+    actions: list[Union[ViewAction, BroadcastAction, HttpAction]] = [],
     format_as_markdown: bool = False,
 ) -> dict:
     """
@@ -153,7 +157,7 @@ def send(
         "Title": title,
         "Priority": priority.value,
         "Tags": ",".join(tags),
-        "Markdown": "true" if format_as_markdown else "false",
+        "Markdown": str(format_as_markdown).lower(),
     }
     if len(actions) > 0:
         headers["Actions"] = " ; ".join([action.to_header() for action in actions])
@@ -167,10 +171,10 @@ def send(
 def send_file(
     self,
     file: str,
-    title: str = None,
-    priority: Optional[MessagePriority] = MessagePriority.DEFAULT,
+    title: Optional[str] = None,
+    priority: MessagePriority = MessagePriority.DEFAULT,
     tags: list = [],
-    actions: list[Union[ViewAction, BroadcastAction, HttpAction, None]] = [],
+    actions: list[Union[ViewAction, BroadcastAction, HttpAction]] = [],
 ) -> dict:
     """
     Send a file to the server
@@ -186,17 +190,15 @@ def send_file(
     response = client.send_file(file_path="example.txt")
     """
     headers = {
-        "Title": title,
+        "Title": str(title),
         "Filename": file.split("/")[-1],
         "Priority": priority.value,
         "Tags": ",".join(tags),
         "Actions": " ; ".join([action.to_header() for action in actions]),
     }
 
-    with open(file, "rb") as file:
+    with open(file, "rb") as f:
         response = json.loads(
-            requests.post(
-                url=self.url, data=file, headers=headers, auth=self._auth
-            ).text
+            requests.post(url=self.url, data=f, headers=headers, auth=self._auth).text
         )
     return response