Rename Base -> Collection

examples/base/basic_usage.py → examples/collections/basic_usage.py

@@ -1,8 +1,8 @@
 # ruff: noqa: T201
-from contiguity import Base
+from contiguity import Collection
 
-# Create a Base instance.
-db = Base("my-base")
+# Create a Collection instance.
+db = Collection("my-collection")
 
 # Put an item with a specific key.
 put_result = db.put({"key": "foo", "value": "Hello world!"})

examples/base/pydantic_usage.py → examples/collections/pydantic_usage.py

@@ -1,7 +1,7 @@
 # ruff: noqa: T201
 from pydantic import BaseModel
 
-from contiguity import Base
+from contiguity import Collection
 
 
 # Create a Pydantic model for the item.
@@ -12,9 +12,9 @@ class MyItem(BaseModel):
     interests: list[str] = []
 
 
-# Create a Base instance.
+# Create a Collection instance.
 # Static type checking will work with the Pydantic model.
-db = Base("members", item_type=MyItem)
+db = Collection("members", item_type=MyItem)
 
 # Put an item with a specific key.
 put_result = db.put(

src/contiguity/__init__.py

@@ -1,6 +1,15 @@
 from ._client import ApiClient
 from .analytics import EmailAnalytics
-from .base import AsyncBase, Base, BaseItem, InvalidKeyError, ItemConflictError, ItemNotFoundError, QueryResponse
+from .collections import (
+    AsyncCollection,
+    BaseItem,
+    Collection,
+    InvalidKeyError,
+    ItemConflictError,
+    ItemNotFoundError,
+    QueryResponse,
+)
+from .collections.compatibility import AsyncBase, Base
 from .otp import OTP
 from .quota import Quota
 from .send import Send
@@ -48,14 +57,16 @@ def login(token: str, /, *, debug: bool = False) -> Contiguity:
 
 __all__ = (
     "AsyncBase",
+    "AsyncCollection",
+    "Base",
     "Contiguity",
     "Send",
     "Verify",
     "EmailAnalytics",
     "Quota",
     "OTP",
     "Template",
-    "Base",
+    "Collection",
     "BaseItem",
     "InvalidKeyError",
     "ItemConflictError",

src/contiguity/base/__init__.py → src/contiguity/collections/__init__.py

@@ -1,11 +1,11 @@
-from .async_base import AsyncBase
-from .base import Base
+from .async_collection import AsyncCollection
+from .collection import Collection
 from .common import BaseItem, QueryResponse
 from .exceptions import InvalidKeyError, ItemConflictError, ItemNotFoundError
 
 __all__ = (
-    "AsyncBase",
-    "Base",
+    "AsyncCollection",
+    "Collection",
     "BaseItem",
     "InvalidKeyError",
     "ItemConflictError",

src/contiguity/base/async_base.py → src/contiguity/collections/async_collection.py

@@ -36,7 +36,7 @@
     from typing_extensions import Self
 
 
-class AsyncBase(Generic[ItemT]):
+class AsyncCollection(Generic[ItemT]):
     EXPIRES_ATTRIBUTE = "__expires"
     PUT_LIMIT = 30
 
@@ -83,14 +83,14 @@ def __init__(  # noqa: PLR0913
         json_decoder: type[json.JSONDecoder] = json.JSONDecoder,  # Only used when item_type is not a Pydantic model.
     ) -> None:
         if not name:
-            msg = f"invalid Base name '{name}'"
+            msg = f"invalid Collection name '{name}'"
             raise ValueError(msg)
 
         self.name = name
         self.item_type = item_type
         self.data_key = data_key or project_key or get_data_key()
         self.project_id = project_id or get_project_id()
-        self.host = host or os.getenv("CONTIGUITY_BASE_HOST") or "api.base.contiguity.co"
+        self.host = host or os.getenv("CONTIGUITY_COLLECTIONS_HOST") or "api.base.contiguity.co"
         self.api_version = api_version
         self.json_decoder = json_decoder
         self.util = Updates()
@@ -190,7 +190,7 @@ async def get(
         return self._response_as_item_type(response, sequence=False)
 
     async def delete(self: Self, key: str, /) -> None:
-        """Delete an item from the Base."""
+        """Delete an item from the Collection."""
         key = check_key(key)
         response = await self._client.delete(f"/items/{key}")
         try:

src/contiguity/base/base.py → src/contiguity/collections/collection.py

@@ -45,7 +45,7 @@
     from typing_extensions import Self
 
 
-class Base(Generic[ItemT]):
+class Collection(Generic[ItemT]):
     EXPIRES_ATTRIBUTE = "__expires"
     PUT_LIMIT = 30
 
@@ -92,14 +92,14 @@ def __init__(  # noqa: PLR0913
         json_decoder: type[json.JSONDecoder] = json.JSONDecoder,  # Only used when item_type is not a Pydantic model.
     ) -> None:
         if not name:
-            msg = f"invalid Base name '{name}'"
+            msg = f"invalid Collection name '{name}'"
             raise ValueError(msg)
 
         self.name = name
         self.item_type = item_type
         self.data_key = data_key or project_key or get_data_key()
         self.project_id = project_id or get_project_id()
-        self.host = host or os.getenv("CONTIGUITY_BASE_HOST") or "api.base.contiguity.co"
+        self.host = host or os.getenv("CONTIGUITY_COLLECTIONS_HOST") or "api.base.contiguity.co"
         self.api_version = api_version
         self.json_decoder = json_decoder
         self.util = Updates()
@@ -199,7 +199,7 @@ def get(
         return self._response_as_item_type(response, sequence=False)
 
     def delete(self: Self, key: str, /) -> None:
-        """Delete an item from the Base."""
+        """Delete an item from the Collection."""
         key = check_key(key)
         response = self._client.delete(f"/items/{key}")
         try:

src/contiguity/collections/compatibility.py

@@ -0,0 +1,15 @@
+from typing_extensions import deprecated
+
+from .async_collection import AsyncCollection
+from .collection import Collection
+from .common import ItemT
+
+
+@deprecated("This class has been renamed to `Collection` and will be removed in a future release.")
+class Base(Collection[ItemT]):
+    pass
+
+
+@deprecated("This class has been renamed to `AsyncCollection` and will be removed in a future release.")
+class AsyncBase(AsyncCollection[ItemT]):
+    pass