boarddata 4.0.2__tar.gz → 4.1.2__tar.gz

{boarddata-4.0.2 → boarddata-4.1.2}/PKG-INFO

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

{boarddata-4.0.2 → boarddata-4.1.2}/__init__.py

@@ -7,7 +7,7 @@ from .errors import BoardDataError
 
 from . import types as types  # noqa: F401 — makes types accessible as boarddata.types
 
-__version__ = "4.0.2"
+__version__ = "4.1.2"
 __all__ = [
     "Base",
     "BoardDataClient",

{boarddata-4.0.2 → boarddata-4.1.2}/_base.py

@@ -105,15 +105,20 @@ class Base:
         timeout: int = 30,
         token_cache: TokenCache | None = None,
     ) -> None:
+        if not base_url.startswith("https://"):
+            logger.warning("base_url does not use HTTPS — credentials will be sent in plaintext")
         self.base_url = base_url.rstrip("/")
-        self.client_id = client_id
-        self.client_secret = client_secret
+        self._client_id = client_id
+        self._client_secret = client_secret
         self.timeout = timeout
         self._token_cache = token_cache
 
         self._token: str | None = None
         self._token_expires_at: float = 0
 
+    def __repr__(self) -> str:
+        return f"<{type(self).__name__} base_url={self.base_url!r}>"
+
     # ------------------------------------------------------------------
     # Auth
     # ------------------------------------------------------------------
@@ -132,13 +137,13 @@ class Base:
                     logger.debug("Loaded cached OAuth2 token from storage")
                     return self._token
             except Exception:
-                logger.debug("Could not read token from cache")
+                logger.warning("Could not read token from cache", exc_info=True)
 
         resp = requests.post(
             f"{self.base_url}/api/oauth/token/",
             data={
-                "client_id": self.client_id,
-                "client_secret": self.client_secret,
+                "client_id": self._client_id,
+                "client_secret": self._client_secret,
                 "grant_type": "client_credentials",
                 "scope": "read write",
             },
@@ -157,7 +162,7 @@ class Base:
                 })
                 logger.debug("Persisted OAuth2 token to storage")
             except Exception:
-                logger.debug("Could not persist token to cache")
+                logger.warning("Could not persist token to cache", exc_info=True)
 
         return self._token  # type: ignore[return-value]
 
@@ -173,6 +178,9 @@ class Base:
 
     def _url(self, path: str) -> str:
         path = path.lstrip("/")
+        if ".." in path.split("/"):
+            msg = f"Path traversal detected in URL path: {path!r}"
+            raise ValueError(msg)
         return f"{self.base_url}/api/{path}"
 
     def _request(

{boarddata-4.0.2 → boarddata-4.1.2}/_companies.py

@@ -58,6 +58,7 @@ class CompanyMixin:
         isin: str | None = None,
         country: str | None = None,
         sector: str | None = None,
+        ticker: str | None = None,
         page: int | None = None,
         page_size: int | None = None,
     ) -> PaginatedResponse:
@@ -68,6 +69,7 @@ class CompanyMixin:
             isin: Filter by exact ISIN code.
             country: Filter by ISO country code (e.g. ``"FR"``).
             sector: Filter by sector name(s), comma-separated.
+            ticker: Filter by exact stock ticker symbol.
             page: Page number (1-indexed).
             page_size: Results per page (default 25).
 
@@ -88,6 +90,7 @@ class CompanyMixin:
             isin=isin,
             country=country,
             sector=sector,
+            ticker=ticker,
             page=page,
             page_size=page_size,
         )

boarddata-4.1.2/_indexes.py

