[ardabot] SDK changes for upstash/qstash-server#884

qstash/asyncio/client.py

@@ -49,3 +49,20 @@ def __init__(
 
         self.dlq = AsyncDlqApi(self.http)
         """Dlq (Dead Letter Queue) api."""
+
+    async def readiness(self) -> str:
+        """
+        Checks if the QStash service is ready to accept requests.
+
+        This endpoint is commonly used in orchestration systems (like Kubernetes
+        readiness probes) to determine when a service is ready to receive traffic.
+
+        :return: "OK" if the service is ready
+        :raises QStashError: If the request fails
+        """
+        result: str = await self.http.request(
+            path="/v2/readiness",
+            method="GET",
+            parse_response=False,
+        )
+        return result

qstash/client.py

@@ -50,3 +50,20 @@ def __init__(
 
         self.dlq = DlqApi(self.http)
         """Dlq (Dead Letter Queue) api."""
+
+    def readiness(self) -> str:
+        """
+        Checks if the QStash service is ready to accept requests.
+
+        This endpoint is commonly used in orchestration systems (like Kubernetes
+        readiness probes) to determine when a service is ready to receive traffic.
+
+        :return: "OK" if the service is ready
+        :raises QStashError: If the request fails
+        """
+        result: str = self.http.request(
+            path="/v2/readiness",
+            method="GET",
+            parse_response=False,
+        )
+        return result

tests/asyncio/test_readiness.py

@@ -0,0 +1,9 @@
+import pytest
+
+from qstash import AsyncQStash
+
+
+@pytest.mark.asyncio
+async def test_readiness_async(async_client: AsyncQStash) -> None:
+    response = await async_client.readiness()
+    assert response == "OK"

tests/test_readiness.py

@@ -0,0 +1,6 @@
+from qstash import QStash
+
+
+def test_readiness(client: QStash) -> None:
+    response = client.readiness()
+    assert response == "OK"