boarddata 6.5.1__tar.gz → 6.6.2__tar.gz

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

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

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

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

boarddata-6.6.2/_committees.py

@@ -0,0 +1,16 @@
+"""Board-committee batch methods."""
+
+from __future__ import annotations
+
+from .types.committees import CommitteeBatchItemPayload, CommitteeBatchResultItem
+
+
+class CommitteesMixin:
+    def batch_create_committees(
+        self, items: list[CommitteeBatchItemPayload]
+    ) -> list[CommitteeBatchResultItem]:
+        """Batch upsert board committees. Each item is keyed by issuer ISIN;
+        the backend resolves members to existing persons and idempotently
+        upserts Committee + CommitteeMembership. Returns one result per item
+        (action: loaded / skipped_unknown_company / error)."""
+        return self._post("committees/batch/", items)  # type: ignore[attr-defined]

boarddata-6.6.2/_risks.py

@@ -0,0 +1,35 @@
+"""Risk-Factors (Art. 16) methods."""
+
+from __future__ import annotations
+
+from .types.risks import RiskSectionBatchItemPayload, RiskSectionBatchResultItem
+
+
+class RisksMixin:
+    """Risk-Factors API methods (Art. 16 'Risk Factors' disclosure)."""
+
+    def batch_create_risk_section(
+        self,
+        sections: list[RiskSectionBatchItemPayload],
+    ) -> list[RiskSectionBatchResultItem]:
+        """Batch upsert risk sections.
+
+        Each item is matched by the natural key ``(company, date_publication)``,
+        where ``company`` is the issuer ISIN; the backend does a delete-and-replace
+        of the section's categories and factors. A ``section_found: false`` envelope
+        is accepted (it records the negative finding).
+
+        Args:
+            sections: List of risk-section envelopes
+                (``company``, ``date_publication``, ``_risk_section``,
+                ``_risk_categories``, ``_risk_factor_items``).
+
+        Returns:
+            One result per item, each with ``company`` and ``action``
+            (``"loaded"`` / ``"skipped_unknown_company"`` / ``"error"``); a loaded
+            section also carries ``section_id`` and ``factor_count``.
+
+        Raises:
+            BoardDataError: On non-2xx API response.
+        """
+        return self._post("risks/batch/", sections)  # type: ignore[attr-defined]

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

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

{boarddata-6.5.1 → boarddata-6.6.2}/boarddata.egg-info/SOURCES.txt

@@ -5,6 +5,7 @@ _assemblies.py
 _auditors.py
 _base.py
 _comex.py
+_committees.py
 _companies.py
 _criteria.py
 _directors.py
@@ -12,6 +13,7 @@ _documents.py
 _esg.py
 _indexes.py
 _persons.py
+_risks.py
 _sentinel.py
 _utilities.py
 cache.py
@@ -25,6 +27,7 @@ pyproject.toml
 ./_auditors.py
 ./_base.py
 ./_comex.py
+./_committees.py
 ./_companies.py
 ./_criteria.py
 ./_directors.py
@@ -32,6 +35,7 @@ pyproject.toml
 ./_esg.py
 ./_indexes.py
 ./_persons.py
+./_risks.py
 ./_sentinel.py
 ./_utilities.py
 ./cache.py
@@ -51,6 +55,7 @@ tests/test_base.py
 tests/test_build_payload.py
 tests/test_cache.py
 tests/test_comex.py
+tests/test_committees.py
 tests/test_companies.py
 tests/test_config.py
 tests/test_criteria.py
@@ -60,12 +65,14 @@ tests/test_esg.py
 tests/test_exports.py
 tests/test_indexes.py
 tests/test_persons.py
+tests/test_risks.py
 tests/test_sentinel.py
 tests/test_utilities.py
 types/__init__.py
 types/assemblies.py
 types/auditors.py
 types/comex.py
+types/committees.py
 types/companies.py
 types/core.py
 types/criteria.py
@@ -74,4 +81,5 @@ types/documents.py
 types/esg.py
 types/indexes.py
 types/persons.py
