✨ add support for fr id card v1

Author: ianardee

docs/code_samples/fr/id_card_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 Carte Nationale d'Identité by passing the appropriate type
+result = input_doc.parse(documents.fr.TypeIdCardV1)
+
+# Print a brief summary of the parsed data
+print(result.document)

mindee/cli.py

@@ -50,6 +50,14 @@ class CommandConfig(Generic[TypeDoc]):
         help="French Carte Grise",
         doc_class=documents.fr.TypeCarteGriseV1,
     ),
+    "fr-carte-vitale": CommandConfig(
+        help="French Carte Vitale",
+        doc_class=documents.fr.TypeCarteVitaleV1,
+    ),
+    "fr-id-card": CommandConfig(
+        help="French ID Card",
+        doc_class=documents.fr.TypeIdCardV1,
+    ),
 }
 
 

mindee/documents/fr/__init__.py

@@ -1 +1,3 @@
 from .carte_grise.carte_grise_v1 import CarteGriseV1, TypeCarteGriseV1
+from .carte_vitale.carte_vitale_v1 import CarteVitaleV1, TypeCarteVitaleV1
+from .id_card.id_card_v1 import IdCardV1, TypeIdCardV1

mindee/documents/fr/carte_vitale/carte_vitale_v1.py

@@ -6,7 +6,7 @@
 
 
 class CarteVitaleV1(Document):
-    """A Carte Vitale prediction."""
+    """Carte Vitale v1 prediction results."""
 
     given_names: List[TextField]
     """The given name(s) of the card holder."""
