sentor-ml 1.0.0__py3-none-any.whl

sentor/__init__.py

@@ -0,0 +1,3 @@
+from .client import SentorClient
+
+__all__ = ["SentorClient"]

sentor/client.py

@@ -0,0 +1,86 @@
+import requests
+from .exceptions import SentorAPIError, RateLimitError, AuthenticationError
+from typing import TypedDict, List
+
+
+class DocumentInput(TypedDict):
+    """Represents a document to be analyzed with its metadata."""
+
+    doc_id: str
+    doc: str
+    entities: List[str]
+
+
+class SentorClient:
+    """Client for interacting with the Sentor ML API."""
+
+    def __init__(
+        self,
+        api_key: str,
+        base_url: str = "https://ml.sentor.app/api",
+        timeout: int = 30,
+    ):
+        """
+        Initialize the Sentor client with API credentials and configuration.
+        """
+        self.api_key = api_key
+        self.base_url = base_url
+        self.timeout = timeout
+        self.headers = {
+            "x-api-key": self.api_key,
+            "Content-Type": "application/json",
+        }
+
+    def analyze(self, documents: List[DocumentInput]):
+        """Analyze documents for sentiment and entity extraction.
+
+        Args:
+            documents: List of documents to analyze
+
+        Returns:
+            dict: Analysis results
+
+        Raises:
+            ValueError: If input is empty
+            RateLimitError: If API rate limit is exceeded
+            AuthenticationError: If API key is invalid
+            SentorAPIError: For other API errors
+        """
+        if not documents:
+            raise ValueError("Input is required")
+
+        url = f"{self.base_url}/ml/predict"
+        payload = {"docs": documents}
+        response = requests.post(
+            url, json=payload, headers=self.headers, timeout=self.timeout
+        )
+
+        if response.status_code == 200:
+            return response.json()
+        elif response.status_code == 429:
+            raise RateLimitError(response.json())
+        elif response.status_code == 401:
+            raise AuthenticationError(response.json())
+        else:
+            raise SentorAPIError(response.json())
+
+    def check_health(self):
+        """Check the health status of the Sentor API.
+
+        Returns:
+            dict: Health status information
+
+        Raises:
+            SentorAPIError: If health check fails
+        """
+        url = f"{self.base_url}/health"
+        response = requests.get(
+            url,
+            headers=self.headers,
+            timeout=self.timeout,
+        )
+
+        if response.status_code == 200:
+            return response.json()
+        else:
+            raise SentorAPIError(response.json())

sentor/exceptions.py

@@ -0,0 +1,21 @@
+class SentorAPIError(Exception):
+    """Base exception for all Sentor API errors."""
+
+    def __init__(self, response):
+        self.message = response.get("detail", "An error occurred")
+        self.code = response.get("status_code", "unknown")
+        super().__init__(self.message)
+
+
+class RateLimitError(SentorAPIError):
+    """Exception raised when API rate limit is exceeded."""
+
+    def __init__(self, response):
+        super().__init__(response)
+        self.retry_after = response.get("retry_after", 60)
+
+
+class AuthenticationError(SentorAPIError):
+    """Exception raised when API authentication fails."""
+
+    pass