+types/risks.py
 types/sentinel.py

{boarddata-6.5.1 → boarddata-6.6.2}/client.py

@@ -5,6 +5,7 @@ from __future__ import annotations
 from ._assemblies import AssemblyMixin
 from ._auditors import AuditorMixin
 from ._base import Base
+from ._committees import CommitteesMixin
 from ._comex import ComexMixin
 from ._companies import CompanyMixin
 from ._criteria import CriteriaMixin
@@ -13,6 +14,7 @@ from ._documents import DocumentMixin
 from ._esg import ESGMixin
 from ._indexes import IndexMixin
 from ._persons import PersonMixin
+from ._risks import RisksMixin
 from ._sentinel import SentinelMixin
 from ._utilities import UtilitiesMixin
 
@@ -25,7 +27,9 @@ class BoardDataClient(
     AuditorMixin,
     DocumentMixin,
     AssemblyMixin,
+    CommitteesMixin,
     ESGMixin,
+    RisksMixin,
     SentinelMixin,
     CriteriaMixin,
     IndexMixin,

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

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

boarddata-6.6.2/tests/test_committees.py

@@ -0,0 +1,32 @@
+"""Tests for CommitteesMixin methods."""
+
+from __future__ import annotations
+
+from unittest.mock import MagicMock
+
+
+def make_client():
+    from boarddata._base import Base
+    from boarddata._committees import CommitteesMixin
+
+    class TestClient(CommitteesMixin, Base):
+        pass
+
+    client = TestClient.__new__(TestClient)
+    client._request = MagicMock()
+    client._get_token = MagicMock(return_value="fake-token")
+    client.base_url = "https://api.example.com"
+    client.timeout = 30
+    return client
+
+
+class TestBatchCreateCommittees:
+    def test_batch_create_committees_posts_to_endpoint(self):
+        c = make_client()
+        c._request.return_value = [{"company": "FR0000000020", "action": "loaded"}]
+        items = [{"company": "FR0000000020", "year": 2025, "committees": []}]
+        out = c.batch_create_committees(items)
+        args, kwargs = c._request.call_args
+        assert args == ("POST", "committees/batch/")
+        assert kwargs["json"] is items
+        assert out[0]["action"] == "loaded"

boarddata-6.6.2/tests/test_risks.py

@@ -0,0 +1,59 @@
+"""Tests for RisksMixin methods."""
+
+from __future__ import annotations
+
+from unittest.mock import MagicMock
+
+
+def make_client():
+    from boarddata._base import Base
+    from boarddata._risks import RisksMixin
+
+    class TestClient(RisksMixin, Base):
+        pass
+
+    client = TestClient.__new__(TestClient)
+    client._request = MagicMock()
+    client._get_token = MagicMock(return_value="fake-token")
+    client.base_url = "https://api.example.com"
+    client.timeout = 30
+    return client
+
+
+class TestBatchCreateRiskSection:
+    def test_posts_envelopes_to_batch_path(self):
+        c = make_client()
+        c._request.return_value = [
+            {"company": "FR0000120271", "section_id": "s1", "factor_count": 12, "action": "loaded"}
+        ]
+        envelopes = [
+            {
+                "company": "FR0000120271",
+                "date_publication": "2025-01-01",
+                "_risk_section": {"section_found": True, "scale_type": "numeric"},
+                "_risk_categories": [{"label_native": "Risques financiers"}],
+                "_risk_factor_items": [{"title_native": "Risque de change"}],
+            }
+        ]
+        result = c.batch_create_risk_section(envelopes)
+        args, kwargs = c._request.call_args
+        assert args == ("POST", "risks/batch/")
+        assert kwargs["json"] is envelopes
+        assert result[0]["action"] == "loaded"
+        assert result[0]["factor_count"] == 12
+
+    def test_passes_section_not_found_envelope_through(self):
+        c = make_client()
+        c._request.return_value = [{"company": "FR0000131104", "action": "loaded"}]
+        envelopes = [
+            {
+                "company": "FR0000131104",
+                "date_publication": "2025-01-01",
+                "_risk_section": {"section_found": False},
+                "_risk_categories": [],
+                "_risk_factor_items": [],
+            }
+        ]
+        c.batch_create_risk_section(envelopes)
+        _, kwargs = c._request.call_args
+        assert kwargs["json"][0]["_risk_section"]["section_found"] is False

{boarddata-6.5.1 → boarddata-6.6.2}/types/__init__.py

@@ -113,6 +113,10 @@ from .persons import (
     SchoolItem,
     UpdatePersonPayload,
 )
+from .risks import (
+    RiskSectionBatchItemPayload,
+    RiskSectionBatchResultItem,
+)
 from .sentinel import (
     AnalysisDetail,
     AnalysisListItem,
@@ -227,6 +231,9 @@ __all__ = [
     "PersonSimilarityItem",
     "SchoolItem",
     "UpdatePersonPayload",
+    # risks
+    "RiskSectionBatchItemPayload",
+    "RiskSectionBatchResultItem",
     # sentinel
     "AnalysisDetail",
     "AnalysisListItem",

boarddata-6.6.2/types/committees.py

@@ -0,0 +1,27 @@
+"""Committee batch types. The nested committee/member dicts are issuer-shaped;
+the authoritative schema lives in the extractor + apps/committees loader."""
+
+from __future__ import annotations
+
+import sys
+from typing import Any
+
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict
+else:
+    from typing_extensions import NotRequired, TypedDict
+
+
+class CommitteeBatchItemPayload(TypedDict):
+    company: str  # issuer ISIN
+    year: int
+    committees: list[dict[str, Any]]
+
+
+class CommitteeBatchResultItem(TypedDict):
+    company: str
+    action: str  # "loaded" | "skipped_unknown_company" | "error"
+    committees_loaded: NotRequired[int]
+    memberships_loaded: NotRequired[int]
+    members_unmatched: NotRequired[list[str]]
+    detail: NotRequired[str]

boarddata-6.6.2/types/risks.py

@@ -0,0 +1,53 @@
+"""Risk-Factors (Art. 16) batch types.
+
+The risk-section batch envelope is built by the URD extraction pipeline's
+``risk_factors`` adapter. Its nested members (``_risk_section``,
+``_risk_categories``, ``_risk_factor_items``) are issuer-shaped and carry
+free-form fields (e.g. ``quant_metrics``), so they are typed loosely as
+``dict[str, Any]`` rather than fully enumerated here — the authoritative schema
+lives in the extractor contract and the backend loader (``apps/risks``).
+"""
+
+from __future__ import annotations
+
+import sys
+from typing import Any
+
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict
+else:
+    from typing_extensions import NotRequired, TypedDict
+
+
+class RiskSectionBatchItemPayload(TypedDict):
+    """One envelope in a ``batch_create_risk_section`` request.
+
+    Matched by the natural key ``(company, date_publication)``; the backend
+    does a delete-and-replace of the section's categories/factors.
+    """
+
+    company: str
+    """Issuer ISIN (the batch endpoint matches Company by isin, not UUID)."""
+    date_publication: str
+    """Publication date, ``"YYYY-MM-DD"``."""
+    _risk_section: dict[str, Any]
+    """Section-level scale/methodology metadata (incl. ``section_found``)."""
+    _risk_categories: list[dict[str, Any]]
+    """Category headings (native + English label)."""
+    _risk_factor_items: list[dict[str, Any]]
+    """Individual risk factors with their native ratings / field sources."""
+
+
+class RiskSectionBatchResultItem(TypedDict):
+    """One result in a ``batch_create_risk_section`` response.
+
+    ``action`` is one of ``"loaded"`` (section upserted),
+    ``"skipped_unknown_company"`` (no Company for the ISIN — seed it first), or
+    ``"error"`` (malformed item; ``detail`` carries the message).
+    """
+
+    company: str
+    action: str
+    section_id: NotRequired[str]
+    factor_count: NotRequired[int]
+    detail: NotRequired[str]