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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-ntfy
-Version: 0.3.8
+Version: 0.4.1
 Summary: An ntfy library aiming for feature completeness
 Home-page: https://github.com/MatthewCane/python-ntfy
 License: MIT
@@ -46,7 +46,9 @@ 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/).
+## Documentation
+
+See the full documentation at [https://matthewcane.github.io/python-ntfy/](https://matthewcane.github.io/python-ntfy/).
 
 ## Supported Features
 
@@ -55,6 +57,7 @@ See the full documentation site at [https://matthewcane.github.io/python-ntfy/](
 - Custom servers
 - Sending plaintext messages
 - Sending Markdown formatted text messages
+- Scheduling messages
 - Retrieving cached messages
 - Scheduled delivery
 - Tags
@@ -92,10 +95,8 @@ These tools are also run in the CI pipeline and must pass before merging.
 
 This project is aiming for 95% code coverage. Any added features must include comprihensive tests.
 
-#### Setup Steps
-
-1. Start the test docker container with `docker-compose -f tests/assets/test_containers.yml up`
-2. Run the tests with `poetry run pytest --cov`
+#### Testing Steps
 
-The tests will sent messages to the `python_ntfy_testing` topic so you will need to view the web interface and subcribe to that topic to see the test messages.
+1. Make sure you have `docker` and `docker-compose` installed
+2. Run the tests with `poetry run pytest --cov` or use the VSCode testing extension
 

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

@@ -26,7 +26,9 @@ 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/).
+## Documentation
+
+See the full documentation at [https://matthewcane.github.io/python-ntfy/](https://matthewcane.github.io/python-ntfy/).
 
 ## Supported Features
 
@@ -35,6 +37,7 @@ See the full documentation site at [https://matthewcane.github.io/python-ntfy/](
 - Custom servers
 - Sending plaintext messages
 - Sending Markdown formatted text messages
+- Scheduling messages
 - Retrieving cached messages
 - Scheduled delivery
 - Tags
@@ -72,9 +75,7 @@ These tools are also run in the CI pipeline and must pass before merging.
 
 This project is aiming for 95% code coverage. Any added features must include comprihensive tests.
 
-#### Setup Steps
-
-1. Start the test docker container with `docker-compose -f tests/assets/test_containers.yml up`
-2. Run the tests with `poetry run pytest --cov`
+#### Testing Steps
 
-The tests will sent messages to the `python_ntfy_testing` topic so you will need to view the web interface and subcribe to that topic to see the test messages.
+1. Make sure you have `docker` and `docker-compose` installed
+2. Run the tests with `poetry run pytest --cov` or use the VSCode testing extension

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

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-ntfy"
-version = "0.3.8"
+version = "0.4.1"
 description = "An ntfy library aiming for feature completeness"
 authors = ["Matthew Cane <matthew.cane0@gmail.com>"]
 readme = "README.md"
@@ -69,8 +69,12 @@ ignore = [
     "ANN001", # Missing type annotation for function argument
     "ANN101", # Missing type annotation for self in method
     "S101",   # Use of assert detected
+    "TRY003", # Use of vanilla exception messages
 ]
 
 
 [tool.ruff.lint.pydocstyle]
 convention = "google"
+
+[tool.pytest.ini_options]
+asyncio_default_fixture_loop_scope = "function"

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

@@ -1,4 +1,5 @@
 import json
+from datetime import datetime
 from enum import Enum
 from pathlib import Path
 from typing import Optional, Union
@@ -133,6 +134,7 @@ def send(
     priority: MessagePriority = MessagePriority.DEFAULT,
     tags: Optional[list] = None,
     actions: Optional[list[Union[ViewAction, BroadcastAction, HttpAction]]] = None,
+    schedule: Optional[datetime] = None,
     format_as_markdown: bool = False,
     timeout_seconds: int = 5,
 ) -> dict:
@@ -147,9 +149,10 @@ def send(
         priority: The priority of the message.
         tags: A list of tags to attach to the message. Can be an emoji short code.
         actions: A list of Actions objects to attach to the message.
+        schedule: The time to schedule the message to be sent.
         format_as_markdown: If true, the message will be formatted as markdown.
         additional_topics: A list of additional topics to send the message to.
-        timeout_seconds: The number of seconds to wait before timing out.
+        timeout_seconds: The number of seconds to wait before timing out the reqest to the server.
 
     Returns:
         dict: The response from the server.
@@ -176,6 +179,9 @@ def send(
     if len(actions) > 0:
         headers["Actions"] = " ; ".join([action.to_header() for action in actions])
 
+    if schedule:
+        headers["Delay"] = str(int(schedule.timestamp()))
+
     return json.loads(
         requests.post(
             url=self.url,
@@ -194,6 +200,7 @@ def send_file(
     priority: MessagePriority = MessagePriority.DEFAULT,
     tags: Optional[list] = None,
     actions: Optional[list[Union[ViewAction, BroadcastAction, HttpAction]]] = None,
+    schedule: Optional[datetime] = None,
     timeout_seconds: int = 30,
 ) -> dict:
     """Sends a file to the server.
@@ -204,6 +211,7 @@ def send_file(
         priority: The priority of the message. Optional, defaults to MessagePriority.
         tags: A list of tags to attach to the message. Can be an emoji short code.
         actions: A list of ActionButton objects to attach to the message.
+        schedule: The time to schedule the message to be sent. Must be more than 10 seconds away and less than 3 days in the future.
         timeout_seconds: The number of seconds to wait before timing out.
 
     Returns:
@@ -228,6 +236,9 @@ def send_file(
         "Actions": " ; ".join([action.to_header() for action in actions]),
     }
 
+    if schedule:
+        headers["Delay"] = str(int(schedule.timestamp()))
+
     with Path(file).open("rb") as f:
         return json.loads(
             requests.post(