proxyml 0.1.3__tar.gz → 0.1.5__tar.gz

{proxyml-0.1.3 → proxyml-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: proxyml
-Version: 0.1.3
+Version: 0.1.5
 Summary: Python SDK for calling the ProxyML API
 Author-email: ProxyML <contact@proxyml.ai>
 License:                                  Apache License

{proxyml-0.1.3 → proxyml-0.1.5}/pyproject.toml

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

{proxyml-0.1.3 → proxyml-0.1.5}/src/proxyml/__init__.py

@@ -1,5 +1,8 @@
 from proxyml.client import (
     put_schema,
+    fetch_schema,
+    list_schemas,
+    delete_schema,
     synthesize_data,
     train_surrogate,
     predict,
@@ -12,6 +15,8 @@ from proxyml.client import (
     diff_models,
     list_models,
     delete_model,
+    get_usage,
+    rotate_key,
 )
 from proxyml.schema import (
     get_schema,
@@ -22,6 +27,9 @@ from proxyml.schema import (
 
 __all__ = [
     "put_schema",
+    "fetch_schema",
+    "list_schemas",
+    "delete_schema",
     "synthesize_data",
     "train_surrogate",
     "predict",
@@ -34,6 +42,8 @@ __all__ = [
     "diff_models",
     "list_models",
     "delete_model",
+    "get_usage",
+    "rotate_key",
     "get_schema",
     "gen_continuous_schema",
     "gen_categorical_schema",

{proxyml-0.1.3 → proxyml-0.1.5}/src/proxyml/client.py

@@ -61,10 +61,10 @@ def delete(endpoint: str) -> requests.models.Response:
     return r
 
 
-def put_schema(schema: dict):
-    r = put(endpoint='/schema', payload=schema)
+def put_schema(schema: dict, name: str = "default"):
+    r = put(endpoint=f'/schema/{name}', payload=schema)
     if r.status_code == 200:
-        logger.info("Schema uploaded successfully")
+        logger.info("Schema '%s' uploaded successfully", name)
         return r.json()
     logger.error(
         "Schema upload failed with status %s: %s",
@@ -74,6 +74,48 @@ def put_schema(schema: dict):
     return None
 
 
+def fetch_schema(name: str = "default") -> dict | None:
+    """Retrieve a stored feature schema by name."""
+    r = get(endpoint=f'/schema/{name}', params={})
+    if r.status_code == 200:
+        return r.json()
+    logger.error(
+        "Fetch schema failed with status %s: %s",
+        r.status_code,
+        r.text,
+    )
+    return None
+
+
+def list_schemas() -> list[dict] | None:
+    """Return all named schemas for the authenticated user."""
+    r = get(endpoint='/schemas', params={})
+    if r.status_code == 200:
+        return r.json()['schemas']
+    logger.error(
+        "List schemas failed with status %s: %s",
+        r.status_code,
+        r.text,
+    )
+    return None
+
+
+def delete_schema(name: str) -> bool:
+    """Delete a named schema. Returns True on success, False if not found."""
+    r = delete(endpoint=f'/schema/{name}')
+    if r.status_code == 204:
+        return True
+    if r.status_code == 404:
+        logger.warning("Schema '%s' not found", name)
+        return False
+    logger.error(
+        "Delete schema failed with status %s: %s",
+        r.status_code,
+        r.text,
+    )
+    return False
+
+
 def _cast_column(series: pd.Series, ftype: str) -> pd.Series:
     if ftype in ("continuous",):
         return series.astype(float)
@@ -87,11 +129,11 @@ def _cast_column(series: pd.Series, ftype: str) -> pd.Series:
     return series
 
 
-def synthesize_data(num_points: int = 100, sample: list | None = None, as_df: bool = True):
+def synthesize_data(num_points: int = 100, sample: list | None = None, as_df: bool = True, schema_name: str = "default"):
     if sample is None:
-        r = post(endpoint='/synthesize/neighbors', payload={'n': num_points})
+        r = post(endpoint='/synthesize/neighbors', payload={'n': num_points, 'schema_name': schema_name})
     else:
-        r = post(endpoint='/synthesize/blended', payload={'n': num_points, 'instance': [col.item() for col in sample]})
+        r = post(endpoint='/synthesize/blended', payload={'n': num_points, 'instance': [col.item() for col in sample], 'schema_name': schema_name})
     if r.status_code == 200:
         payload = r.json()
         if as_df:
@@ -114,6 +156,7 @@ def train_surrogate(
         feature_names: list[str] | None,
         task: str = 'auto',
         test_size: float = 0.2,
+        schema_name: str = "default",
         name: str | None = None,
         comments: str | None = None,
     ):
@@ -123,6 +166,7 @@ def train_surrogate(
         'feature_names': feature_names,
         'task': task,
         'test_size': test_size,
+        'schema_name': schema_name,
     }
     if name is not None:
         payload['name'] = name
@@ -316,6 +360,32 @@ def get_feature_importances(version: str | None = None):
     return None
 
 
+def get_usage() -> dict | None:
+    """Return current tier, usage counts, and quota for the authenticated user."""
+    r = get(endpoint='/account/usage', params={})
+    if r.status_code == 200:
+        return r.json()
+    logger.error(
+        "Get usage failed with status %s: %s",
+        r.status_code,
+        r.text,
+    )
+    return None
+
+
+def rotate_key() -> str | None:
+    """Rotate the API key, revoking all old keys. Returns the new key string or None on failure."""
+    r = post(endpoint='/account/keys/rotate', payload={})
+    if r.status_code == 201:
+        return r.json()['api_key']
+    logger.error(
+        "Key rotation failed with status %s: %s",
+        r.status_code,
+        r.text,
+    )
+    return None
+
+
 def list_models() -> list[dict] | None:
     """Return metadata for all trained surrogate models, newest first."""
     r = get(endpoint='/surrogate/models', params={})

{proxyml-0.1.3 → proxyml-0.1.5}/src/proxyml.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: proxyml
-Version: 0.1.3
+Version: 0.1.5
 Summary: Python SDK for calling the ProxyML API
 Author-email: ProxyML <contact@proxyml.ai>
 License:                                  Apache License

{proxyml-0.1.3 → proxyml-0.1.5}/tests/test_client.py

@@ -8,14 +8,19 @@ from proxyml.client import (
     _cast_column,
     _headers,
     delete_model,
+    delete_schema,
     diff_models,
+    fetch_schema,
     find_counterfactuals,
     get_model_summary,
+    get_usage,
     interpret_counterfactual,
     list_models,
+    list_schemas,
     predict,
     predict_batch,
     put_schema,
+    rotate_key,
     synthesize_data,
     train_surrogate,
 )
@@ -139,11 +144,18 @@ def _mock_response(status_code, json_body):
 
 
 @patch("proxyml.client.put")
-def test_put_schema_success(mock_put):
-    mock_put.return_value = _mock_response(200, {"status": "ok"})
+def test_put_schema_default(mock_put):
+    mock_put.return_value = _mock_response(200, {"features": []})
     result = put_schema({"features": []})
-    assert result == {"status": "ok"}
-    mock_put.assert_called_once_with(endpoint="/schema", payload={"features": []})
+    assert result == {"features": []}
+    mock_put.assert_called_once_with(endpoint="/schema/default", payload={"features": []})
+
+
+@patch("proxyml.client.put")
+def test_put_schema_named(mock_put):
+    mock_put.return_value = _mock_response(200, {"features": []})
+    put_schema({"features": []}, name="credit")
+    mock_put.assert_called_once_with(endpoint="/schema/credit", payload={"features": []})
 
 
 @patch("proxyml.client.put")
@@ -153,6 +165,60 @@ def test_put_schema_failure(mock_put):
     assert result is None
 
 
+# ---------------------------------------------------------------------------
+# fetch_schema / list_schemas / delete_schema
+# ---------------------------------------------------------------------------
+
+@patch("proxyml.client.get")
+def test_fetch_schema_default(mock_get):
+    mock_get.return_value = _mock_response(200, {"features": [{"type": "continuous", "name": "age"}]})
+    result = fetch_schema()
+    assert result["features"][0]["name"] == "age"
+    mock_get.assert_called_once_with(endpoint="/schema/default", params={})
+
+
+@patch("proxyml.client.get")
+def test_fetch_schema_named(mock_get):
+    mock_get.return_value = _mock_response(200, {"features": []})
+    fetch_schema(name="credit")
+    mock_get.assert_called_once_with(endpoint="/schema/credit", params={})
+
+
+@patch("proxyml.client.get")
+def test_fetch_schema_not_found_returns_none(mock_get):
+    mock_get.return_value = _mock_response(404, {"detail": "not found"})
+    assert fetch_schema("missing") is None
+
+
+@patch("proxyml.client.get")
+def test_list_schemas_success(mock_get):
+    schemas = [{"name": "default", "updated_at": "2026-04-22T10:00:00"},
+               {"name": "credit", "updated_at": "2026-04-22T11:00:00"}]
+    mock_get.return_value = _mock_response(200, {"schemas": schemas})
+    result = list_schemas()
+    assert result == schemas
+    mock_get.assert_called_once_with(endpoint="/schemas", params={})
+
+
+@patch("proxyml.client.get")
+def test_list_schemas_failure_returns_none(mock_get):
+    mock_get.return_value = _mock_response(401, {"detail": "unauthorized"})
+    assert list_schemas() is None
+
+
+@patch("proxyml.client.delete")
+def test_delete_schema_success(mock_del):
+    mock_del.return_value = _mock_response(204, None)
+    assert delete_schema("credit") is True
+    mock_del.assert_called_once_with(endpoint="/schema/credit")
+
+
+@patch("proxyml.client.delete")
+def test_delete_schema_not_found(mock_del):
+    mock_del.return_value = _mock_response(404, {"detail": "not found"})
+    assert delete_schema("no-such-schema") is False
+
+
 @patch("proxyml.client.post")
 def test_predict_success(mock_post):
     mock_post.return_value = _mock_response(200, {"prediction": 1, "probability": 0.9})
@@ -189,9 +255,19 @@ def test_synthesize_data_no_sample(mock_post):
     df = synthesize_data(num_points=2, sample=None)
     assert isinstance(df, pd.DataFrame)
     assert list(df.columns) == ["f_cont", "f_cat"]
-    mock_post.assert_called_once_with(
-        endpoint="/synthesize/neighbors", payload={"n": 2}
-    )
+    payload = mock_post.call_args.kwargs["payload"]
+    assert payload["n"] == 2
+    assert payload["schema_name"] == "default"
+
+
+@patch("proxyml.client.post")
+def test_synthesize_data_named_schema(mock_post):
+    mock_post.return_value = _mock_response(200, {
+        "samples": [[1.0]], "feature_names": ["x"], "feature_types": ["continuous"],
+    })
+    synthesize_data(num_points=1, schema_name="credit")
+    payload = mock_post.call_args.kwargs["payload"]
+    assert payload["schema_name"] == "credit"
 
 
 @patch("proxyml.client.post")
@@ -215,10 +291,19 @@ def test_train_surrogate_with_metadata(mock_post):
     payload = mock_post.call_args.kwargs["payload"]
     assert payload["name"] == "v1"
     assert payload["comments"] == "test run"
+    assert payload["schema_name"] == "default"
     assert result["version"] == "abc-123"
     assert result["trained_at"] == "2026-04-19T12:00:00"
 
 
+@patch("proxyml.client.post")
+def test_train_surrogate_named_schema(mock_post):
+    mock_post.return_value = _mock_response(200, {"version": "abc-123"})
+    train_surrogate(samples=[[1.0]], predictions=[1.0], feature_names=None, schema_name="credit")
+    payload = mock_post.call_args.kwargs["payload"]
+    assert payload["schema_name"] == "credit"
+
+
 @patch("proxyml.client.post")
 def test_train_surrogate_omits_none_metadata(mock_post):
     mock_post.return_value = _mock_response(200, {"version": "abc-123"})
@@ -420,3 +505,50 @@ def test_diff_models_success(mock_get):
 def test_diff_models_failure_returns_none(mock_get):
     mock_get.return_value = _mock_response(422, {"detail": "different tasks"})
     assert diff_models(version_a="aaa-111", version_b="bbb-222") is None
+
+
+# ---------------------------------------------------------------------------
+# get_usage
+# ---------------------------------------------------------------------------
+
+_USAGE_RESPONSE = {
+    "tier": "hobbyist",
+    "period": "2026-04",
+    "calls_this_period": 42,
+    "calls_limit": 1000,
+    "calls_remaining": 958,
+    "surrogates_trained": 2,
+    "surrogate_limit": 3,
+}
+
+
+@patch("proxyml.client.get")
+def test_get_usage_success(mock_get):
+    mock_get.return_value = _mock_response(200, _USAGE_RESPONSE)
+    result = get_usage()
+    assert result == _USAGE_RESPONSE
+    mock_get.assert_called_once_with(endpoint="/account/usage", params={})
+
+
+@patch("proxyml.client.get")
+def test_get_usage_failure_returns_none(mock_get):
+    mock_get.return_value = _mock_response(401, {"detail": "unauthorized"})
+    assert get_usage() is None
+
+
+# ---------------------------------------------------------------------------
+# rotate_key
+# ---------------------------------------------------------------------------
+
+@patch("proxyml.client.post")
+def test_rotate_key_success(mock_post):
+    mock_post.return_value = _mock_response(201, {"api_key": "proxyml_new_secret_key"})
+    result = rotate_key()
+    assert result == "proxyml_new_secret_key"
+    mock_post.assert_called_once_with(endpoint="/account/keys/rotate", payload={})
+
+
+@patch("proxyml.client.post")
+def test_rotate_key_failure_returns_none(mock_post):
+    mock_post.return_value = _mock_response(403, {"detail": "Key rotation is not available for test accounts"})
+    assert rotate_key() is None