python-ntfy 0.7.2__tar.gz → 0.8.0__tar.gz

{python_ntfy-0.7.2 → python_ntfy-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-ntfy
-Version: 0.7.2
+Version: 0.8.0
 Summary: An ntfy library aiming for feature completeness
 Keywords: ntfy,notifications,push,http,api
 Author: Matthew Cane
@@ -18,7 +18,7 @@ Classifier: Topic :: Communications
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Dist: requests>=2.31.0
-Requires-Dist: mkdocstrings[python]>=0.26.2,<0.30.0 ; extra == 'dev'
+Requires-Dist: mkdocstrings[python]>=0.26.2,<0.31.0 ; extra == 'dev'
 Requires-Dist: mypy>=1.12.0,<2.0.0 ; extra == 'dev'
 Requires-Dist: pytest>=7.4.1,<9.0.0 ; extra == 'dev'
 Requires-Dist: python-dotenv>=1.0.0,<2.0.0 ; extra == 'dev'
@@ -86,25 +86,23 @@ See the full documentation at [https://matthewcane.github.io/python-ntfy/](https
 
 ## Contributing
 
-This project uses:
+We welcome contributions! This project aims to provide a complete and user-friendly Python library for ntfy. Here's how you can help:
 
-- [uv](https://github.com/astral-sh/uv) as its dependency manager
-- [Just](https://github.com/casey/just) as a task runner
-- [Pre-commit](https://pre-commit.com/) for running checks before each commit
-- [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/) for running tests
+### Prerequisites
 
-These need to be installed separately to run the tasks.
+Before contributing, you'll need to install these tools:
 
-To see all available tasks, run `just`.
+- **[uv](https://github.com/astral-sh/uv)** - Fast Python package manager and installer
+- **[Just](https://github.com/casey/just)** - Command runner for project tasks
+- **[Docker](https://www.docker.com/)** and **[Docker Compose](https://docs.docker.com/compose/)** - For running tests with ntfy servers
+- **[Pre-commit](https://pre-commit.com/)** - Git hooks for code quality (optional but recommended)
 
-Some useful tasks are:
+### Development Steps
 
-- `just install` - Install dependencies (including dev dependencies)
-- `just test` - Run all tests and checks
-- `just check` - Run code quality checks (ruff + mypy)
-- `just format` - Format code with ruff
-- `just serve-docs` - Build and serve the docs locally
+- Fork the repository and make your changes
+- Run `just setup` to install the pre-commit hooks
+- Run `just format` to format the code
+- Run `just test` to run all the tests
+- Create a pull request with detailed description of your changes
 
-### Tests
-
-This project is aiming for 95% code coverage. Any added features must include comprehensive tests.
+Thank you for contributing to python-ntfy! 🚀

{python_ntfy-0.7.2 → python_ntfy-0.8.0}/README.md

@@ -44,25 +44,23 @@ See the full documentation at [https://matthewcane.github.io/python-ntfy/](https
 
 ## Contributing
 
-This project uses:
+We welcome contributions! This project aims to provide a complete and user-friendly Python library for ntfy. Here's how you can help:
 
-- [uv](https://github.com/astral-sh/uv) as its dependency manager
-- [Just](https://github.com/casey/just) as a task runner
-- [Pre-commit](https://pre-commit.com/) for running checks before each commit
-- [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/) for running tests
+### Prerequisites
 
-These need to be installed separately to run the tasks.
+Before contributing, you'll need to install these tools:
 
-To see all available tasks, run `just`.
+- **[uv](https://github.com/astral-sh/uv)** - Fast Python package manager and installer
+- **[Just](https://github.com/casey/just)** - Command runner for project tasks
+- **[Docker](https://www.docker.com/)** and **[Docker Compose](https://docs.docker.com/compose/)** - For running tests with ntfy servers
+- **[Pre-commit](https://pre-commit.com/)** - Git hooks for code quality (optional but recommended)
 
-Some useful tasks are:
+### Development Steps
 
-- `just install` - Install dependencies (including dev dependencies)
-- `just test` - Run all tests and checks
-- `just check` - Run code quality checks (ruff + mypy)
-- `just format` - Format code with ruff
-- `just serve-docs` - Build and serve the docs locally
+- Fork the repository and make your changes
+- Run `just setup` to install the pre-commit hooks
+- Run `just format` to format the code
+- Run `just test` to run all the tests
+- Create a pull request with detailed description of your changes
 
-### Tests
-
-This project is aiming for 95% code coverage. Any added features must include comprehensive tests.
+Thank you for contributing to python-ntfy! 🚀

{python_ntfy-0.7.2 → python_ntfy-0.8.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-ntfy"
-version = "0.7.2"
+version = "0.8.0"
 description = "An ntfy library aiming for feature completeness"
 readme = "README.md"
 license = "MIT"
@@ -20,9 +20,7 @@ classifiers = [
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
 keywords = ["ntfy", "notifications", "push", "http", "api"]
-authors = [
-    {name = "Matthew Cane", email = "matthew.cane0@gmail.com"}
-]
+authors = [{ name = "Matthew Cane", email = "matthew.cane0@gmail.com" }]
 
 [project.urls]
 Homepage = "https://github.com/matthewcane/python-ntfy"
@@ -41,36 +39,36 @@ module-root = ""
 
 [tool.uv]
 dev-dependencies = [
-    "mkdocstrings[python]>=0.26.2,<0.30.0",
+    "mkdocstrings[python]>=0.26.2,<0.31.0",
     "mypy>=1.12.0,<2.0.0",
     "pytest>=7.4.1,<9.0.0",
     "python-dotenv>=1.0.0,<2.0.0",
     "pytest-asyncio>=0.21.1,<1.2.0",
-    "pytest-codecov>=0.5.1,<0.8.0", 
+    "pytest-codecov>=0.5.1,<0.8.0",
     "ruff>=0.7,<0.13",
     "mkdocs-material>=9.5.41,<10.0.0",
     "mkdocstrings-python>=1.12.1,<2.0.0",
     "types-pygments>=2.18.0.20240506",
     "types-colorama>=0.4.15.20240311",
     "types-requests>=2.32.0.20241016",
-    "types-setuptools>=75.2.0.20241018,<81.0.0.0"
+    "types-setuptools>=75.2.0.20241018,<81.0.0.0",
 ]
 
 [project.optional-dependencies]
 dev = [
-    "mkdocstrings[python]>=0.26.2,<0.30.0",
+    "mkdocstrings[python]>=0.26.2,<0.31.0",
     "mypy>=1.12.0,<2.0.0",
     "pytest>=7.4.1,<9.0.0",
     "python-dotenv>=1.0.0,<2.0.0",
     "pytest-asyncio>=0.21.1,<1.2.0",
-    "pytest-codecov>=0.5.1,<0.8.0", 
+    "pytest-codecov>=0.5.1,<0.8.0",
     "ruff>=0.7,<0.13",
     "mkdocs-material>=9.5.41,<10.0.0",
     "mkdocstrings-python>=1.12.1,<2.0.0",
     "types-pygments>=2.18.0.20240506",
     "types-colorama>=0.4.15.20240311",
     "types-requests>=2.32.0.20241016",
-    "types-setuptools>=75.2.0.20241018,<81.0.0.0"
+    "types-setuptools>=75.2.0.20241018,<81.0.0.0",
 ]
 
 [tool.ruff]

python_ntfy-0.8.0/python_ntfy/_exceptions.py

@@ -0,0 +1,11 @@
+class MessageSendError(Exception):
+    """Exception raised when a message fails to send."""
+
+    def __init__(self, message: str) -> None:
+        """Initialize the exception.
+
+        Args:
+            message: The message to display.
+        """
+        self.message = message
+        super().__init__(self.message)

{python_ntfy-0.7.2 → python_ntfy-0.8.0}/python_ntfy/_ntfy.py

@@ -59,7 +59,7 @@ class NtfyClient(GetFunctionsMixin, SendFunctionsMixin):
             None
 
         Exceptions:
-            ToDo
+            None
 
         Examples:
             client = NtfyClient(topic="my_topic")

{python_ntfy-0.7.2 → python_ntfy-0.8.0}/python_ntfy/_send_functions.py

@@ -1,10 +1,11 @@
-import json
 from datetime import datetime
 from enum import Enum
 from pathlib import Path
 
 import requests
 
+from python_ntfy._exceptions import MessageSendError
+
 
 class MessagePriority(Enum):
     """Ntfy message priority levels.
@@ -214,7 +215,7 @@ def send(
         dict: The response from the server.
 
     Raises:
-        ToDo
+        MessageSendError: If the message fails to send.
 
     Examples:
         >>> response = client.send(message="Example message")
@@ -243,20 +244,24 @@ def send(
     if schedule:
         headers["Delay"] = str(int(schedule.timestamp()))
 
-    return json.loads(
-        requests.post(
+    try:
+        response = requests.post(
             url=self.url,
             data=message,
             headers=headers,
             auth=self._auth,
             timeout=timeout_seconds,
-        ).text,
-    )
+        )
+        response.raise_for_status()
+        return response.json()
+    except requests.exceptions.RequestException as e:
+        error_message = f"Failed to send message: {e}"
+        raise MessageSendError(error_message) from e
 
 
 def send_file(
     self,
-    file: str,
+    file: str | Path,
     title: str | None = None,
     priority: MessagePriority = MessagePriority.DEFAULT,
     tags: list | None = None,
@@ -268,7 +273,7 @@ def send_file(
     """Sends a file to the server.
 
     Args:
-        file: The path to the file to send.
+        file: The file to send.
         title: The title of the 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.
@@ -281,7 +286,7 @@ def send_file(
         dict: The response from the server.
 
     Raises:
-        ToDo
+        MessageSendError: If the message fails to send.
 
     Examples:
         >>> response = client.send_file(file="example.txt")
@@ -291,9 +296,17 @@ def send_file(
     if tags is None:
         tags = []
 
+    try:
+        data = Path(file).read_bytes()
+    except Exception as e:
+        error_message = f"Failed to read file: {e}"
+        raise MessageSendError(error_message) from e
+
+    filename = Path(file).name
+
     headers = {
         "Title": str(title),
-        "Filename": file.split("/")[-1],
+        "Filename": filename,
         "Priority": priority.value,
         "Tags": ",".join(tags),
         "Actions": " ; ".join([action.to_header() for action in actions]),
@@ -305,13 +318,16 @@ def send_file(
     if schedule:
         headers["Delay"] = str(int(schedule.timestamp()))
 
-    with Path(file).open("rb") as f:
-        return json.loads(
-            requests.post(
-                url=self.url,
-                data=f,
-                headers=headers,
-                auth=self._auth,
-                timeout=timeout_seconds,
-            ).text,
+    try:
+        response = requests.post(
+            url=self.url,
+            data=data,
+            headers=headers,
+            auth=self._auth,
+            timeout=timeout_seconds,
         )
+        response.raise_for_status()
+        return response.json()
+    except requests.exceptions.RequestException as e:
+        error_message = f"Failed to send file: {e}"
+        raise MessageSendError(error_message) from e