boarddata 6.6.2__tar.gz → 6.6.3__tar.gz

{boarddata-6.6.2 → boarddata-6.6.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boarddata
-Version: 6.6.2
+Version: 6.6.3
 Summary: Python SDK for the BoardData V2 REST API
 License: MIT
 Classifier: Development Status :: 4 - Beta

{boarddata-6.6.2 → boarddata-6.6.3}/__init__.py

@@ -6,7 +6,7 @@ from .cache import FileTokenCache, ScalewaySecretTokenCache
 from .client import BoardDataClient
 from .errors import BoardDataError, ExportTooLargeError
 
-__version__ = "6.6.2"
+__version__ = "6.6.3"
 __all__ = [
     "Base",
     "BoardDataClient",

{boarddata-6.6.2 → boarddata-6.6.3}/_criteria.py

@@ -4,7 +4,7 @@ from __future__ import annotations
 
 from typing import Any
 
-from .types.criteria import CriteriaCatalogItem, CriteriaThemeItem
+from .types.criteria import CriteriaCatalogItem, CriteriaFamilyItem, CriteriaThemeItem
 
 
 class CriteriaMixin:
@@ -25,6 +25,19 @@ class CriteriaMixin:
         """
         return self._get("criteria-themes/")  # type: ignore[attr-defined]
 
+    def list_criteria_families(self) -> list[CriteriaFamilyItem]:
+        """List the 17 criteria families (business-meaning classification).
+
+        Returns:
+            List of criteria families in ``sort_order`` (not paginated).
+            Slugs are a cross-repo contract — extraction committers
+            preflight their families.json against this list.
+
+        Raises:
+            BoardDataError: On non-2xx API response.
+        """
+        return self._get("criteria-families/")  # type: ignore[attr-defined]
+
     def list_criteria(
         self,
         theme: str | None = None,

{boarddata-6.6.2 → boarddata-6.6.3}/boarddata.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boarddata
-Version: 6.6.2
+Version: 6.6.3
 Summary: Python SDK for the BoardData V2 REST API
 License: MIT
 Classifier: Development Status :: 4 - Beta

{boarddata-6.6.2 → boarddata-6.6.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "boarddata"
-version = "6.6.2"
+version = "6.6.3"
 description = "Python SDK for the BoardData V2 REST API"
 readme = "README.md"
 license = {text = "MIT"}

{boarddata-6.6.2 → boarddata-6.6.3}/tests/test_criteria.py

@@ -66,3 +66,16 @@ class TestCreateCriteria:
         payload = kwargs["json"]
         assert payload["name"] == "Safety Rate"
         assert "theme_id" not in payload
+
+
+class TestListCriteriaFamilies:
+    def test_calls_correct_path(self):
+        c = make_client()
+        c._request.return_value = [
+            {"slug": "revenue_growth", "name": "Revenue & Growth", "pillar": "financial", "sort_order": 1}
+        ]
+        result = c.list_criteria_families()
+        args, _ = c._request.call_args
+        assert args == ("GET", "criteria-families/")
+        assert result[0]["slug"] == "revenue_growth"
+        assert result[0]["pillar"] == "financial"

{boarddata-6.6.2 → boarddata-6.6.3}/types/criteria.py

@@ -17,6 +17,20 @@ class CriteriaThemeItem(TypedDict):
     category: str
 
 
+class CriteriaFamilyItem(TypedDict):
+    """Criteria family as returned by the criteria-families endpoint.
+
+    The 17-row business-meaning classification catalog (4 pillars). Slugs
+    are a cross-repo contract with extraction's families.json — consumers
+    preflight against this list to detect drift.
+    """
+
+    slug: str
+    name: str
+    pillar: str
+    sort_order: int
+
+
 class CriteriaCatalogItem(TypedDict):
     """Criteria catalog entry as returned by the criteria endpoint."""