Adding DataHealthClient & changelog update [2.1.22] (#114)

* Adding `DataHealthClient` & changelog update

* fmt

* comments

* params

Author: misterbrunet

docs/changelog.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog],
 and this project adheres to [Semantic Versioning].
 
+## [2.1.22] - 2025-12-15
+
+## Added
+- add DataHealthClient with two functions for obtaining Foundry Checks and Check Runs (#114)
+
 ## [2.1.21] - 2025-10-28
 
 ## Added
@@ -370,6 +375,8 @@ and this project adheres to [Semantic Versioning].
 [Keep a Changelog]: https://keepachangelog.com/en/1.0.0/
 [Semantic Versioning]: https://semver.org/spec/v2.0.0.html
 
+[2.1.22]: https://github.com/emdgroup/foundry-dev-tools/compare/v2.1.21...v2.1.22
+[2.1.21]: https://github.com/emdgroup/foundry-dev-tools/compare/v2.1.20...v2.1.21
 [2.1.20]: https://github.com/emdgroup/foundry-dev-tools/compare/v2.1.19...v2.1.20
 [2.1.19]: https://github.com/emdgroup/foundry-dev-tools/compare/v2.1.18...v2.1.19
 [2.1.18]: https://github.com/emdgroup/foundry-dev-tools/compare/v2.1.17...v2.1.18

libs/foundry-dev-tools/src/foundry_dev_tools/clients/data_health.py

@@ -0,0 +1,60 @@
+"""Implementation of the data-health API."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from foundry_dev_tools.clients.api_client import APIClient
+
+if TYPE_CHECKING:
+    import requests
+
+    from foundry_dev_tools.utils.api_types import (
+        CheckRid,
+        DatasetRid,
+    )
+
+
+class DataHealthClient(APIClient):
+    """DataHealthClient class that implements methods from the 'foundry-data-health' API."""
+
+    api_name = "data-health"
+
+    def api_get_checks_for_dataset(
+        self,
+        dataset_rid: DatasetRid,
+        branch: str = "master",
+        **kwargs,
+    ) -> requests.Response:
+        """Gets all the Check RIDs available for the given Dataset RID and branch name.
+
+        Args:
+            dataset_rid: The RID of the dataset
+            branch: The name of the branch
+            **kwargs: gets passed to :py:meth:`APIClient.api_request`
+        """
+        return self.api_request(
+            "GET",
+            api_path=f"checks/v2/{dataset_rid}/{branch}",
+            **kwargs,
+        )
+
+    def api_get_latest_checks_history(
+        self, check_rids: list[CheckRid] | CheckRid, limit: int = 5, **kwargs
+    ) -> requests.Response:
+        """Returns CheckRun metadata for the last `limit` number of check runs for the given list of Check RIDs.
+
+        Args:
+            check_rids: a list of CheckRIDs or a single string value.
+            limit: number of last check runs to go for for each Check RID. Defaults to 5.
+            **kwargs: gets passed to :py:meth:`APIClient.api_request`
+        """
+        check_rids = check_rids if isinstance(check_rids, list) else [check_rids]
+        params = {"limit": limit}
+        return self.api_request(
+            "POST",
+            api_path="checks/reports/v2/latest",
+            json=check_rids,
+            params=params,
+            **kwargs,
+        )

libs/foundry-dev-tools/src/foundry_dev_tools/config/context.py

@@ -13,6 +13,7 @@
     catalog,
     compass,
     context_client,
+    data_health,
     data_proxy,
     foundry_sql_server,
     foundry_stats,
@@ -126,6 +127,11 @@ def metadata(self) -> metadata.MetadataClient:
         """Returns :py:class:`foundry_dev_tools.clients.metadata.MetadataClient`."""
         return metadata.MetadataClient(self)
 
+    @cached_property
+    def data_health(self) -> data_health.DataHealthClient:
+        """Returns :py:class:`foundry_dev_tools.clients.data_health.DataHealthClient`."""
+        return data_health.DataHealthClient(self)
+
     @cached_property
     def data_proxy(self) -> data_proxy.DataProxyClient:
         """Returns :py:class:`foundry_dev_tools.clients.data_proxy.DataProxyClient`."""

libs/foundry-dev-tools/src/foundry_dev_tools/utils/api_types.py

@@ -59,6 +59,9 @@ def assert_in_literal(option, literal, variable_name) -> None:  # noqa: ANN001
 FolderRid = str
 """A compass folder resource identifier."""
 
+CheckRid = str
+"""A foundry data check resource identifier."""
+
 JobSpecRid = str
 """A jobspec resource identifier."""