Merge pull request #76 from opengisch/QF-5886-adding_support_for_the_status_endpoint

Adding the support for the status endpoint

Author: SeqLaz

qfieldcloud_sdk/cli.py

@@ -177,6 +177,28 @@ def logout(ctx):
         log(payload["detail"])
 
 
+@cli.command()
+@click.pass_context
+def status(ctx: Context):
+    """Check the status of the QFieldCloud server."""
+    log("Checking server status...")
+    client: sdk.Client = ctx.obj["client"]
+    is_json: bool = ctx.obj["format_json"]
+
+    status_info = client.check_server_status()
+
+    if is_json:
+        print_json(status_info)
+    else:
+        log(click.style("Server Status:", bold=True))
+
+        if isinstance(status_info, dict):
+            for key, value in status_info.items():
+                log(f"  {key.replace('_', ' ').capitalize()}: {value}")
+        else:
+            log(str(status_info))
+
+
 @cli.command()
 @paginated
 @click.option(

qfieldcloud_sdk/sdk.py

@@ -326,6 +326,28 @@ def logout(self) -> None:
 
         return resp.json()
 
+    def check_server_status(self) -> Dict[str, Any]:
+        """Checks the status of the QFieldCloud server.
+
+        This endpoint usually provides information of the server health.
+
+        Returns:
+            A dictionary containing the server status information (e.g., {"storage": "ok", ...}).
+
+        Example:
+            ```python
+            client = sdk.Client(url="[https://app.qfield.cloud/api/v1/](https://app.qfield.cloud/api/v1/)")
+            status = client.check_server_status()
+            print(f"Server status: {status}")
+            ```
+        """
+        resp = self._request(
+            "GET",
+            "status/",
+            skip_token=True,
+        )
+        return resp.json()
+
     def list_projects(
         self,
         include_public: bool = False,