@@ -0,0 +1,127 @@
+"""Index and IndexMembership API methods."""
+
+from __future__ import annotations
+
+from typing import Any
+
+
+class IndexMixin:
+    """Index and IndexMembership CRUD.
+
+    Requires ``Base`` in the MRO (provides ``_get``, ``_post``, ``_patch``,
+    ``_delete``, ``_build_payload``).
+    """
+
+    # -- Index CRUD --
+
+    def list_indexes(
+        self,
+        *,
+        page: int | None = None,
+        page_size: int | None = None,
+    ) -> Any:
+        return self._get(  # type: ignore[attr-defined]
+            "indexes/",
+            page=page,
+            page_size=page_size,
+        )
+
+    def get_index(self, index_id: str) -> Any:
+        return self._get(f"indexes/{index_id}/")  # type: ignore[attr-defined]
+
+    def create_index(
+        self,
+        name: str,
+        *,
+        description: str | None = None,
+        data_source_url: str | None = None,
+        data_source_type: str | None = None,
+        data_source_config: dict[str, Any] | None = None,
+        display_source_url: str | None = None,
+    ) -> Any:
+        payload = self._build_payload(  # type: ignore[attr-defined]
+            name=name,
+            description=description,
+            data_source_url=data_source_url,
+            data_source_type=data_source_type,
+            data_source_config=data_source_config,
+            display_source_url=display_source_url,
+        )
+        return self._post("indexes/", payload)  # type: ignore[attr-defined]
+
+    def update_index(
+        self,
+        index_id: str,
+        *,
+        name: str | None = None,
+        description: str | None = None,
+        data_source_url: str | None = None,
+        data_source_type: str | None = None,
+        data_source_config: dict[str, Any] | None = None,
+        display_source_url: str | None = None,
+    ) -> Any:
+        payload = self._build_payload(  # type: ignore[attr-defined]
+            name=name,
+            description=description,
+            data_source_url=data_source_url,
+            data_source_type=data_source_type,
+            data_source_config=data_source_config,
+            display_source_url=display_source_url,
+        )
+        return self._patch(f"indexes/{index_id}/", payload)  # type: ignore[attr-defined]
+
+    # -- IndexMembership CRUD --
+
+    def list_index_memberships(
+        self,
+        *,
+        index_id: str | None = None,
+        company_id: str | None = None,
+        active_only: bool | None = None,
+        page: int | None = None,
+        page_size: int | None = None,
+    ) -> Any:
+        params: dict[str, Any] = {}
+        if index_id is not None:
+            params["index"] = index_id
+        if company_id is not None:
+            params["company"] = company_id
+        if active_only is not None:
+            params["active_only"] = "true" if active_only else "false"
+        if page is not None:
+            params["page"] = page
+        if page_size is not None:
+            params["page_size"] = page_size
+        return self._get("index-memberships/", **params)  # type: ignore[attr-defined]
+
+    def create_index_membership(
+        self,
+        company_id: str,
+        index_id: str,
+        *,
+        valid_from: str | None = None,
+        valid_to: str | None = None,
+    ) -> Any:
+        payload: dict[str, Any] = {
+            "company": company_id,
+            "index": index_id,
+            "valid_from": valid_from,
+            "valid_to": valid_to,
+        }
+        return self._post("index-memberships/", payload)  # type: ignore[attr-defined]
+
+    def update_index_membership(
+        self,
+        membership_id: str,
+        *,
+        valid_from: str | None = None,
+        valid_to: str | None = None,
+    ) -> Any:
+        payload = self._build_payload(  # type: ignore[attr-defined]
+            valid_from=valid_from,
+            valid_to=valid_to,
+        )
+        return self._patch(  # type: ignore[attr-defined]
+            f"index-memberships/{membership_id}/",
+            payload,
+        )

{boarddata-4.0.2 → boarddata-4.1.2}/boarddata.egg-info/PKG-INFO

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

{boarddata-4.0.2 → boarddata-4.1.2}/boarddata.egg-info/SOURCES.txt

@@ -10,6 +10,7 @@ _criteria.py
 _directors.py
 _documents.py
 _esg.py
+_indexes.py
 _persons.py
 _sentinel.py
 _utilities.py
@@ -29,6 +30,7 @@ pyproject.toml
 ./_directors.py
 ./_documents.py
 ./_esg.py
+./_indexes.py
 ./_persons.py
 ./_sentinel.py
 ./_utilities.py
@@ -55,6 +57,7 @@ tests/test_criteria.py
 tests/test_directors.py
 tests/test_documents.py
 tests/test_esg.py
+tests/test_indexes.py
 tests/test_persons.py
 tests/test_sentinel.py
 tests/test_utilities.py
@@ -68,5 +71,6 @@ types/criteria.py
 types/directors.py
 types/documents.py
 types/esg.py
+types/indexes.py
 types/persons.py
 types/sentinel.py

{boarddata-4.0.2 → boarddata-4.1.2}/cache.py

@@ -34,9 +34,12 @@ class FileTokenCache:
 
     def write(self, data: dict[str, Any]) -> None:
         """Persist token data."""
