rowan-python 3.1.10__py3-none-any.whl → 3.1.11__py3-none-any.whl

rowan/api_keys.py

@@ -21,6 +21,8 @@ class APIKey(BaseModel):
     :ivar is_revoked: Whether the key has been revoked.
     :ivar scope: Permission scope ("read", "read_write", or "read_write_delete").
     :ivar can_manage_api_keys: Whether this key can create/list/revoke other API keys.
+    :ivar budget: Maximum credits this key may spend. ``None`` means unlimited.
+    :ivar credits_used: Credits spent by this key so far.
     :ivar scoped_project_uuid: If set, the key can only access this project.
     :ivar created_by_key_uuid: UUID of the API key used to create this one (if any).
     :ivar revoked_at: When the key was revoked, if applicable.
@@ -35,6 +37,8 @@ class APIKey(BaseModel):
     is_revoked: bool
     scope: str
     can_manage_api_keys: bool
+    budget: float | None = None
+    credits_used: float = 0
     scoped_project_uuid: str | None = None
     created_by_key_uuid: str | None = None
     revoked_at: datetime | None = None
@@ -57,6 +61,27 @@ class APIKey(BaseModel):
             response.raise_for_status()
             return type(self)(**response.json())
 
+    def refresh(self, in_place: bool = True) -> Self:
+        """
+        Reload this key's metadata (e.g. ``credits_used``) from the server.
+
+        :param in_place: If True, update this instance in-place. If False, return new instance.
+        :returns: Updated APIKey object.
+        :raises ValueError: If this key is no longer present in the account's key list.
+        """
+        matches = [key for key in list_api_keys(active=None) if key.uuid == self.uuid]
+        if not matches:
+            raise ValueError(f"API key {self.uuid!r} not found.")
+        updated = matches[0]
+
+        if not in_place:
+            return type(self)(**updated.model_dump())
+
+        for field_name in type(self).model_fields:
+            setattr(self, field_name, getattr(updated, field_name))
+
+        return self
+
 
 class CreatedAPIKey(BaseModel):
     """
@@ -78,6 +103,7 @@ def create_api_key(
     scope: APIKeyScope = "read_write",
     valid_days: int = 365,
     scoped_project_uuid: str | None = None,
+    budget: float | None = None,
 ) -> CreatedAPIKey:
     """
     Create a new API key.
@@ -89,6 +115,8 @@ def create_api_key(
     :param scope: Permission scope. One of "read", "read_write", "read_write_delete".
     :param valid_days: Number of days until the key expires.
     :param scoped_project_uuid: If provided, restrict the key to a single project.
+    :param budget: Maximum credits the key may spend. If not provided, the key has no
+        spending limit.
     :returns: plaintext key together with its metadata; the plaintext key is
         only returned once — store it immediately.
     """
@@ -99,6 +127,7 @@ def create_api_key(
         "scope": scope,
         "valid_days": valid_days,
         "scoped_project_uuid": scoped_project_uuid,
+        "budget": budget,
     }
     with api_client() as client:
         response = client.post("/api_key", json=payload)
@@ -142,3 +171,28 @@ def revoke_api_key(uuid: str) -> APIKey:
         response = client.post(f"/api_key/{uuid}/revoke")
         response.raise_for_status()
         return APIKey(**response.json())
+
+
+def update_api_key_budget(uuid: str, budget: float | None) -> APIKey:
+    """
+    Update the spending budget of an API key.
+
+    The caller must currently authenticate with an unscoped key that has
+    ``can_manage_api_keys`` permission.
+
+    :param uuid: UUID of the key to update.
+    :param budget: New maximum credits the key may spend. Pass ``None`` to remove
+        the spending limit.
+    :returns: Updated APIKey object.
+    """
+    with api_client() as client:
+        response = client.patch(f"/api_key/{uuid}", json={"budget": budget})
+        if response.status_code == 403:
+            raise PermissionError(
+                "API key update rejected by the server (403). The key you are "
+                "authenticating with must be unscoped and have `can_manage_api_keys` "
+                "permission. Create a manager key from the Rowan web UI "
+                "(Account → API keys) and retry with that key."
+            )
+        response.raise_for_status()
+        return APIKey(**response.json())

{rowan_python-3.1.10.dist-info → rowan_python-3.1.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rowan-python
-Version: 3.1.10
+Version: 3.1.11
 Summary: Rowan Python Library
 Project-URL: Homepage, https://github.com/rowansci/rowan-client
 Project-URL: Bug Tracker, https://github.com/rowansci/rowan-client/issues

{rowan_python-3.1.10.dist-info → rowan_python-3.1.11.dist-info}/RECORD

@@ -1,5 +1,5 @@
 rowan/__init__.py,sha256=MhgIDJjrk8M_O9NtBL9I2_e5iTHCcc7Ju3XbBi2wtUA,1788
-rowan/api_keys.py,sha256=TvG5l5MmQ3Qt8Z3Y7jCA_lcrwEHuI7xHy-KLbIdQ8_A,4793
+rowan/api_keys.py,sha256=Sv-CYivYUxf32u2TAculXuni422mB3jmHtTxm2cDRRA,6991
 rowan/calculation.py,sha256=nuUtLTtn9D-FCM9TJl3h5euBgIYqa5fr5r_PSNBS7Xo,3809
 rowan/config.py,sha256=TejQKSxnzNKKTNL9-2bCLq6RvAh54oVA5Ivl1p_ZT8Q,20899
 rowan/constants.py,sha256=emCH4m9OL2Hm5E-6mJGM_FgzrK_JrZT-FiKJ6pMNQ4Y,84
@@ -53,7 +53,7 @@ rowan/workflows/solvent_dependent_conformers.py,sha256=Z2xESmcM8WcTsR2TSTUa--Rrh
 rowan/workflows/spin_states.py,sha256=rjkgie2-XVNIN7O6P93yn6EPv9Ogjy8iTj3ufZIsUgY,9331
 rowan/workflows/strain.py,sha256=kCW_BlX__sdQG1JVbFZuB-57rkpnxa_JCw3h4uKdGDk,6425
 rowan/workflows/tautomer_search.py,sha256=mbRl0ZJ7wibueRF8c8_idhXJ1rtwg7LBt--5QwQ_Cck,5767
-rowan_python-3.1.10.dist-info/METADATA,sha256=SUJMfB1vlLJiInjerGxUBYjzS7eFXHlaKP5_ma5ctBs,2446
-rowan_python-3.1.10.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
-rowan_python-3.1.10.dist-info/licenses/LICENSE,sha256=i05z7xEhyrg6f8j0lR3XYjShnF-MJGFQ-DnpsZ8yiVI,1084
-rowan_python-3.1.10.dist-info/RECORD,,
+rowan_python-3.1.11.dist-info/METADATA,sha256=pmlTh_uskn9-91pN4XYHT4irvEF2MVo7bBhiumUPZaY,2446
+rowan_python-3.1.11.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+rowan_python-3.1.11.dist-info/licenses/LICENSE,sha256=i05z7xEhyrg6f8j0lR3XYjShnF-MJGFQ-DnpsZ8yiVI,1084
+rowan_python-3.1.11.dist-info/RECORD,,