dragoneye-python 0.1.0__tar.gz → 0.2.0__tar.gz

{dragoneye_python-0.1.0 → dragoneye_python-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dragoneye-python
-Version: 0.1.0
+Version: 0.2.0
 Requires-Python: >=3.8
 License-File: LICENSE
 Requires-Dist: requests

{dragoneye_python-0.1.0 → dragoneye_python-0.2.0}/dragoneye_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dragoneye-python
-Version: 0.1.0
+Version: 0.2.0
 Requires-Python: >=3.8
 License-File: LICENSE
 Requires-Dist: requests

dragoneye_python-0.2.0/dragoneye_python.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+README.md
+pyproject.toml
+requirements.txt
+dragoneye_python.egg-info/PKG-INFO
+dragoneye_python.egg-info/SOURCES.txt
+dragoneye_python.egg-info/dependency_links.txt
+dragoneye_python.egg-info/requires.txt
+dragoneye_python.egg-info/top_level.txt
+src/dragoneye/__init__.py
+src/dragoneye/classification.py
+src/dragoneye/client.py
+src/dragoneye/types/__init__.py
+src/dragoneye/types/common.py
+src/dragoneye/types/image.py

dragoneye_python-0.2.0/dragoneye_python.egg-info/top_level.txt

@@ -0,0 +1 @@
+dragoneye

dragoneye_python-0.2.0/pyproject.toml

@@ -0,0 +1,11 @@
+[project]
+name = "dragoneye-python"
+version = "0.2.0"
+requires-python = ">=3.8"
+dynamic = ["dependencies"]
+
+[tool.setuptools.dynamic]
+dependencies = {file = ["requirements.txt"]}
+
+[tool.setuptools.package-dir]
+dragoneye = "src/dragoneye"

dragoneye_python-0.2.0/src/dragoneye/__init__.py

@@ -0,0 +1,22 @@
+from .classification import (
+    Classification,
+    ClassificationObjectPrediction,
+    ClassificationPredictImageResponse,
+    ClassificationTraitRootPrediction,
+)
+from .client import Dragoneye
+from .types.common import NormalizedBbox, TaxonID, TaxonPrediction, TaxonType
+from .types.image import Image
+
+__all__ = [
+    "Classification",
+    "ClassificationObjectPrediction",
+    "ClassificationPredictImageResponse",
+    "ClassificationTraitRootPrediction",
+    "Dragoneye",
+    "Image",
+    "NormalizedBbox",
+    "TaxonID",
+    "TaxonPrediction",
+    "TaxonType",
+]

dragoneye_python-0.2.0/src/dragoneye/classification.py

@@ -0,0 +1,117 @@
+import io
+from typing import TYPE_CHECKING, BinaryIO, Sequence
+
+import requests
+from pydantic import BaseModel
+
+from .types.common import BASE_API_URL, NormalizedBbox, TaxonID, TaxonPrediction
+from .types.image import Image, assert_consistent_data_type
+
+if TYPE_CHECKING:
+    from .client import Dragoneye
+
+
+class ClassificationTraitRootPrediction(BaseModel):
+    id: TaxonID
+    name: str
+    displayName: str
+    taxons: Sequence[TaxonPrediction]
+
+
+class ClassificationObjectPrediction(BaseModel):
+    normalizedBbox: NormalizedBbox
+    category: TaxonPrediction
+    traits: Sequence[ClassificationTraitRootPrediction]
+
+
+class ClassificationPredictImageResponse(BaseModel):
+    predictions: Sequence[ClassificationObjectPrediction]
+
+
+class ClassificationProductPrediction(BaseModel):
+    category: TaxonPrediction
+    traits: Sequence[ClassificationTraitRootPrediction]
+
+
+class ClassificationPredictProductResponse(BaseModel):
+    predictions: Sequence[ClassificationProductPrediction]
+
+
+class Classification:
+    def __init__(self, client: "Dragoneye"):
+        self._client = client
+
+    def predict(
+        self, image: Image, model_name: str
+    ) -> ClassificationPredictImageResponse:
+        url = f"{BASE_API_URL}/predict"
+
+        files = {}
+        data = {}
+
+        if image.file_or_bytes is not None:
+            if isinstance(image.file_or_bytes, bytes):
+                files["image_file"] = io.BytesIO(image.file_or_bytes)
+            elif isinstance(image.file_or_bytes, BinaryIO):  # pyright: ignore [reportUnnecessaryIsInstance]
+                files["image_file"] = image.file_or_bytes
+            else:
+                raise ValueError("Invalid image type: Must be bytes or BinaryIO")
+        elif image.url is not None:
+            data["image_url"] = image.url
+        else:
+            raise ValueError(
+                "Missing image: Either image file or image url must be specified"
+            )
+
+        data["model_name"] = model_name
+
+        headers = {"Authorization": f"Bearer {self._client.api_key}"}
+
+        try:
+            response = requests.post(url, files=files, data=data, headers=headers)
+            response.raise_for_status()
+        except requests.RequestException as error:
+            raise Exception(
+                "Error during Dragoneye Classification prediction request:", error
+            )
+
+        return ClassificationPredictImageResponse.model_validate(response.json())
+
+    def predict_product(
+        self, images: Sequence[Image], model_name: str
+    ) -> ClassificationPredictProductResponse:
+        url = f"{BASE_API_URL}/predict-product"
+
+        files = []
+        data = {}
+
+        assert_consistent_data_type(images)
+
+        for image in images:
+            if image.file_or_bytes is not None:
+                if isinstance(image.file_or_bytes, bytes):
+                    files.append(("image_file", io.BytesIO(image.file_or_bytes)))
+                elif (
+                    isinstance(image.file_or_bytes, BinaryIO)  # pyright: ignore [reportUnnecessaryIsInstance]
+                    or issubclass(type(image.file_or_bytes), BinaryIO)
+                    or isinstance(image.file_or_bytes, io.BufferedReader)
+                ):
+                    files.append(("image_file", image.file_or_bytes))
+                else:
+                    raise ValueError("Invalid image type: Must be bytes or BinaryIO")
+            elif image.url is not None:
+                data.setdefault("image_urls", []).append(image.url)
+
+        data["model_name"] = model_name
+
+        headers = {"Authorization": f"Bearer {self._client.api_key}"}
+
+        try:
+            response = requests.post(url, files=files, data=data, headers=headers)
+            response.raise_for_status()
+        except requests.RequestException as error:
+            raise Exception(
+                "Error during Dragoneye Classification prediction request:", error
+            )
+
+        return ClassificationPredictProductResponse.model_validate(response.json())

dragoneye_python-0.2.0/src/dragoneye/client.py

@@ -0,0 +1,18 @@
+import os
+from typing import Optional
+
+from dragoneye.classification import Classification
+
+
+class Dragoneye:
+    def __init__(self, api_key: Optional[str] = None):
+        if api_key is None:
+            api_key = os.getenv("DRAGONEYE_API_KEY")
+
+        assert (
+            api_key is not None
+        ), "API key is required - set the DRAGONEYE_API_KEY environment variable or pass it to the [Dragoneye] constructor"
+
+        self.api_key = api_key
+
+        self.classification = Classification(self)

dragoneye_python-0.2.0/src/dragoneye/types/common.py

@@ -0,0 +1,26 @@
+from enum import Enum
+from typing import NewType, Optional, Sequence, Tuple
+
+from pydantic import BaseModel
+
+NormalizedBbox = NewType("NormalizedBbox", Tuple[float, float, float, float])
+
+
+class TaxonType(str, Enum):
+    CATEGORY = ("category",)
+    TRAIT = ("trait",)
+
+
+TaxonID = NewType("TaxonID", int)
+
+
+class TaxonPrediction(BaseModel):
+    id: TaxonID
+    type: TaxonType
+    name: str
+    displayName: str
+    score: Optional[float]
+    children: Sequence["TaxonPrediction"]
+
+
+BASE_API_URL = "https://api.dragoneye.ai"

dragoneye_python-0.2.0/src/dragoneye/types/image.py

@@ -0,0 +1,12 @@
+from typing import BinaryIO, NamedTuple, Optional, Sequence, Union
+
+
+class Image(NamedTuple):
+    file_or_bytes: Optional[Union[bytes, BinaryIO]] = None
+    url: Optional[str] = None
+
+
+def assert_consistent_data_type(images: Sequence[Image]) -> None:
+    assert all(image.file_or_bytes is not None for image in images) ^ all(
+        image.url is not None for image in images
+    )

dragoneye_python-0.1.0/dragoneye_python.egg-info/SOURCES.txt

@@ -1,9 +0,0 @@
-LICENSE
-README.md
-pyproject.toml
-requirements.txt
-dragoneye_python.egg-info/PKG-INFO
-dragoneye_python.egg-info/SOURCES.txt
-dragoneye_python.egg-info/dependency_links.txt
-dragoneye_python.egg-info/requires.txt
-dragoneye_python.egg-info/top_level.txt

dragoneye_python-0.1.0/dragoneye_python.egg-info/top_level.txt

@@ -1 +0,0 @@
-

dragoneye_python-0.1.0/pyproject.toml

@@ -1,8 +0,0 @@
-[project]
-name = "dragoneye-python"
-version = "0.1.0"
-requires-python = ">=3.8"
-dynamic = ["dependencies"]
-
-[tool.setuptools.dynamic]
-dependencies = {file = ["requirements.txt"]}