+        import os
+
         p = Path(self._path)
         p.parent.mkdir(parents=True, exist_ok=True)
         p.write_text(json.dumps(data))
+        os.chmod(p, 0o600)
 
 
 class ScalewaySecretTokenCache:

{boarddata-4.0.2 → boarddata-4.1.2}/client.py

@@ -11,6 +11,7 @@ from ._criteria import CriteriaMixin
 from ._directors import DirectorMixin
 from ._documents import DocumentMixin
 from ._esg import ESGMixin
+from ._indexes import IndexMixin
 from ._persons import PersonMixin
 from ._sentinel import SentinelMixin
 from ._utilities import UtilitiesMixin
@@ -27,6 +28,7 @@ class BoardDataClient(
     ESGMixin,
     SentinelMixin,
     CriteriaMixin,
+    IndexMixin,
     UtilitiesMixin,
     Base,
 ):

{boarddata-4.0.2 → boarddata-4.1.2}/pyproject.toml

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

{boarddata-4.0.2 → boarddata-4.1.2}/tests/test_config.py

@@ -20,8 +20,8 @@ class TestFromEnv:
     def test_creates_client_from_env(self) -> None:
         client = BoardDataClient.from_env()
         assert client.base_url == "https://api.example.com"
-        assert client.client_id == "cid"
-        assert client.client_secret == "csecret"
+        assert client._client_id == "cid"
+        assert client._client_secret == "csecret"
 
     @patch.dict(os.environ, {}, clear=True)
     def test_raises_when_env_missing(self) -> None:

boarddata-4.1.2/tests/test_indexes.py

@@ -0,0 +1,112 @@
+"""Tests for IndexMixin methods.
+
+Uses the shared ``client`` fixture from ``conftest.py`` which creates a
+``BoardDataClient`` with mocked ``_request`` and ``_get_token``.
+"""
+
+from __future__ import annotations
+
+import pytest
+
+
+class TestListIndexes:
+    def test_calls_correct_path(self, client):
+        client._request.return_value = {"count": 0, "results": []}
+        client.list_indexes()
+        args, kwargs = client._request.call_args
+        assert args == ("GET", "indexes/")
+
+    def test_returns_paginated_response(self, client):
+        client._request.return_value = {
+            "count": 1,
+            "next": None,
+            "previous": None,
+            "results": [{"id": "uuid1", "name": "CAC 40"}],
+        }
+        result = client.list_indexes()
+        assert result["count"] == 1
+
+
+class TestGetIndex:
+    def test_calls_correct_path(self, client):
+        client._request.return_value = {"id": "uuid1", "name": "CAC 40"}
+        client.get_index("uuid1")
+        args, kwargs = client._request.call_args
+        assert args == ("GET", "indexes/uuid1/")
+
+
+class TestCreateIndex:
+    def test_sends_payload(self, client):
+        client._request.return_value = {"id": "uuid1", "name": "CAC 40"}
+        client.create_index(name="CAC 40", data_source_type="wikipedia")
+        args, kwargs = client._request.call_args
+        assert args == ("POST", "indexes/")
+        assert kwargs["json"]["name"] == "CAC 40"
+        assert kwargs["json"]["data_source_type"] == "wikipedia"
+
+    def test_excludes_none_values(self, client):
+        client._request.return_value = {"id": "uuid1", "name": "CAC 40"}
+        client.create_index(name="CAC 40")
+        _, kwargs = client._request.call_args
+        assert "data_source_type" not in kwargs["json"]
+
+
+class TestUpdateIndex:
+    def test_sends_patch(self, client):
+        client._request.return_value = {"id": "uuid1", "name": "CAC 40"}
+        client.update_index("uuid1", description="French blue-chip")
+        args, kwargs = client._request.call_args
+        assert args == ("PATCH", "indexes/uuid1/")
+        assert kwargs["json"]["description"] == "French blue-chip"
+
+
+class TestListIndexMemberships:
+    def test_calls_correct_path(self, client):
+        client._request.return_value = {"count": 0, "results": []}
+        client.list_index_memberships()
+        args, kwargs = client._request.call_args
+        assert args == ("GET", "index-memberships/")
+
+    def test_passes_filters(self, client):
+        client._request.return_value = {"count": 0, "results": []}
+        client.list_index_memberships(index_id="uuid1", active_only=True)
+        _, kwargs = client._request.call_args
+        assert kwargs["params"]["index"] == "uuid1"
+        assert kwargs["params"]["active_only"] == "true"
+
+
+class TestCreateIndexMembership:
+    def test_sends_payload(self, client):
+        client._request.return_value = {"id": "m-uuid"}
+        client.create_index_membership(
+            company_id="c-uuid", index_id="i-uuid"
+        )
+        args, kwargs = client._request.call_args
+        assert args == ("POST", "index-memberships/")
+        assert kwargs["json"]["company"] == "c-uuid"
+        assert kwargs["json"]["index"] == "i-uuid"
+
+    def test_sends_valid_from_none(self, client):
+        client._request.return_value = {"id": "m-uuid"}
+        client.create_index_membership(
+            company_id="c-uuid", index_id="i-uuid", valid_from=None
+        )
+        _, kwargs = client._request.call_args
+        assert kwargs["json"]["valid_from"] is None
+
+
+class TestUpdateIndexMembership:
+    def test_sends_patch(self, client):
+        client._request.return_value = {"id": "m-uuid"}
+        client.update_index_membership("m-uuid", valid_to="2026-04-07")
+        args, kwargs = client._request.call_args
+        assert args == ("PATCH", "index-memberships/m-uuid/")
+        assert kwargs["json"]["valid_to"] == "2026-04-07"
+
+
+class TestListCompaniesTickerFilter:
+    def test_passes_ticker_param(self, client):
+        client._request.return_value = {"count": 0, "results": []}
+        client.list_companies(ticker="AI")
+        _, kwargs = client._request.call_args
+        assert kwargs["params"]["ticker"] == "AI"

