python-ntfy 0.1.0__tar.gz

python_ntfy-0.1.0/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.1
+Name: python-ntfy
+Version: 0.1.0
+Summary: An ntfy library aiming for feature completeness
+Author: Matthew Cane
+Author-email: matthew.cane0@gmail.com
+Requires-Python: >=3.11,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: requests (>=2.31.0,<3.0.0)
+Description-Content-Type: text/markdown
+
+# ntfy.sh Python Library
+
+An easy-to-use ntfy python library. Aiming for full feature support.
+
+## Quickstart
+
+1. Install using pip with `pip3 install python-ntfy`
+2. If you are using a server that requires auth, set the env vars
+3. Import the library
+
+ ```python
+from python_ntfy import NtfyClient
+ ```
+
+4. Create an `NtfyClient` instance with a topic
+
+```python
+client = NtfyClient(topic="Your topic")
+```
+
+5. Send a message
+
+```python
+client.send("Your message here")
+```
+
+## Supported Features
+
+- Username + password auth
+- Custom servers
+- Sending plaintext messages
+- Sending Markdown formatted text messages
+- Retrieving cached messages
+- Scheduled delivery
+
+## Future Features
+
+- Access token auth
+- Email notifications
+- Tags
+- Action buttons
+- Send to multiple topics at once
+
+## Test and Development
+
+This project uses Poetry. 
+
+### Tests
+
+This project is aiming for 95% code coverage. Any added features must include comprihensive tests.
+
+To run tests:
+
+1. `poetry install --include test`
+2. Add username and password for ntfy.sh to `.env`
+3. `poetry run pytest --cov`
+

python_ntfy-0.1.0/README.md

@@ -0,0 +1,56 @@
+# ntfy.sh Python Library
+
+An easy-to-use ntfy python library. Aiming for full feature support.
+
+## Quickstart
+
+1. Install using pip with `pip3 install python-ntfy`
+2. If you are using a server that requires auth, set the env vars
+3. Import the library
+
+ ```python
+from python_ntfy import NtfyClient
+ ```
+
+4. Create an `NtfyClient` instance with a topic
+
+```python
+client = NtfyClient(topic="Your topic")
+```
+
+5. Send a message
+
+```python
+client.send("Your message here")
+```
+
+## Supported Features
+
+- Username + password auth
+- Custom servers
+- Sending plaintext messages
+- Sending Markdown formatted text messages
+- Retrieving cached messages
+- Scheduled delivery
+
+## Future Features
+
+- Access token auth
+- Email notifications
+- Tags
+- Action buttons
+- Send to multiple topics at once
+
+## Test and Development
+
+This project uses Poetry. 
+
+### Tests
+
+This project is aiming for 95% code coverage. Any added features must include comprihensive tests.
+
+To run tests:
+
+1. `poetry install --include test`
+2. Add username and password for ntfy.sh to `.env`
+3. `poetry run pytest --cov`

python_ntfy-0.1.0/pyproject.toml

@@ -0,0 +1,20 @@
+[tool.poetry]
+name = "python-ntfy"
+version = "0.1.0"
+description = "An ntfy library aiming for feature completeness"
+authors = ["Matthew Cane <matthew.cane0@gmail.com>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.11"
+requests = "^2.31.0"
+
+[tool.poetry.group.test.dependencies]
+pytest = "^7.4.1"
+python-dotenv = "^1.0.0"
+pytest-asyncio = "^0.21.1"
+pytest-codecov = "^0.5.1"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

python_ntfy-0.1.0/python_ntfy/__init__.py

@@ -0,0 +1,40 @@
+import os
+
+
+class NtfyClient:
+    from ._send_functions import send, send_file
+    from ._get_functions import get_cached_messages
+
+    def __init__(
+        self,
+        topic: str,
+        server: str = "https://ntfy.sh",
+    ):
+        """
+        :param topic: The topic to use for this client
+        :param server: The server to connect to. Must include the protocol (http/https)
+        :return:
+        """
+        self._server = server
+        self._topic = topic
+        self.__set_url(server, topic)
+
+        if (user := os.environ.get("NTFY_USER")) and (
+            password := os.environ.get("NTFY_PASSWORD")
+        ):
+            self._auth = (user, password)
+        else:
+            self._auth = ("", "")
+
+    def __set_url(self, server, topic):
+        self.url = server.strip("/") + "/" + topic
+
+    def set_topic(self, topic: str):
+        """
+        Set a new topic for the client
+
+        :param topic: The topic to use for this client
+        :return: None
+        """
+        self._topic = topic
+        self.__set_url(self._server, self._topic)

python_ntfy-0.1.0/python_ntfy/_get_functions.py

@@ -0,0 +1,32 @@
+import json, requests
+
+
+def get_cached_messages(self, since: str = "all", scheduled: bool = False):
+    """
+    Get cached messages from the server
+
+    :param since: The timestamp to start from. If set to "all", will return all messages. Optional
+    :param scheduled: If true, will return scheduled messages. Optional
+    :return: A list of messages
+
+    :examples:
+    response = client.get(since="all")
+    response = client.get(since="all", scheduled=True)
+    response = client.get(since="2019-01-01")
+    response = client.get(since="2019-01-01", scheduled=True)
+    """
+
+    params = {"poll": "1"}
+    if scheduled:
+        params.update({"scheduled": scheduled})
+    if since:
+        params.update({"since": since})
+
+    response = [
+        json.loads(line)
+        for line in requests.get(url=self.url + "/json", params=params, auth=self._auth)
+        .text.strip()
+        .splitlines()
+    ]
+    # Reverse the list so that the most recent notification is first
+    return sorted(response, key=lambda x: x["time"], reverse=True)

python_ntfy-0.1.0/python_ntfy/_send_functions.py

@@ -0,0 +1,48 @@
+import json, requests
+
+
+def send(self, message: str, title: str = None, format_as_markdown: bool = False):
+    """
+    Send a text based message to the server
+
+    :param message: The message to send
+    :param title: The title of the message. Optional
+    :param format_as_markdown: If true, the message will be formatted as markdown. Optional
+    :return: The response from the server
+
+    :examples:
+    response = client.send(message="Example message")
+    response = client.send(message="Example message", title="Example title")
+    response = client.send(message="*Example markdown*", format_as_markdown=True)
+    """
+    headers = {
+        "Title": title,
+        "Markdown": "true" if format_as_markdown else "false",
+    }
+
+    response = json.loads(
+        requests.post(url=self.url, data=message, headers=headers, auth=self._auth).text
+    )
+    return response
+
+
+def send_file(self, file: str, title: str = None):
+    """
+    Send a file to the server
+
+    :param file_path: The path to the file to send
+    :param title: The title of the file. Optional
+    :return: The response from the server
+
+    :examples:
+    response = client.send_file(file_path="example.txt")
+    """
+    headers = {"Title": title, "Filename": file.split("/")[-1]}
+
+    with open(file, "rb") as file:
+        response = json.loads(
+            requests.post(
+                url=self.url, data=file, headers=headers, auth=self._auth
+            ).text
+        )
+    return response