definite-sdk 0.1.0__tar.gz

definite_sdk-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 luabase
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

definite_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.1
+Name: definite-sdk
+Version: 0.1.0
+Summary: Definite SDK for Python
+License: MIT
+Author: Definite
+Author-email: hello@definite.app
+Requires-Python: >=3.9,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: requests (>=2.31.0,<3.0.0)
+Description-Content-Type: text/markdown
+
+# Definite SDK
+
+A Python client for interacting with the Definite API, providing a convenient interface for key-value store operations.
+

definite_sdk-0.1.0/README.md

@@ -0,0 +1,3 @@
+# Definite SDK
+
+A Python client for interacting with the Definite API, providing a convenient interface for key-value store operations.

definite_sdk-0.1.0/definite_sdk/client.py

@@ -0,0 +1,23 @@
+from store import DefiniteKVStore
+
+API_URL = "https://api.definite.app"
+
+
+class DefiniteClient:
+    """Client for interacting with the Definite API."""
+
+    def __init__(self, api_key: str, api_url: str = API_URL):
+        """Creates a definite client with the provided API key.
+
+        See: https://docs.definite.app/definite-api for how to obtain an API key.
+        """
+        self.api_key = api_key
+        self.api_url = api_url
+
+    def get_kv_store(self, name: str) -> DefiniteKVStore:
+        """Initializes a key-value store with the provided name.
+
+        See DefiniteKVStore for more how to interact with the store.
+        """
+
+        return DefiniteKVStore(name, self.api_key, self.api_url)

definite_sdk-0.1.0/definite_sdk/store.py

@@ -0,0 +1,193 @@
+from typing import Iterator
+
+import requests
+
+STORE_ENDPOINT = "/v1/store"
+
+
+class DefiniteKVStore:
+    """
+    A key-value store hosted by Definite.
+
+    Initialization:
+    >>> client = DefiniteSdkClient("MY_API_KEY")
+    >>> store = client.get_kv_store("my_store")
+
+    Accessing values:
+    >>> print(store["key"])
+
+    Setting values:
+    >>> store["key"] = "value"
+    >>> store.commit()
+
+    To permanently delete "my_store":
+    >>> store.delete()
+
+    You MUST call commit() to save changes to the store.
+
+    The store uses versioning to prevent conflicts/stomping. If the store has
+    been modified since you last loaded it, the commit will fail.
+    """
+
+    def __init__(self, name: str, api_key: str, api_url: str):
+        """
+        Initializes the DefiniteKVStore with the provided name and API key.
+
+        Args:
+            name (str): The name of the key-value store.
+            api_key (str): The API key for authorization.
+
+        Raises:
+            Exception: If the store fails to load.
+        """
+
+        self._api_key = api_key
+        self._name = name
+        self._store_url = api_url + STORE_ENDPOINT
+        response = requests.get(
+            self._store_url,
+            json={"name": self._name},
+            headers={"Authorization": "Bearer " + self._api_key},
+        )
+
+        if response.status_code == 404:
+            # Store not found. Create a new one.
+            self._data = {}
+            self._version_id = None
+        elif response.status_code == 200:
+            # Store found. Load the data.
+            response_json = response.json()
+            self._data = response_json["data"]
+            self._version_id = response_json["version_id"]
+        else:
+            raise Exception("Failed to load the store: " + response.text)
+
+    def commit(self):
+        """
+        Commits the current state of the store to the remote server.
+
+        Raises:
+            Exception: If the commit fails.
+
+        Example:
+            store.commit()
+        """
+        response = requests.post(
+            self._store_url,
+            json={
+                "name": self._name,
+                "data": self._data,
+                "existing_version_id": self._version_id,
+            },
+            headers={"Authorization": "Bearer " + self._api_key},
+        )
+
+        if response.status_code != 200:
+            raise Exception("Failed to commit the DefiniteKVStore: " + response.text)
+        else:
+            response_json = response.json()
+            self._version_id = response_json.get("version_id")
+
+    def delete(self):
+        """
+        Deletes the store from the remote server.
+
+        Raises:
+            Exception: If the delete fails.
+
+        Example:
+            store.delete()
+        """
+        response = requests.delete(
+            self._store_url,
+            json={"name": self._name},
+            headers={"Authorization": "Bearer " + self._api_key},
+        )
+
+        if response.status_code != 200:
+            raise Exception("Failed to delete the DefiniteKVStore: " + response.text)
+
+        self._data = {}
+        self._version_id = None
+
+    def __getitem__(self, key: str) -> str | None:
+        """
+        Gets the value for a given key.
+
+        Args:
+            key (str): The key to retrieve the value for.
+
+        Returns:
+            The value associated with the key, or None if the key does not exist.
+
+        Example:
+            value = store["key1"]
+        """
+        return self._data.get(key)
+
+    def __setitem__(self, key: str, value: str):
+        """
+        Sets a key-value pair in the store.
+
+        Args:
+            key (str): The key to set.
+            value (str): The value to set.
+
+        Raises:
+            AssertionError: If key or value is not a string.
+
+        Example:
+            store["key1"] = "value1"
+        """
+        assert isinstance(key, str)
+        assert isinstance(value, str)
+        self._data[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        """
+        Deletes a key-value pair from the store.
+
+        Args:
+            key (str): The key to delete.
+
+        Example:
+            del store["key1"]
+        """
+        del self._data[key]
+
+    def __iter__(self) -> Iterator[str]:
+        """
+        Returns an iterator over the keys in the store.
+
+        Returns:
+            An iterator over the keys in the store.
+
+        Example:
+            for key in store:
+                print(key)
+        """
+        return iter(self._data)
+
+    def __len__(self) -> int:
+        """
+        Returns the number of key-value pairs in the store.
+
+        Returns:
+            The number of key-value pairs in the store.
+
+        Example:
+            length = len(store)
+        """
+        return len(self._data)
+
+    def __repr__(self) -> str:
+        """
+        Returns a string representation of the store, similar to a dictionary.
+
+        Returns:
+            A string representation of the store.
+
+        Example:
+            print(store)
+        """
+        return repr(self._data)

definite_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,26 @@
+[tool.poetry]
+name = "definite-sdk"
+version = "0.1.0"
+description = "Definite SDK for Python"
+authors = ["Definite <hello@definite.app>"]
+license = "MIT"
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.9"
+requests = "^2.31.0"
+
+
+[tool.poetry.group.dev.dependencies]
+black = "^24.4.2"
+flake8 = "^7.0.0"
+mypy = "^1.10.0"
+types-requests = "^2.31.0.20240406"
+pytest = "^8.2.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.isort]
+profile = "black"