sentor_ml-1.0.0.dist-info/METADATA

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: sentor-ml
+Version: 1.0.0
+Summary: A Python SDK for interacting with the Sentor ML API for sentiment analysis
+Home-page: https://github.com/NIKX-Tech/sentor-ml-python-sdk
+Author: NIKX Technologies
+Author-email: sentor@nikx.one
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.28.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Sentor Python SDK
+
+A Python SDK for interacting with the Sentor ML API for sentiment analysis. This SDK provides a simple and intuitive interface for sentiment analysis operations.
+
+## Installation
+
+```bash
+pip install sentor-ml
+```
+
+## Features
+
+- 🚀 Python 3.7+ support
+- ⚡ Simple and intuitive API
+- 🌍 Support for multiple languages
+- 📦 Batch processing capabilities
+- 🛡️ Comprehensive error handling
+- 🔄 Real-time sentiment analysis
+
+## Usage
+
+### Basic Usage
+
+```python
+from sentor import SentorClient
+
+# Initialize the client
+client = SentorClient('your-api-key')
+
+# Analyze sentiment
+input_data = [
+    {
+        "doc": "Apple's new iPhone is amazing!",
+        "doc_id": "1",
+        "entities": [
+            "Apple",
+            "iPhone"
+        ]
+    },
+    {
+        "doc": "Samsung's new phone is amazing!",
+        "doc_id": "2",
+        "entities": [
+            "Samsung",
+            "phone"
+        ]
+    }
+]
+result = client.analyze(input_data)
+print(result)
+```
+
+### Sample Output
+
+```json
+{
+  "results": [
+    {
+      "doc_id": "1",
+      "predicted_class": 2,
+      "predicted_label": "positive",
+      "probabilities": {
+        "negative": 0.00010637386003509164,
+        "neutral": 0.0002509312762413174,
+        "positive": 0.9996427297592163
+      }
+    },
+    {
+      "doc_id": "2",
+      "predicted_class": 2,
+      "predicted_label": "positive",
+      "probabilities": {
+        "negative": 0.00010637386003509164,
+        "neutral": 0.0002509312762413174,
+        "positive": 0.9996427297592163
+      }
+    }
+  ]
+}
+```
+
+## API Reference
+
+Please refer to the [Sentor ML API Documentation](https://ml.sentor.app) for more details.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+MIT License - see the [LICENSE](LICENSE) file for details.

sentor_ml-1.0.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+sentor/__init__.py,sha256=K0z9SVT_Bkif2bj3Yqr7QtvQNTJll6an3DCuE0-rD0c,64
+sentor/client.py,sha256=6Sps6UFLmUaEiE69yY8C537OQTtLteGLROs3N6om5Ss,2519
+sentor/exceptions.py,sha256=MY5uFUJd_WBhCMc0zNxVvoasC1rME4Brqv82MwhDM7c,648
+tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/test_client.py,sha256=kuhFtgwehMGqC0JKJfzAvqEl6UTvYo2nZDNa7YRF4rs,4101
+sentor_ml-1.0.0.dist-info/METADATA,sha256=EhHpLSuh4y8VYjHGhPrrU4zGBU9VnbR8HhJd-ri0iRY,2993
+sentor_ml-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+sentor_ml-1.0.0.dist-info/entry_points.txt,sha256=iYoIGXM8AusRG36JhqnBREngOd0iDOYN0C8PpiHtgXE,46
+sentor_ml-1.0.0.dist-info/top_level.txt,sha256=nVfiI7y35XyGm5wyA94o24nDInXLiheycaaRtkR10ko,13
+sentor_ml-1.0.0.dist-info/RECORD,,

sentor_ml-1.0.0.dist-info/WHEEL

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

sentor_ml-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+sentor = sentor.client:main

sentor_ml-1.0.0.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+sentor
+tests

tests/test_client.py

@@ -0,0 +1,132 @@
+import pytest
+from sentor import SentorClient
+from sentor.exceptions import (
+    SentorAPIError,
+    RateLimitError,
+    AuthenticationError,
+)
+from unittest.mock import Mock, patch
+
+
+@pytest.fixture
+def mock_client():
+    """Create a mock SentorClient instance for testing."""
+    client = SentorClient("test-key")
+    return client
+
+
+def test_client_initialization():
+    """Test proper initialization of SentorClient with default parameters."""
+    client = SentorClient(api_key="test-key")
+    assert isinstance(client, SentorClient)
+    assert client.api_key == "test-key"
+    assert client.base_url == "https://ml.sentor.app/api"
+    assert client.timeout == 30
+
+
+@patch("requests.post")
+def test_analyze_success(mock_post):
+    """Test successful document analysis with positive sentiment."""
+    # Setup mock response
+    mock_response = Mock()
+    mock_response.status_code = 200
+    mock_response.json.return_value = {
+        "results": [
+            {
+                "predicted_label": "positive",
+                "probabilities": {"positive": 0.95},
+            }
+        ]
+    }
+    mock_post.return_value = mock_response
+
+    # Test the analyze method
+    client = SentorClient("test-key")
+    documents = [{"doc_id": "1", "doc": "Test text", "entities": []}]
+    result = client.analyze(documents)
+
+    assert result["results"][0]["predicted_label"] == "positive"
+    assert result["results"][0]["probabilities"]["positive"] == 0.95
+    mock_post.assert_called_once()
+
+
+@patch("requests.post")
+def test_analyze_rate_limit(mock_post):
+    """Test rate limit error handling during document analysis."""
+    # Setup mock response for rate limit error
+    mock_response = Mock()
+    mock_response.status_code = 429
+    mock_response.json.return_value = {
+        "detail": "Rate limit exceeded",
+        "retry_after": 60,
+    }
+    mock_post.return_value = mock_response
+
+    # Test rate limit error
+    client = SentorClient("test-key")
+    documents = [{"doc_id": "1", "doc": "Test text", "entities": []}]
+
+    with pytest.raises(RateLimitError) as exc_info:
+        client.analyze(documents)
+
+    assert exc_info.value.retry_after == 60
+
+
+@patch("requests.post")
+def test_analyze_auth_error(mock_post):
+    """Test authentication error handling during document analysis."""
+    # Setup mock response for authentication error
+    mock_response = Mock()
+    mock_response.status_code = 401
+    mock_response.json.return_value = {"detail": "Invalid API key"}
+    mock_post.return_value = mock_response
+
+    # Test authentication error
+    client = SentorClient("test-key")
+    documents = [{"doc_id": "1", "doc": "Test text", "entities": []}]
+
+    with pytest.raises(AuthenticationError):
+        client.analyze(documents)
+
+
+def test_analyze_empty_input():
+    """Test validation of empty input in document analysis."""
+    client = SentorClient("test-key")
+    with pytest.raises(ValueError, match="Input is required"):
+        client.analyze([])
+
+
+@patch("requests.get")
+def test_check_health_success(mock_get):
+    """Test successful health check response."""
+    # Setup mock response
+    mock_response = Mock()
+    mock_response.status_code = 200
+    mock_response.json.return_value = {"status": "healthy"}
+    mock_get.return_value = mock_response
+
+    # Test health check
+    client = SentorClient("test-key")
+    result = client.check_health()
+
+    assert result["status"] == "healthy"
+    mock_get.assert_called_once()
+
+
+@patch("requests.get")
+def test_check_health_error(mock_get):
+    """Test error handling during health check."""
+    # Setup mock response for error
+    mock_response = Mock()
+    mock_response.status_code = 500
+    mock_response.json.return_value = {"detail": "Internal server error"}
+    mock_get.return_value = mock_response
+
+    # Test health check error
+    client = SentorClient("test-key")
+    with pytest.raises(SentorAPIError):
+        client.check_health()
+
+
+if __name__ == "__main__":
+    pytest.main([__file__])