✨ add eu license plate v1

Author: ianardee

docs/code_samples/eu/license_plate_v1.py

@@ -0,0 +1,13 @@
+from mindee import Client, documents
+
+# Init a new client
+mindee_client = Client(api_key="my-api-key")
+
+# Load a file from disk
+input_doc = mindee_client.doc_from_path("/path/to/the/file.ext")
+
+# Parse the License Plate by passing the appropriate type
+result = input_doc.parse(documents.eu.TypeLicensePlateV1)
+
+# Print a brief summary of the parsed data
+print(result.document)

docs/predictions/standard/documents/eu/license_plate_v1.rst

@@ -0,0 +1,10 @@
+License Plate V1
+----------------
+
+**Sample Code:**
+
+.. literalinclude:: /code_samples/eu/license_plate_v1.py
+    :language: Python
+
+.. autoclass:: mindee.documents.eu.LicensePlateV1
+    :members:

docs/predictions/standard/eu.rst

@@ -0,0 +1,4 @@
+European Union
+##############
+
+.. include:: ./documents/eu/license_plate_v1.rst

docs/predictions/standard/index.rst

@@ -7,4 +7,5 @@ Off the Shelf
     ./field_types
     ./international
     ./us
+    ./eu
     ./fr

mindee/cli.py

@@ -46,10 +46,14 @@ class CommandConfig(Generic[TypeDoc]):
         help="Shipping Container",
         doc_class=documents.fr.TypeIdCardV1,
     ),
-    "us-check": CommandConfig(
+    "us-bank-check": CommandConfig(
         help="US Bank Check",
         doc_class=documents.us.TypeBankCheckV1,
     ),
+    "eu-license-plate": CommandConfig(
+        help="EU License Plate",
+        doc_class=documents.eu.TypeLicensePlateV1,
+    ),
     "fr-carte-grise": CommandConfig(
         help="FR Carte Grise",
         doc_class=documents.fr.TypeCarteGriseV1,

mindee/client.py

@@ -263,6 +263,11 @@ def _init_default_endpoints(self) -> None:
                 url_name="shipping_containers",
                 version="1",
             ),
+            ConfigSpec(
+                doc_class=documents.eu.LicensePlateV1,
+                url_name="license_plates",
+                version="1",
+            ),
         ]
         for config in configs:
             config_key = (OTS_OWNER, config.doc_class.__name__)

mindee/documents/__init__.py

@@ -1,6 +1,7 @@
 from mindee.documents import fr, us
 from mindee.documents.cropper import CropperV1, TypeCropperV1
 from mindee.documents.custom import CustomV1, TypeCustomV1
+from mindee.documents.eu import LicensePlateV1, TypeLicensePlateV1
 from mindee.documents.financial import (
     FinancialDocumentV1,
     FinancialV1,

mindee/documents/eu/__init__.py

@@ -0,0 +1 @@
+from .license_plate.license_plate_v1 import LicensePlateV1, TypeLicensePlateV1

mindee/documents/eu/license_plate/__init__.py

@@ -0,0 +1,60 @@
+from typing import List, Optional, TypeVar
+
+from mindee.documents.base import Document, TypeApiPrediction, clean_out_string
+from mindee.fields.text import TextField
+
+
+class LicensePlateV1(Document):
+    """License Plate v1 prediction results."""
+
+    license_plates: List[TextField]
+    """List of all license plates found in the image."""
+
+    def __init__(
+        self,
+        api_prediction=None,
+        input_source=None,
+        page_n: Optional[int] = None,
+    ):
+        """
+        License Plate v1 prediction results.
+
+        :param api_prediction: Raw prediction from HTTP response
+        :param input_source: Input object
+        :param page_n: Page number for multi pages pdf input
+        """
+        super().__init__(
+            input_source=input_source,
+            document_type="license_plate",
+            api_prediction=api_prediction,
+            page_n=page_n,
+        )
+        self._build_from_api_prediction(api_prediction["prediction"], page_n=page_n)
+
+    def _build_from_api_prediction(
+        self, api_prediction: TypeApiPrediction, page_n: Optional[int] = None
+    ) -> None:
+        """
+        Build the object from the prediction API JSON.
+
+        :param api_prediction: Raw prediction from HTTP response
+        :param page_n: Page number
+        """
+        self.license_plates = [
+            TextField(prediction, page_n=page_n)
+            for prediction in api_prediction["license_plates"]
+        ]
+
+    def __str__(self) -> str:
+        license_plates = f"\n { ' ' * 15 }".join(
+            [str(item) for item in self.license_plates]
+        )
+        return clean_out_string(
+            "----- EU License Plate V1 -----\n"
+            f"Filename: {self.filename or ''}\n"
+            f"License Plates: { license_plates }\n"
+            "----------------------"
+        )
+
+
+TypeLicensePlateV1 = TypeVar("TypeLicensePlateV1", bound=LicensePlateV1)