spamdetector-client 0.1.0__py3-none-any.whl

spamdetector/__init__.py

@@ -0,0 +1,12 @@
+from .client import DEFAULT_BASE_URL, PredictionResult, SpamDetector, predict
+from .exceptions import SpamDetectorAPIError, SpamDetectorAuthError, SpamDetectorError
+
+__all__ = [
+    "DEFAULT_BASE_URL",
+    "PredictionResult",
+    "SpamDetector",
+    "SpamDetectorAPIError",
+    "SpamDetectorAuthError",
+    "SpamDetectorError",
+    "predict",
+]

spamdetector/client.py

@@ -0,0 +1,97 @@
+from __future__ import annotations
+
+import os
+from dataclasses import dataclass
+from typing import Any, Mapping, Optional
+
+import requests
+
+from .exceptions import SpamDetectorAPIError, SpamDetectorAuthError
+
+DEFAULT_BASE_URL = "https://spamdetactor5-9bz78yna.b4a.run"
+DEFAULT_TIMEOUT = 30
+
+
+@dataclass(frozen=True)
+class PredictionResult:
+    prediction: str
+    confidence: float
+    raw: Mapping[str, Any]
+
+    def to_dict(self) -> dict[str, Any]:
+        return {
+            "prediction": self.prediction,
+            "confidence": self.confidence,
+            "raw": dict(self.raw),
+        }
+
+
+class MessagesResource:
+    def __init__(self, client: "SpamDetector") -> None:
+        self._client = client
+
+    def create(self, *, message: str) -> PredictionResult:
+        return self._client.predict(message)
+
+
+class SpamDetector:
+    """Client for the Spam Detector API."""
+
+    def __init__(
+        self,
+        api_key: Optional[str] = None,
+        *,
+        base_url: str = DEFAULT_BASE_URL,
+        timeout: int = DEFAULT_TIMEOUT,
+        session: Optional[requests.Session] = None,
+    ) -> None:
+        self.api_key = api_key or os.getenv("SPAMDETECTOR_API_KEY")
+        if not self.api_key:
+            raise SpamDetectorAuthError(
+                "API key is required. Pass api_key='...' or set SPAMDETECTOR_API_KEY."
+            )
+
+        self.base_url = base_url.rstrip("/")
+        self.timeout = timeout
+        self.session = session or requests.Session()
+        self.messages = MessagesResource(self)
+
+    def predict(self, message: str) -> PredictionResult:
+        """Send a message to the API and return the spam prediction."""
+        if not isinstance(message, str) or not message.strip():
+            raise ValueError("message must be a non-empty string.")
+
+        try:
+            response = self.session.post(
+                f"{self.base_url}/predict",
+                json={"message": message},
+                headers={"X-API-Key": self.api_key},
+                timeout=self.timeout,
+            )
+        except requests.RequestException as exc:
+            raise SpamDetectorAPIError(f"API request failed: {exc}") from exc
+
+        if response.status_code in {401, 403}:
+            raise SpamDetectorAuthError(
+                f"API authentication failed: {response.status_code} {response.text}"
+            )
+
+        if not response.ok:
+            raise SpamDetectorAPIError(
+                f"API request failed: {response.status_code} {response.text}"
+            )
+
+        try:
+            payload = response.json()
+            return PredictionResult(
+                prediction=str(payload["prediction"]),
+                confidence=float(payload["confidence"]),
+                raw=payload,
+            )
+        except (KeyError, TypeError, ValueError) as exc:
+            raise SpamDetectorAPIError(f"API returned an invalid response: {response.text}") from exc
+
+
+def predict(message: str, *, api_key: Optional[str] = None) -> PredictionResult:
+    """Convenience function for one-off predictions."""
+    return SpamDetector(api_key=api_key).predict(message)

spamdetector/exceptions.py

@@ -0,0 +1,10 @@
+class SpamDetectorError(Exception):
+    """Base exception for Spam Detector client errors."""
+
+
+class SpamDetectorAuthError(SpamDetectorError):
+    """Raised when the API key is missing or rejected."""
+
+
+class SpamDetectorAPIError(SpamDetectorError):
+    """Raised when the API returns a non-success response."""

spamdetector_client-0.1.0.dist-info/METADATA

@@ -0,0 +1,91 @@
+Metadata-Version: 2.4
+Name: spamdetector-client
+Version: 0.1.0
+Summary: Python client for the Spam Detector API.
+Author: Bilal Khan
+License-Expression: MIT
+Project-URL: Homepage, https://spamdetactor5-9bz78yna.b4a.run
+Project-URL: API, https://spamdetactor5-9bz78yna.b4a.run/predict
+Keywords: spam,detector,api,client
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.31.0
+Dynamic: license-file
+
+# Spam Detector Client
+
+Python library for calling the Spam Detector API.
+
+## Install locally
+
+```bash
+pip install -e .
+```
+
+After publishing to PyPI, users will install it with:
+
+```bash
+pip install spamdetector-client
+```
+
+## Usage
+
+OpenAI-style client usage:
+
+```python
+from spamdetector import SpamDetector
+
+client = SpamDetector(api_key="YOUR_API_KEY")
+result = client.messages.create(message="Win a free iPhone today!")
+
+print(result.prediction)
+print(result.confidence)
+```
+
+Simple function usage:
+
+```python
+from spamdetector import predict
+
+result = predict("Win a free iPhone today!", api_key="YOUR_API_KEY")
+print(result.to_dict())
+```
+
+You can also keep the API key in an environment variable:
+
+```bash
+set SPAMDETECTOR_API_KEY=YOUR_API_KEY
+```
+
+```python
+from spamdetector import predict
+
+result = predict("Your message here")
+print(result.to_dict())
+```
+
+## Publish to PyPI
+
+Update `pyproject.toml` first:
+
+- Change `authors`
+- Confirm the package name is available on PyPI
+- Bump `version` whenever you publish a new release
+
+Then run:
+
+```bash
+python -m pip install --upgrade build twine
+python -m build
+python -m twine upload dist/*
+```

spamdetector_client-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+spamdetector/__init__.py,sha256=9ahF_CmL13BugHW4rYZawUFR0Zj-koTc2C-7RtZnEK0,345
+spamdetector/client.py,sha256=O7b0ygpeSwTSPA6RhQ60jX3msHyLFmH-t9x4tN5o0WQ,3116
+spamdetector/exceptions.py,sha256=bfiUWLjdHp49UEL6IEYgjQ1Y7rjnhkc0VBpt0GDgtrY,313
+spamdetector_client-0.1.0.dist-info/licenses/LICENSE,sha256=ESYyLizI0WWtxMeS7rGVcX3ivMezm-HOd5WdeOh-9oU,1056
+spamdetector_client-0.1.0.dist-info/METADATA,sha256=MCfWQlWJGqHjQomDbs-OhJLswRY5-z-o1x99RVWHN_o,2149
+spamdetector_client-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+spamdetector_client-0.1.0.dist-info/top_level.txt,sha256=Y_iYRvNo4AyCRBpNNowNDjdVVMUzaUajggoDquIX-xQ,13
+spamdetector_client-0.1.0.dist-info/RECORD,,

spamdetector_client-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

spamdetector_client-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026
+
+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.

spamdetector_client-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+spamdetector