proxyml 0.9.0__tar.gz → 0.10.0__tar.gz

{proxyml-0.9.0 → proxyml-0.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: proxyml
-Version: 0.9.0
+Version: 0.10.0
 Summary: Python SDK for calling the ProxyML API
 Author-email: ProxyML <contact@proxyml.ai>
 License:                                  Apache License
@@ -333,6 +333,9 @@ See [`docs/quickstart.md`](docs/quickstart.md) for a full walkthrough and [`docs
 | `interpret_counterfactual(sample, counterfactual, ...)` | Generate a human-readable explanation |
 | `proxyml.local.train_challenger(df, target, schema, ...)` | Train a challenger model locally — no API round-trip (`pip install 'proxyml[local]'`) |
 | `proxyml.local.train_auto_challenger(data, target_col, ...)` | Load data + train a local challenger in one call |
+| `upload_challenger(payload, ci_token=None)` | Upload a challenger comparison headlessly, e.g. from CI (`PROXYML_CI_TOKEN`, not `PROXYML_API_KEY`) |
+| `get_challenger_summary(ci_token=None)` | Fetch a CI-ready summary of the latest challenger comparison |
+| `proxyml.ci.post_challenger_comment(...)` | Post/update a sticky PR comment with the challenger comparison |
 
 Full documentation: [`docs/api.md`](docs/api.md)
 
@@ -344,6 +347,7 @@ Full documentation: [`docs/api.md`](docs/api.md)
 - [`examples/multiclass_example.py`](examples/multiclass_example.py) — Multi-class classification with per-class feature importances
 - [`examples/testing_example.py`](examples/testing_example.py) — Using a surrogate as a reference model in CI
 - [`examples/surrogate_export_example.py`](examples/surrogate_export_example.py) — Exporting a surrogate and reproducing its predictions locally
+- [`examples/ci_challenger_example.py`](examples/ci_challenger_example.py) + [`examples/github_actions_challenger.yml`](examples/github_actions_challenger.yml) — Training a challenger and posting the comparison as a PR comment from CI
 
 ## License
 

{proxyml-0.9.0 → proxyml-0.10.0}/README.md

@@ -111,6 +111,9 @@ See [`docs/quickstart.md`](docs/quickstart.md) for a full walkthrough and [`docs
 | `interpret_counterfactual(sample, counterfactual, ...)` | Generate a human-readable explanation |
 | `proxyml.local.train_challenger(df, target, schema, ...)` | Train a challenger model locally — no API round-trip (`pip install 'proxyml[local]'`) |
 | `proxyml.local.train_auto_challenger(data, target_col, ...)` | Load data + train a local challenger in one call |
+| `upload_challenger(payload, ci_token=None)` | Upload a challenger comparison headlessly, e.g. from CI (`PROXYML_CI_TOKEN`, not `PROXYML_API_KEY`) |
+| `get_challenger_summary(ci_token=None)` | Fetch a CI-ready summary of the latest challenger comparison |
+| `proxyml.ci.post_challenger_comment(...)` | Post/update a sticky PR comment with the challenger comparison |
 
 Full documentation: [`docs/api.md`](docs/api.md)
 
@@ -122,6 +125,7 @@ Full documentation: [`docs/api.md`](docs/api.md)
 - [`examples/multiclass_example.py`](examples/multiclass_example.py) — Multi-class classification with per-class feature importances
 - [`examples/testing_example.py`](examples/testing_example.py) — Using a surrogate as a reference model in CI
 - [`examples/surrogate_export_example.py`](examples/surrogate_export_example.py) — Exporting a surrogate and reproducing its predictions locally
+- [`examples/ci_challenger_example.py`](examples/ci_challenger_example.py) + [`examples/github_actions_challenger.yml`](examples/github_actions_challenger.yml) — Training a challenger and posting the comparison as a PR comment from CI
 
 ## License
 

{proxyml-0.9.0 → proxyml-0.10.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "proxyml"
-version = "0.9.0"
+version = "0.10.0"
 description = "Python SDK for calling the ProxyML API"
 readme = "README.md"
 license = {file = "LICENSE"}

{proxyml-0.9.0 → proxyml-0.10.0}/src/proxyml/__init__.py

@@ -26,6 +26,8 @@ from proxyml.client import (
     explain_local,
     explain_local_batch,
     update_model,
+    upload_challenger,
+    get_challenger_summary,
 )
 from proxyml.schema_builder import get_schema
 
@@ -58,5 +60,7 @@ __all__ = [
     "explain_local",
     "explain_local_batch",
     "update_model",
+    "upload_challenger",
+    "get_challenger_summary",
     "get_schema",
 ]

proxyml-0.10.0/src/proxyml/ci.py

@@ -0,0 +1,147 @@
+"""Post a champion/challenger comparison to a GitHub pull request from CI.
+
+Typical use in a GitHub Actions job, after training and uploading a
+challenger::
+
+    from proxyml import local, ci
+    from proxyml.client import upload_challenger
+
+    result = local.train_challenger(...)
+    payload = local.to_challenger_upload(result, champion_metrics=...)
+    upload_challenger(payload)
+    ci.post_challenger_comment()
+
+Reads GITHUB_TOKEN, GITHUB_REPOSITORY, and GITHUB_EVENT_PATH from the
+environment by default — all three are set automatically inside a GitHub
+Actions job triggered by a pull_request event, alongside PROXYML_CI_TOKEN
+(set as a repo secret), so the common case needs no arguments at all.
+
+This never runs server-side — ProxyML's backend doesn't talk to GitHub —
+so it lives in the SDK, not proxyml_core.
+"""
+
+import json
+import logging
+import os
+
+import requests
+
+from proxyml.client import get_challenger_summary
+
+logger = logging.getLogger(__name__)
+
+_TIMEOUT = 30
+_COMMENT_MARKER = "<!-- proxyml-challenger-comment -->"
+
+
+def _github_headers(github_token: str) -> dict:
+    return {
+        "Authorization": f"Bearer {github_token}",
+        "Accept": "application/vnd.github+json",
+        "X-GitHub-Api-Version": "2022-11-28",
+    }
+
+
+def _resolve_github_token(github_token: str | None) -> str:
+    token = github_token or os.getenv("GITHUB_TOKEN", "")
+    if not token:
+        raise EnvironmentError(
+            "GITHUB_TOKEN is not set and no github_token was provided. GitHub Actions "
+            "sets this automatically for a job that declares 'env: {GITHUB_TOKEN: "
+            "${{ secrets.GITHUB_TOKEN }}}' — add that to the step if it's missing."
+        )
+    return token
+
+
+def _resolve_repo(repo: str | None) -> str:
+    resolved = repo or os.getenv("GITHUB_REPOSITORY", "")
+    if not resolved:
+        raise EnvironmentError(
+            "GITHUB_REPOSITORY is not set and no repo was provided. "
+            "This is set automatically inside GitHub Actions."
+        )
+    return resolved
+
+
+def _resolve_pr_number(pr_number: int | None) -> int:
+    if pr_number is not None:
+        return pr_number
+    event_path = os.getenv("GITHUB_EVENT_PATH")
+    if not event_path:
+        raise EnvironmentError(
+            "GITHUB_EVENT_PATH is not set and no pr_number was provided. "
+            "This is set automatically inside GitHub Actions on pull_request events "
+            "— on other event types, pass pr_number explicitly."
+        )
+    with open(event_path) as f:
+        event = json.load(f)
+    number = (event.get("pull_request") or {}).get("number", event.get("number"))
+    if number is None:
+        raise ValueError(
+            f"Could not find a pull request number in {event_path}. This workflow may "
+            "not be running on a pull_request event — pass pr_number explicitly."
+        )
+    return number
+
+
+def _find_existing_comment(repo: str, pr_number: int, headers: dict) -> int | None:
+    """Look for a prior challenger comment on this PR, so re-runs edit it instead of piling up."""
+    url = f"https://api.github.com/repos/{repo}/issues/{pr_number}/comments"
+    r = requests.get(url, headers=headers, timeout=_TIMEOUT)
+    r.raise_for_status()
+    for comment in r.json():
+        if _COMMENT_MARKER in comment.get("body", ""):
+            return comment["id"]
+    return None
+
+
+def post_challenger_comment(
+    *,
+    ci_token: str | None = None,
+    github_token: str | None = None,
+    repo: str | None = None,
+    pr_number: int | None = None,
+) -> dict | None:
+    """Post or update a sticky PR comment summarizing the latest challenger comparison.
+
+    Call this after uploading a challenger via proxyml.client.upload_challenger()
+    — it fetches the CI-ready summary for the project authorized by the CI
+    token, then posts it to the pull request. A second run on the same PR
+    edits the existing comment in place (matched via a hidden HTML marker)
+    rather than adding a duplicate, the same way coverage bots behave.
+
+    Args:
+        ci_token: overrides PROXYML_CI_TOKEN if provided.
+        github_token: overrides GITHUB_TOKEN if provided.
+        repo: "owner/name", overrides GITHUB_REPOSITORY if provided.
+        pr_number: overrides the PR number GitHub Actions reports via GITHUB_EVENT_PATH.
+
+    Returns:
+        The created/updated GitHub comment JSON, or None if the challenger
+        summary couldn't be fetched or the GitHub API call failed.
+    """
+    summary = get_challenger_summary(ci_token=ci_token)
+    if summary is None:
+        return None
+
+    headers = _github_headers(_resolve_github_token(github_token))
+    resolved_repo = _resolve_repo(repo)
+    resolved_pr = _resolve_pr_number(pr_number)
+    body = f"{_COMMENT_MARKER}\n{summary['markdown_summary']}"
+
+    try:
+        existing_id = _find_existing_comment(resolved_repo, resolved_pr, headers)
+        base_url = f"https://api.github.com/repos/{resolved_repo}/issues"
+        if existing_id is not None:
+            r = requests.patch(
+                f"{base_url}/comments/{existing_id}", headers=headers, json={"body": body}, timeout=_TIMEOUT,
+            )
+        else:
+            r = requests.post(
+                f"{base_url}/{resolved_pr}/comments", headers=headers, json={"body": body}, timeout=_TIMEOUT,
+            )
+        r.raise_for_status()
+    except requests.exceptions.RequestException as exc:
+        logger.error("Failed to post challenger comment to GitHub: %s", exc)
+        return None
+    return r.json()

{proxyml-0.9.0 → proxyml-0.10.0}/src/proxyml/client.py

@@ -48,13 +48,35 @@ def _headers() -> dict:
     }
 
 
-def post(endpoint: str, payload: dict) -> requests.models.Response | _ErrorResponse:
+def _ci_headers(ci_token: str | None = None) -> dict:
+    """
+    Constructs request headers authenticated with a project-scoped CI token
+    rather than the account-wide PROXYML_API_KEY — see upload_challenger()
+    and get_challenger_summary().
+    """
+    token = ci_token or os.getenv("PROXYML_CI_TOKEN", "")
+    if not token:
+        raise EnvironmentError(
+            "PROXYML_CI_TOKEN is not set and no ci_token was provided. "
+            "Mint one from the ProxyML dashboard for this project, then set the "
+            "environment variable or pass ci_token= explicitly."
+        )
+    return {
+        'Content-Type': 'application/json',
+        'X-CI-TOKEN': token,
+    }
+
+
+def post(
+    endpoint: str, payload: dict, headers: dict | None = None
+) -> requests.models.Response | _ErrorResponse:
     """
     POSTs a request to a ProxyML API endpoint.
 
     Args:
         endpoint (str): ProxyML API endpoint.  PROXYML_BASE_URL is prepended e.g. use endpoint='/schemas' not 'https://api.proxyml.ai/api/v1/schemas'.
         payload (dict): JSON payload to POST.
+        headers (dict): overrides the default X-API-KEY auth headers, e.g. with _ci_headers().
 
     Returns:
         requests Response object.
@@ -63,7 +85,7 @@ def post(endpoint: str, payload: dict) -> requests.models.Response | _ErrorRespo
         return requests.post(
             url=f'{_base_url()}{endpoint}',
             data=orjson.dumps(payload, option=orjson.OPT_SERIALIZE_NUMPY),
-            headers=_headers(),
+            headers=headers if headers is not None else _headers(),
             timeout=_TIMEOUT,
         )
     except requests.exceptions.RequestException as exc:
@@ -94,13 +116,16 @@ def put(endpoint: str, payload: dict) -> requests.models.Response | _ErrorRespon
         return _ErrorResponse()
 
 
-def get(endpoint: str, params: dict | None = None) -> requests.models.Response | _ErrorResponse:
+def get(
+    endpoint: str, params: dict | None = None, headers: dict | None = None
+) -> requests.models.Response | _ErrorResponse:
     """
     GETs a request to a ProxyML API endpoint.
 
     Args:
         endpoint (str): ProxyML API endpoint.  PROXYML_BASE_URL is prepended e.g. use endpoint='/schemas' not 'https://api.proxyml.ai/api/v1/schemas'.
         params (dict): query parameters.
+        headers (dict): overrides the default X-API-KEY auth headers, e.g. with _ci_headers().
 
     Returns:
         requests Response object.
@@ -108,7 +133,7 @@ def get(endpoint: str, params: dict | None = None) -> requests.models.Response |
     try:
         return requests.get(
             url=f'{_base_url()}{endpoint}',
-            headers=_headers(),
+            headers=headers if headers is not None else _headers(),
             params=params,
             timeout=_TIMEOUT,
         )
@@ -850,3 +875,54 @@ def delete_model(model_id: str) -> bool:
         r.text,
     )
     return False
+
+
+def upload_challenger(payload: dict, *, ci_token: str | None = None) -> dict | None:
+    """
+    Uploads a challenger comparison from a headless environment, e.g. a CI job.
+
+    Authenticated with a project-scoped CI token rather than PROXYML_API_KEY
+    — mint one from the ProxyML dashboard for the specific project this
+    challenger belongs to, since (unlike the account-wide API key) it only
+    ever authorizes writes to that one project. Set PROXYML_CI_TOKEN or pass
+    ci_token= explicitly.
+
+    Args:
+        payload (dict): output of proxyml.local.to_challenger_upload().
+        ci_token (str): overrides PROXYML_CI_TOKEN if provided.
+
+    Returns:
+        JSON object with the new challenger_version, or None if an error occurred.
+    """
+    r = post(endpoint='/ci/challenger', payload=payload, headers=_ci_headers(ci_token))
+    if r.status_code == 202:
+        return r.json()
+    logger.error(
+        "Challenger upload failed with status %s: %s",
+        r.status_code,
+        r.text,
+    )
+    return None
+
+
+def get_challenger_summary(*, ci_token: str | None = None) -> dict | None:
+    """
+    Fetches a CI-ready summary of the latest challenger comparison for the
+    project authorized by the given CI token: which model won, the primary
+    metric and its delta, and a ready-to-post markdown snippet.
+
+    Set PROXYML_CI_TOKEN or pass ci_token= explicitly.
+
+    Returns:
+        JSON object, or None if an error occurred (e.g. no challenger has
+        been uploaded to this project yet).
+    """
+    r = get(endpoint='/ci/challenger/summary', headers=_ci_headers(ci_token))
+    if r.status_code == 200:
+        return r.json()
+    logger.error(
+        "Fetching challenger summary failed with status %s: %s",
+        r.status_code,
+        r.text,
+    )
+    return None

{proxyml-0.9.0 → proxyml-0.10.0}/src/proxyml/local/challenger.py

@@ -193,6 +193,18 @@ def train_challenger(
     are dropped from both sides — champion and challenger are always
     evaluated on the same labeled population, never on different ones.
 
+    Note that ``target_fingerprint`` (on the result) is computed from
+    ``target`` exactly as passed in — NaNs and all — *before* this drop
+    happens, not from the labeled subset actually used for training/scoring.
+    That's transparent if you use ``champion_predictions`` above, since it's
+    matched against the same pre-drop array internally. But if you're
+    pairing this result with a champion scored separately (``score_champion()``
+    + ``champion_labels=`` on ``to_challenger_upload()``), you must pass that
+    same original, uncleaned ``target`` array as ``champion_labels`` — not a
+    version you've already run ``dropna()`` on yourself — or the two
+    fingerprints won't match even though the actually-scored population is
+    identical.
+
     Args:
         df: samples to train on, one column per schema feature.
         target: the value to predict for each row of ``df`` — ground-truth

{proxyml-0.9.0 → proxyml-0.10.0}/src/proxyml.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: proxyml
-Version: 0.9.0
+Version: 0.10.0
 Summary: Python SDK for calling the ProxyML API
 Author-email: ProxyML <contact@proxyml.ai>
 License:                                  Apache License
@@ -333,6 +333,9 @@ See [`docs/quickstart.md`](docs/quickstart.md) for a full walkthrough and [`docs
 | `interpret_counterfactual(sample, counterfactual, ...)` | Generate a human-readable explanation |
 | `proxyml.local.train_challenger(df, target, schema, ...)` | Train a challenger model locally — no API round-trip (`pip install 'proxyml[local]'`) |
 | `proxyml.local.train_auto_challenger(data, target_col, ...)` | Load data + train a local challenger in one call |
+| `upload_challenger(payload, ci_token=None)` | Upload a challenger comparison headlessly, e.g. from CI (`PROXYML_CI_TOKEN`, not `PROXYML_API_KEY`) |
+| `get_challenger_summary(ci_token=None)` | Fetch a CI-ready summary of the latest challenger comparison |
+| `proxyml.ci.post_challenger_comment(...)` | Post/update a sticky PR comment with the challenger comparison |
 
 Full documentation: [`docs/api.md`](docs/api.md)
 
@@ -344,6 +347,7 @@ Full documentation: [`docs/api.md`](docs/api.md)
 - [`examples/multiclass_example.py`](examples/multiclass_example.py) — Multi-class classification with per-class feature importances
 - [`examples/testing_example.py`](examples/testing_example.py) — Using a surrogate as a reference model in CI
 - [`examples/surrogate_export_example.py`](examples/surrogate_export_example.py) — Exporting a surrogate and reproducing its predictions locally
+- [`examples/ci_challenger_example.py`](examples/ci_challenger_example.py) + [`examples/github_actions_challenger.yml`](examples/github_actions_challenger.yml) — Training a challenger and posting the comparison as a PR comment from CI
 
 ## License
 

{proxyml-0.9.0 → proxyml-0.10.0}/src/proxyml.egg-info/SOURCES.txt

@@ -2,6 +2,7 @@ LICENSE
 README.md
 pyproject.toml
 src/proxyml/__init__.py
+src/proxyml/ci.py
 src/proxyml/client.py
 src/proxyml/schema_builder.py
 src/proxyml.egg-info/PKG-INFO
@@ -11,6 +12,7 @@ src/proxyml.egg-info/requires.txt
 src/proxyml.egg-info/top_level.txt
 src/proxyml/local/__init__.py
 src/proxyml/local/challenger.py
+tests/test_ci.py
 tests/test_client.py
 tests/test_dependency_boundaries.py
 tests/test_local_challenger.py

proxyml-0.10.0/tests/test_ci.py

@@ -0,0 +1,133 @@
+import json
+from unittest.mock import MagicMock, patch
+
+import pytest
+import requests
+
+from proxyml.ci import (
+    _COMMENT_MARKER,
+    _resolve_github_token,
+    _resolve_pr_number,
+    _resolve_repo,
+    post_challenger_comment,
+)
+
+
+def _mock_response(status_code, json_body):
+    r = MagicMock()
+    r.status_code = status_code
+    r.json.return_value = json_body
+    r.raise_for_status = MagicMock()
+    if status_code >= 400:
+        r.raise_for_status.side_effect = requests.exceptions.HTTPError(f"{status_code} error")
+    return r
+
+
+# ---------------------------------------------------------------------------
+# env resolution
+# ---------------------------------------------------------------------------
+
+def test_resolve_github_token_raises_when_missing(monkeypatch):
+    monkeypatch.delenv("GITHUB_TOKEN", raising=False)
+    with pytest.raises(EnvironmentError, match="GITHUB_TOKEN"):
+        _resolve_github_token(None)
+
+
+def test_resolve_github_token_explicit_overrides_env(monkeypatch):
+    monkeypatch.setenv("GITHUB_TOKEN", "env-token")
+    assert _resolve_github_token("explicit-token") == "explicit-token"
+
+
+def test_resolve_repo_raises_when_missing(monkeypatch):
+    monkeypatch.delenv("GITHUB_REPOSITORY", raising=False)
+    with pytest.raises(EnvironmentError, match="GITHUB_REPOSITORY"):
+        _resolve_repo(None)
+
+
+def test_resolve_repo_reads_env(monkeypatch):
+    monkeypatch.setenv("GITHUB_REPOSITORY", "acme/widgets")
+    assert _resolve_repo(None) == "acme/widgets"
+
+
+def test_resolve_pr_number_explicit_skips_event_file(monkeypatch):
+    monkeypatch.delenv("GITHUB_EVENT_PATH", raising=False)
+    assert _resolve_pr_number(42) == 42
+
+
+def test_resolve_pr_number_raises_without_event_path(monkeypatch):
+    monkeypatch.delenv("GITHUB_EVENT_PATH", raising=False)
+    with pytest.raises(EnvironmentError, match="GITHUB_EVENT_PATH"):
+        _resolve_pr_number(None)
+
+
+def test_resolve_pr_number_reads_pull_request_event(tmp_path, monkeypatch):
+    event_path = tmp_path / "event.json"
+    event_path.write_text(json.dumps({"pull_request": {"number": 17}}))
+    monkeypatch.setenv("GITHUB_EVENT_PATH", str(event_path))
+    assert _resolve_pr_number(None) == 17
+
+
+def test_resolve_pr_number_raises_on_non_pr_event(tmp_path, monkeypatch):
+    event_path = tmp_path / "event.json"
+    event_path.write_text(json.dumps({"ref": "refs/heads/main"}))
+    monkeypatch.setenv("GITHUB_EVENT_PATH", str(event_path))
+    with pytest.raises(ValueError, match="pull request number"):
+        _resolve_pr_number(None)
+
+
+# ---------------------------------------------------------------------------
+# post_challenger_comment
+# ---------------------------------------------------------------------------
+
+@patch("proxyml.ci.get_challenger_summary")
+def test_post_challenger_comment_returns_none_without_summary(mock_summary):
+    mock_summary.return_value = None
+    assert post_challenger_comment(github_token="t", repo="acme/widgets", pr_number=1) is None
+
+
+@patch("proxyml.ci.requests.post")
+@patch("proxyml.ci.requests.get")
+@patch("proxyml.ci.get_challenger_summary")
+def test_post_challenger_comment_creates_new_comment_when_none_exists(mock_summary, mock_get, mock_post):
+    mock_summary.return_value = {"markdown_summary": "**ProxyML challenger beats champion** by 0.19 r2"}
+    mock_get.return_value = _mock_response(200, [])  # no existing comments
+    mock_post.return_value = _mock_response(201, {"id": 99, "body": "posted"})
+
+    result = post_challenger_comment(github_token="gh-token", repo="acme/widgets", pr_number=7)
+
+    assert result == {"id": 99, "body": "posted"}
+    mock_post.assert_called_once()
+    url = mock_post.call_args.args[0]
+    assert url == "https://api.github.com/repos/acme/widgets/issues/7/comments"
+    body = mock_post.call_args.kwargs["json"]["body"]
+    assert _COMMENT_MARKER in body
+    assert "0.19 r2" in body
+
+
+@patch("proxyml.ci.requests.patch")
+@patch("proxyml.ci.requests.get")
+@patch("proxyml.ci.get_challenger_summary")
+def test_post_challenger_comment_updates_existing_sticky_comment(mock_summary, mock_get, mock_patch):
+    mock_summary.return_value = {"markdown_summary": "updated result"}
+    mock_get.return_value = _mock_response(
+        200, [{"id": 55, "body": f"{_COMMENT_MARKER}\nold result"}, {"id": 56, "body": "unrelated comment"}],
+    )
+    mock_patch.return_value = _mock_response(200, {"id": 55, "body": "updated"})
+
+    result = post_challenger_comment(github_token="gh-token", repo="acme/widgets", pr_number=7)
+
+    assert result == {"id": 55, "body": "updated"}
+    mock_patch.assert_called_once()
+    url = mock_patch.call_args.args[0]
+    assert url == "https://api.github.com/repos/acme/widgets/issues/comments/55"
+
+
+@patch("proxyml.ci.requests.post")
+@patch("proxyml.ci.requests.get")
+@patch("proxyml.ci.get_challenger_summary")
+def test_post_challenger_comment_returns_none_on_github_error(mock_summary, mock_get, mock_post):
+    mock_summary.return_value = {"markdown_summary": "result"}
+    mock_get.return_value = _mock_response(200, [])
+    mock_post.return_value = _mock_response(403, {"message": "forbidden"})
+
+    assert post_challenger_comment(github_token="gh-token", repo="acme/widgets", pr_number=7) is None

{proxyml-0.9.0 → proxyml-0.10.0}/tests/test_client.py

@@ -11,7 +11,9 @@ from proxyml_core.schema import FeatureSchema
 from proxyml.client import (
     _cast_column,
     _base_url,
+    _ci_headers,
     _headers,
+    get_challenger_summary,
     health_check,
     delete_model,
     delete_schema,
@@ -37,6 +39,7 @@ from proxyml.client import (
     train_surrogate,
     train_auto_surrogate,
     update_model,
+    upload_challenger,
 )
 
 
@@ -1033,3 +1036,78 @@ def test_update_model_no_fields_raises():
 def test_update_model_failure_returns_none(mock_patch):
     mock_patch.return_value = _mock_response(404, {"detail": "not found"})
     assert update_model("abc-123", name="x") is None
+
+
+# ---------------------------------------------------------------------------
+# _ci_headers
+# ---------------------------------------------------------------------------
+
+def test_ci_headers_raises_without_token(monkeypatch):
+    monkeypatch.delenv("PROXYML_CI_TOKEN", raising=False)
+    with pytest.raises(EnvironmentError, match="PROXYML_CI_TOKEN"):
+        _ci_headers()
+
+
+def test_ci_headers_reads_env(monkeypatch):
+    monkeypatch.setenv("PROXYML_CI_TOKEN", "test-ci-token")
+    h = _ci_headers()
+    assert h["X-CI-TOKEN"] == "test-ci-token"
+    assert h["Content-Type"] == "application/json"
+
+
+def test_ci_headers_explicit_token_overrides_env(monkeypatch):
+    monkeypatch.setenv("PROXYML_CI_TOKEN", "env-token")
+    h = _ci_headers(ci_token="explicit-token")
+    assert h["X-CI-TOKEN"] == "explicit-token"
+
+
+# ---------------------------------------------------------------------------
+# upload_challenger / get_challenger_summary
+# ---------------------------------------------------------------------------
+
+@patch("proxyml.client.post")
+def test_upload_challenger_success(mock_post, monkeypatch):
+    monkeypatch.setenv("PROXYML_CI_TOKEN", "test-ci-token")
+    mock_post.return_value = _mock_response(202, {"status": "ok", "challenger_version": "v1", "task": "regression"})
+    payload = {"export": {}, "challenger_metrics": {"r2": 0.9}, "champion_metrics": {"r2": 0.8}}
+
+    result = upload_challenger(payload)
+
+    assert result == {"status": "ok", "challenger_version": "v1", "task": "regression"}
+    mock_post.assert_called_once_with(
+        endpoint="/ci/challenger", payload=payload, headers={"Content-Type": "application/json", "X-CI-TOKEN": "test-ci-token"},
+    )
+
+
+@patch("proxyml.client.post")
+def test_upload_challenger_failure_returns_none(mock_post, monkeypatch):
+    monkeypatch.setenv("PROXYML_CI_TOKEN", "test-ci-token")
+    mock_post.return_value = _mock_response(401, {"detail": "invalid token"})
+    assert upload_challenger({}) is None
+
+
+def test_upload_challenger_raises_without_ci_token(monkeypatch):
+    monkeypatch.delenv("PROXYML_CI_TOKEN", raising=False)
+    with pytest.raises(EnvironmentError, match="PROXYML_CI_TOKEN"):
+        upload_challenger({})
+
+
+@patch("proxyml.client.get")
+def test_get_challenger_summary_success(mock_get, monkeypatch):
+    monkeypatch.setenv("PROXYML_CI_TOKEN", "test-ci-token")
+    summary = {"winner": "challenger", "primary_metric": "r2", "markdown_summary": "**ProxyML challenger beats champion**"}
+    mock_get.return_value = _mock_response(200, summary)
+
+    result = get_challenger_summary()
+
+    assert result == summary
+    mock_get.assert_called_once_with(
+        endpoint="/ci/challenger/summary", headers={"Content-Type": "application/json", "X-CI-TOKEN": "test-ci-token"},
+    )
+
+
+@patch("proxyml.client.get")
+def test_get_challenger_summary_failure_returns_none(mock_get, monkeypatch):
+    monkeypatch.setenv("PROXYML_CI_TOKEN", "test-ci-token")
+    mock_get.return_value = _mock_response(404, {"detail": "no challenger uploaded"})
+    assert get_challenger_summary() is None