Warn that Client usage is deprecated (#165)

jparise · Apr 9, 2024 · c3339b0 · c3339b0
1 parent 89f3a2f
commit c3339b0
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/src/vesta/clients.py b/src/vesta/clients.py
@@ -21,6 +21,7 @@
 from __future__ import annotations
 
 import json
+import warnings
 from typing import Any
 from typing import Dict
 from typing import List
@@ -60,6 +61,12 @@ def __init__(
         base_url: str = "https://platform.vestaboard.com",
         headers: Optional[Mapping[str, str]] = None,
     ):
+        warnings.warn(
+            "Vestaboard has deprecated the Platform API (Client). "
+            "Consider using the Subscription API (SubscrptionClient) instead.",
+            DeprecationWarning,
+        )
+
         self.http = http_client or httpx.Client()
         self.http.base_url = httpx.URL(base_url)
         self.http.headers["X-Vestaboard-Api-Key"] = api_key

diff --git a/tests/test_clients.py b/tests/test_clients.py
@@ -43,6 +43,7 @@ def vbml_client():
     return VBMLClient()
 
 
+@pytest.mark.filterwarnings("ignore:Vestaboard has deprecated the Platform API")
 class TestClient:
     def test_base_url(self):
         base_url = "https://www.example.com"