{boarddata-4.0.2 → boarddata-4.1.2}/types/__init__.py

@@ -1,5 +1,13 @@
 """BoardData API type definitions."""
 
+from .indexes import (
+    CreateIndexMembershipPayload,
+    CreateIndexPayload,
+    IndexItem,
+    IndexMembershipItem,
+    UpdateIndexMembershipPayload,
+    UpdateIndexPayload,
+)
 from .esg import (
     CompanyESGBenchmarkItem,
     IROBatchItemPayload,
@@ -117,6 +125,13 @@ from .sentinel import (
 )
 
 __all__ = [
+    # indexes
+    "CreateIndexMembershipPayload",
+    "CreateIndexPayload",
+    "IndexItem",
+    "IndexMembershipItem",
+    "UpdateIndexMembershipPayload",
+    "UpdateIndexPayload",
     # esg
     "CompanyESGBenchmarkItem",
     "IROBatchItemPayload",

boarddata-4.1.2/types/indexes.py

@@ -0,0 +1,67 @@
+"""TypedDict definitions for Index and IndexMembership API types."""
+
+from __future__ import annotations
+
+from typing import Any
+
+try:
+    from typing import NotRequired, TypedDict
+except ImportError:
+    from typing_extensions import NotRequired, TypedDict
+
+
+# -- Response types --
+
+
+class IndexItem(TypedDict):
+    id: str
+    name: str
+    description: str
+    data_source_url: str
+    data_source_type: str
+    data_source_config: dict[str, Any]
+    display_source_url: str
+
+
+class IndexMembershipItem(TypedDict):
+    id: str
+    company: str
+    company_name: str
+    company_ticker: str
+    index: str
+    index_name: str
+    valid_from: str | None
+    valid_to: str | None
+
+
+# -- Create/Update payloads --
+
+
+class CreateIndexPayload(TypedDict):
+    name: str
+    description: NotRequired[str]
+    data_source_url: NotRequired[str]
+    data_source_type: NotRequired[str]
+    data_source_config: NotRequired[dict[str, Any]]
+    display_source_url: NotRequired[str]
+
+
+class UpdateIndexPayload(TypedDict, total=False):
+    name: str
+    description: str
+    data_source_url: str
+    data_source_type: str
+    data_source_config: dict[str, Any]
+    display_source_url: str
+
+
+class CreateIndexMembershipPayload(TypedDict):
+    company: str
+    index: str
+    valid_from: NotRequired[str | None]
+    valid_to: NotRequired[str | None]
+
+
+class UpdateIndexMembershipPayload(TypedDict, total=False):
+    valid_from: str | None
+    valid_to: str | None