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

python_ntfy-0.2.3/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.3}/PKG-INFO

@@ -1,15 +1,22 @@
 Metadata-Version: 2.1
 Name: python-ntfy
-Version: 0.2.2
+Version: 0.2.3
 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: 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 +27,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 +43,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,13 +53,13 @@ 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

{python_ntfy-0.2.2 → python_ntfy-0.2.3}/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,13 +32,13 @@ 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

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

@@ -1,9 +1,16 @@
 [tool.poetry]
 name = "python-ntfy"
-version = "0.2.2"
+version = "0.2.3"
 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"
@@ -15,6 +22,8 @@ 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"
 
 [build-system]
 requires = ["poetry-core"]

{python_ntfy-0.2.2 → python_ntfy-0.2.3}/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
 

{python_ntfy-0.2.2 → python_ntfy-0.2.3}/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}"
 
 
@@ -65,7 +65,7 @@ class BroadcastAction(Action):
         self.extras = extras
         super().__init__(label, ActionType.BROADCAST, 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():
@@ -97,7 +97,7 @@ class HttpAction(Action):
         self.body = body
         super().__init__(label, url, clear)
 
-    def to_dict(self):
+    def to_dict(self) -> dict:
         action_dict = {
             "action": self.action.value,
             "label": self.label,
@@ -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 = ""
@@ -132,7 +132,7 @@ def send(
     tags: list = [],
     actions: list[Union[ViewAction, BroadcastAction, HttpAction, None]] = [],
     format_as_markdown: bool = False,
-):
+) -> dict:
     """
     Send a text based message to the server
 
@@ -171,7 +171,7 @@ def send_file(
     priority: Optional[MessagePriority] = MessagePriority.DEFAULT,
     tags: list = [],
     actions: list[Union[ViewAction, BroadcastAction, HttpAction, None]] = [],
-):
+) -> dict:
     """
     Send a file to the server