python-ntfy 0.2.2__tar.gz → 0.2.4__tar.gz

python_ntfy-0.2.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Matthew Cane
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{python_ntfy-0.2.2 → python_ntfy-0.2.4}/PKG-INFO

@@ -1,15 +1,23 @@
 Metadata-Version: 2.1
 Name: python-ntfy
-Version: 0.2.2
+Version: 0.2.4
 Summary: An ntfy library aiming for feature completeness
+Home-page: https://github.com/MatthewCane/python-ntfy
+License: MIT
 Author: Matthew Cane
 Author-email: matthew.cane0@gmail.com
 Requires-Python: >=3.11,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
 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
 Description-Content-Type: text/markdown
 
 # A Python Library For ntfy.sh
@@ -20,13 +28,13 @@ An easy-to-use ntfy python library. Aiming for full feature support.
 
 1. Install using pip with `pip3 install python-ntfy`
 2. Configure the following environment variables:
-   - `NTFY_USER`: The username for your server (if required)
-   - `NTFY_PASSWORD`: The password for your server (if required)
-   - `NTFY_SERVER`: The server URL (defaults to https://ntft.sh)
+    - `NTFY_USER`: The username for your server (if required)
+    - `NTFY_PASSWORD`: The password for your server (if required)
+    - `NTFY_SERVER`: The server URL (defaults to `https://ntft.sh`)
 3. Setup your application to use the library:
 
- ```python
- # Import the ntfy client
+```python
+# Import the ntfy client
 from python_ntfy import NtfyClient
 
 # Create an `NtfyClient` instance with a topic
@@ -36,6 +44,8 @@ client = NtfyClient(topic="Your topic")
 client.send("Your message here")
 ```
 
+See the full documentation site at [https://matthewcane.github.io/python-ntfy/](https://matthewcane.github.io/python-ntfy/).
+
 ## Supported Features
 
 - Username + password auth
@@ -44,30 +54,34 @@ client.send("Your message here")
 - Sending Markdown formatted text messages
 - Retrieving cached messages
 - Scheduled delivery
+- Tags
+- Action buttons
 
 ## Future Features
 
 - Access token auth
 - Email notifications
-- Tags
-- Action buttons
 - 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
 
@@ -78,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.2 → python_ntfy-0.2.4}/README.md

@@ -6,13 +6,13 @@ An easy-to-use ntfy python library. Aiming for full feature support.
 
 1. Install using pip with `pip3 install python-ntfy`
 2. Configure the following environment variables:
-   - `NTFY_USER`: The username for your server (if required)
-   - `NTFY_PASSWORD`: The password for your server (if required)
-   - `NTFY_SERVER`: The server URL (defaults to https://ntft.sh)
+    - `NTFY_USER`: The username for your server (if required)
+    - `NTFY_PASSWORD`: The password for your server (if required)
+    - `NTFY_SERVER`: The server URL (defaults to `https://ntft.sh`)
 3. Setup your application to use the library:
 
- ```python
- # Import the ntfy client
+```python
+# Import the ntfy client
 from python_ntfy import NtfyClient
 
 # Create an `NtfyClient` instance with a topic
@@ -22,6 +22,8 @@ client = NtfyClient(topic="Your topic")
 client.send("Your message here")
 ```
 
+See the full documentation site at [https://matthewcane.github.io/python-ntfy/](https://matthewcane.github.io/python-ntfy/).
+
 ## Supported Features
 
 - Username + password auth
@@ -30,30 +32,34 @@ client.send("Your message here")
 - Sending Markdown formatted text messages
 - Retrieving cached messages
 - Scheduled delivery
+- Tags
+- Action buttons
 
 ## Future Features
 
 - Access token auth
 - Email notifications
-- Tags
-- Action buttons
 - 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
 
@@ -64,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.2 → python_ntfy-0.2.4}/pyproject.toml

@@ -1,13 +1,21 @@
 [tool.poetry]
 name = "python-ntfy"
-version = "0.2.2"
+version = "0.2.4"
 description = "An ntfy library aiming for feature completeness"
 authors = ["Matthew Cane <matthew.cane0@gmail.com>"]
 readme = "README.md"
+license = "MIT"
+repository = "https://github.com/MatthewCane/python-ntfy"
+documentation = "https://matthewcane.github.io/python-ntfy/"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers"
+]
 
 [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"
@@ -15,6 +23,12 @@ python-dotenv = "^1.0.0"
 pytest-asyncio = ">=0.21.1,<0.25.0"
 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.2 → python_ntfy-0.2.4}/python_ntfy/__init__.py

@@ -1,27 +1,38 @@
 import os
+from types import MethodType
+from ._send_functions import (
+    send,
+    send_file,
+    MessagePriority,
+    ViewAction,
+    BroadcastAction,
+    HttpAction,
+)
+from ._get_functions import get_cached_messages
 
 
 class NtfyClient:
-    from ._send_functions import (
-        send,
-        send_file,
-        MessagePriority,
-        ViewAction,
-        BroadcastAction,
-        HttpAction,
-    )
-    from ._get_functions import get_cached_messages
-
     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:
         """
+        # Bind the imported functions to the class
+        self.send = MethodType(send, self)
+        self.send_file = MethodType(send_file, self)
+        self.MessagePriority = MethodType(MessagePriority, self)
+        self.get_cached_messages = MethodType(get_cached_messages, self)
+
+        # These are Enums that don't need to be bound
+        self.ViewAction = ViewAction
+        self.BroadcastAction = BroadcastAction
+        self.HttpAction = HttpAction
+
         self._server = os.environ.get("NTFY_SERVER") or server
         self._topic = topic
         self.__set_url(self._server, topic)
@@ -45,3 +56,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.2 → python_ntfy-0.2.4}/python_ntfy/_get_functions.py

@@ -2,7 +2,9 @@ import json
 import requests
 
 
-def get_cached_messages(self, since: str = "all", scheduled: bool = False):
+def get_cached_messages(
+    self, since: str = "all", scheduled: bool = False
+) -> list[dict]:
     """
     Get cached messages from the server
 
@@ -19,7 +21,7 @@ def get_cached_messages(self, since: str = "all", scheduled: bool = False):
 
     params = {"poll": "1"}
     if scheduled:
-        params.update({"scheduled": scheduled})
+        params.update({"scheduled": str(scheduled)})
     if since:
         params.update({"since": since})
 

{python_ntfy-0.2.2 → python_ntfy-0.2.4}/python_ntfy/_send_functions.py

@@ -40,7 +40,7 @@ class ViewAction(Action):
         self.action = ActionType.VIEW
         super().__init__(label=label, url=url, clear=clear)
 
-    def to_dict(self):
+    def to_dict(self) -> dict:
         return {
             "action": self.action.value,
             "label": self.label,
@@ -48,7 +48,7 @@ class ViewAction(Action):
             "clear": self.clear,
         }
 
-    def to_header(self):
+    def to_header(self) -> str:
         return f"action={self.action.value}, label={self.label}, url={self.url}, clear={self.clear}"
 
 
@@ -63,9 +63,9 @@ class BroadcastAction(Action):
         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):
+    def to_dict(self) -> dict:
         return {
             "action": self.action.value,
             "label": self.label,
@@ -73,7 +73,7 @@ class BroadcastAction(Action):
             "clear": self.clear,
         }
 
-    def to_header(self):
+    def to_header(self) -> str:
         extras = ""
         if self.extras is not None:
             for key, value in self.extras.items():
@@ -87,7 +87,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 +97,8 @@ class HttpAction(Action):
         self.body = body
         super().__init__(label, url, clear)
 
-    def to_dict(self):
-        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,
@@ -111,7 +111,7 @@ class HttpAction(Action):
             action_dict["body"] = self.body
         return action_dict
 
-    def to_header(self):
+    def to_header(self) -> str:
         header_str = f"action={self.action.value}, label={self.label}, url={self.url}, method={self.method}, clear={self.clear}"
         if self.headers is not None:
             headers = ""
@@ -127,12 +127,12 @@ 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:
     """
     Send a text based message to the server
 
@@ -167,11 +167,11 @@ 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 +186,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