@@ -24,7 +24,7 @@ def __init__(
         page_n: Optional[int] = None,
     ):
         """
-         document.
+        Carte Vitale v1 prediction results.
 
         :param api_prediction: Raw prediction from HTTP response
         :param input_source: Input object
@@ -65,12 +65,14 @@ def _build_from_api_prediction(
         )
 
     def __str__(self) -> str:
+        given_names = "\n".join([str(item) for item in self.given_names])
         return clean_out_string(
-            "----- Carte Vitale V1 -----\n"
-            f"Given Name(s): {self.given_names}"
-            f"Surname: {self.surname}"
-            f"Social Security Number: {self.social_security}"
-            f"Issuance Date: {self.issuance_date}"
+            "----- FR Carte Vitale V1 -----\n"
+            f"Filename: {self.filename or ''}\n"
+            f"Given Name(s): { given_names }\n"
+            f"Surname: { self.surname }\n"
+            f"Social Security Number: { self.social_security }\n"
+            f"Issuance Date: { self.issuance_date }\n"
             "----------------------"
         )
 

mindee/documents/fr/id_card/__init__.py

@@ -0,0 +1,129 @@
+from typing import List, Optional, TypeVar
+
+from mindee.documents.base import Document, TypeApiPrediction, clean_out_string
+from mindee.fields.date import DateField
+from mindee.fields.text import TextField
+
+
+class IdCardV1(Document):
+    """Carte Nationale d'Identité v1 prediction results."""
+
+    document_side: TextField
+    """The side of the document which is visible."""
+    id_number: TextField
+    """The identification card number."""
+    given_names: List[TextField]
+    """The given name(s) of the card holder."""
+    surname: TextField
+    """The surname of the card holder."""
+    birth_date: DateField
+    """The date of birth of the card holder."""
+    birth_place: TextField
+    """The place of birth of the card holder."""
+    expiry_date: DateField
+    """The expiry date of the identification card."""
+    authority: TextField
+    """The name of the issuing authority."""
+    gender: TextField
+    """The gender of the card holder."""
+    mrz1: TextField
+    """Machine Readable Zone, first line"""
+    mrz2: TextField
+    """Machine Readable Zone, second line"""
+
+    def __init__(
+        self,
+        api_prediction=None,
+        input_source=None,
+        page_n: Optional[int] = None,
+    ):
+        """
+        Carte Nationale d'Identité 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="id_card",
+            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.document_side = TextField(
+            api_prediction.get("document_side", {}),
+            page_n=page_n,
+        )
+        self.id_number = TextField(
+            api_prediction["id_number"],
+            page_n=page_n,
+        )
+        self.given_names = [
+            TextField(prediction, page_n=page_n)
+            for prediction in api_prediction["given_names"]
+        ]
+        self.surname = TextField(
+            api_prediction["surname"],
+            page_n=page_n,
+        )
+        self.birth_date = DateField(
+            api_prediction["birth_date"],
+            page_n=page_n,
+        )
+        self.birth_place = TextField(
+            api_prediction["birth_place"],
+            page_n=page_n,
+        )
+        self.expiry_date = DateField(
+            api_prediction["expiry_date"],
+            page_n=page_n,
+        )
+        self.authority = TextField(
+            api_prediction["authority"],
+            page_n=page_n,
+        )
+        self.gender = TextField(
+            api_prediction["gender"],
+            page_n=page_n,
+        )
+        self.mrz1 = TextField(
+            api_prediction["mrz1"],
+            page_n=page_n,
+        )
+        self.mrz2 = TextField(
+            api_prediction["mrz2"],
+            page_n=page_n,
+        )
+
+    def __str__(self) -> str:
+        given_names = "\n".join([str(item) for item in self.given_names])
+        return clean_out_string(
+            "----- FR Carte Nationale d'Identité V1 -----\n"
+            f"Filename: {self.filename or ''}\n"
+            f"Document Side: { self.document_side }\n"
+            f"Identity Number: { self.id_number }\n"
+            f"Given Name(s): { given_names }\n"
+            f"Surname: { self.surname }\n"
+            f"Date of Birth: { self.birth_date }\n"
+            f"Place of Birth: { self.birth_place }\n"
+            f"Expiry Date: { self.expiry_date }\n"
+            f"Issuing Authority: { self.authority }\n"
+            f"Gender: { self.gender }\n"
+            f"MRZ Line 1: { self.mrz1 }\n"
+            f"MRZ Line 2: { self.mrz2 }\n"
+            "----------------------"
+        )
+
+
+TypeIdCardV1 = TypeVar("TypeIdCardV1", bound=IdCardV1)

mindee/documents/fr/id_card/id_card_v1.py

@@ -0,0 +1,50 @@
+import json
+
+import pytest
+
+from mindee.documents.fr.carte_vitale.carte_vitale_v1 import CarteVitaleV1
+
+FR_CARTE_VITALE_DATA_DIR = "./tests/data/fr/carte_vitale"
+
+FILE_PATH_FR_CARTE_VITALE_V1_COMPLETE = (
+    f"{ FR_CARTE_VITALE_DATA_DIR }/response_v1/complete.json"
+)
+FILE_PATH_FR_CARTE_VITALE_V1_EMPTY = (
+    f"{ FR_CARTE_VITALE_DATA_DIR }/response_v1/empty.json"
+)
+
+
+@pytest.fixture
+def carte_vitale_v1_doc() -> CarteVitaleV1:
+    json_data = json.load(open(FILE_PATH_FR_CARTE_VITALE_V1_COMPLETE))
+    return CarteVitaleV1(json_data["document"]["inference"], page_n=None)
+
+
+@pytest.fixture
+def carte_vitale_v1_doc_empty() -> CarteVitaleV1:
+    json_data = json.load(open(FILE_PATH_FR_CARTE_VITALE_V1_EMPTY))
+    return CarteVitaleV1(json_data["document"]["inference"], page_n=None)
+
+
+@pytest.fixture
+def carte_vitale_v1_page0():
+    json_data = json.load(open(FILE_PATH_FR_CARTE_VITALE_V1_COMPLETE))
+    return CarteVitaleV1(json_data["document"]["inference"]["pages"][0], page_n=0)
+
+
+def test_doc_constructor(carte_vitale_v1_doc):
+    reference_str = (
+        open(f"{ FR_CARTE_VITALE_DATA_DIR }/response_v1/doc_to_string.txt")
+        .read()
+        .strip()
+    )
+    assert str(carte_vitale_v1_doc) == reference_str
+
+
+def test_page0_constructor(carte_vitale_v1_page0):
+    reference_str = (
+        open(f"{ FR_CARTE_VITALE_DATA_DIR }/response_v1/page0_to_string.txt")
+        .read()
+        .strip()
+    )
+    assert str(carte_vitale_v1_page0) == reference_str

tests/data

@@ -0,0 +1,42 @@
+import json
+
+import pytest
+
+from mindee.documents.fr.id_card.id_card_v1 import IdCardV1
+
+FR_ID_CARD_DATA_DIR = "./tests/data/fr/id_card"
+
+FILE_PATH_FR_ID_CARD_V1_COMPLETE = f"{ FR_ID_CARD_DATA_DIR }/response_v1/complete.json"
+FILE_PATH_FR_ID_CARD_V1_EMPTY = f"{ FR_ID_CARD_DATA_DIR }/response_v1/empty.json"
+
+
+@pytest.fixture
+def id_card_v1_doc() -> IdCardV1:
+    json_data = json.load(open(FILE_PATH_FR_ID_CARD_V1_COMPLETE))
+    return IdCardV1(json_data["document"]["inference"], page_n=None)
+
+
+@pytest.fixture
+def id_card_v1_doc_empty() -> IdCardV1:
+    json_data = json.load(open(FILE_PATH_FR_ID_CARD_V1_EMPTY))
+    return IdCardV1(json_data["document"]["inference"], page_n=None)
+
+
+@pytest.fixture
+def id_card_v1_page0():
+    json_data = json.load(open(FILE_PATH_FR_ID_CARD_V1_COMPLETE))
+    return IdCardV1(json_data["document"]["inference"]["pages"][0], page_n=0)
+
+
+def test_doc_constructor(id_card_v1_doc):
+    reference_str = (
+        open(f"{ FR_ID_CARD_DATA_DIR }/response_v1/doc_to_string.txt").read().strip()
+    )
+    assert str(id_card_v1_doc) == reference_str
+
+
+def test_page0_constructor(id_card_v1_page0):
+    reference_str = (
+        open(f"{ FR_ID_CARD_DATA_DIR }/response_v1/page0_to_string.txt").read().strip()
+    )
+    assert str(id_card_v1_page0) == reference_str