📝 add sample code for all supported APIs

ianardee · ianardee · commit 60e2628b0541 · 2023-02-17T12:16:32.000+01:00
diff --git a/docs/conf.py b/docs/conf.py
@@ -56,6 +56,9 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
 
+# A list of paths that contain extra files not directly related to the documentation.
+html_extra_path = ["extras"]
+
 
 # -- autodoc -----------------------------------------------------------------
 
diff --git a/docs/extras/code_samples/custom_v1.txt b/docs/extras/code_samples/custom_v1.txt
@@ -0,0 +1,20 @@
+from mindee import Client, documents
+
+# Init a new client and add your custom endpoint (document)
+mindee_client = Client(api_key="my-api-key").add_endpoint(
+    account_name="my-account",
+    endpoint_name="my-endpoint",
+)
+
+# Load a file from disk and parse it.
+# The endpoint name must be specified since it can't be determined from the class.
+result = mindee_client.doc_from_path(
+    "/path/to/the/file.ext"
+).parse(documents.TypeCustomV1, endpoint_name="my-endpoint")
+
+# Print a brief summary of the parsed data
+print(result.document)
+
+# Iterate over all the fields in the document
+for field_name, field_values in result.document.fields.items():
+    print(field_name, "=", field_values)
diff --git a/docs/extras/code_samples/eu/license_plate_v1.txt b/docs/extras/code_samples/eu/license_plate_v1.txt
diff --git a/docs/extras/code_samples/financial_document_v1.txt b/docs/extras/code_samples/financial_document_v1.txt
@@ -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 Financial Document by passing the appropriate type
+result = input_doc.parse(documents.TypeFinancialDocumentV1)
+
+# Print a brief summary of the parsed data
+print(result.document)
diff --git a/docs/extras/code_samples/fr/bank_account_details_v1.txt b/docs/extras/code_samples/fr/bank_account_details_v1.txt
@@ -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 Bank Account Details by passing the appropriate type
+result = input_doc.parse(documents.fr.TypeBankAccountDetailsV1)
+
+# Print a brief summary of the parsed data
+print(result.document)
diff --git a/docs/extras/code_samples/fr/carte_vitale_v1.txt b/docs/extras/code_samples/fr/carte_vitale_v1.txt
diff --git a/docs/extras/code_samples/fr/id_card_v1.txt b/docs/extras/code_samples/fr/id_card_v1.txt
diff --git a/docs/extras/code_samples/invoice_v3.txt b/docs/extras/code_samples/invoice_v3.txt
@@ -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 Invoice by passing the appropriate type
+result = input_doc.parse(documents.TypeInvoiceV3)
+
+# Print a brief summary of the parsed data
+print(result.document)
diff --git a/docs/extras/code_samples/invoice_v4.txt b/docs/extras/code_samples/invoice_v4.txt
@@ -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 Invoice by passing the appropriate type
+result = input_doc.parse(documents.TypeInvoiceV4)
+
+# Print a brief summary of the parsed data
+print(result.document)
diff --git a/docs/extras/code_samples/passport_v1.txt b/docs/extras/code_samples/passport_v1.txt
@@ -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 Passport by passing the appropriate type
+result = input_doc.parse(documents.TypePassportV1)
+
+# Print a brief summary of the parsed data
+print(result.document)
diff --git a/docs/extras/code_samples/proof_of_address_v1.txt b/docs/extras/code_samples/proof_of_address_v1.txt
@@ -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 Proof of Address by passing the appropriate type
+result = input_doc.parse(documents.TypeProofOfAddressV1)
+
+# Print a brief summary of the parsed data
+print(result.document)
diff --git a/docs/extras/code_samples/receipt_v3.txt b/docs/extras/code_samples/receipt_v3.txt
@@ -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 Receipt by passing the appropriate type
+result = input_doc.parse(documents.TypeReceiptV3)
+
+# Print a brief summary of the parsed data
+print(result.document)
diff --git a/docs/extras/code_samples/receipt_v4.txt b/docs/extras/code_samples/receipt_v4.txt
@@ -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 Receipt by passing the appropriate type
+result = input_doc.parse(documents.TypeReceiptV4)
+
+# Print a brief summary of the parsed data
+print(result.document)
diff --git a/docs/extras/code_samples/shipping_container_v1.txt b/docs/extras/code_samples/shipping_container_v1.txt
diff --git a/docs/extras/code_samples/us/bank_check_v1.txt b/docs/extras/code_samples/us/bank_check_v1.txt
@@ -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 US Bank Check Details by passing the appropriate type
+result = input_doc.parse(documents.us.TypeBankCheckV1)
+
+# Print a brief summary of the parsed data
+print(result.document)
diff --git a/docs/predictions/constructed/index.rst b/docs/predictions/constructed/index.rst
@@ -1,6 +1,12 @@
 API Builder
 ###########
 
+
+**Sample Code:**
+
+.. literalinclude:: /extras/code_samples/custom_v1.txt
+    :language: Python
+
 Prediction
 ==========
 .. autoclass:: mindee.documents.CustomV1
diff --git a/docs/predictions/standard/documents/eu/license_plate_v1.rst b/docs/predictions/standard/documents/eu/license_plate_v1.rst
@@ -3,7 +3,7 @@ License Plate V1
 
 **Sample Code:**
 
-.. literalinclude:: /code_samples/eu/license_plate_v1.py
+.. literalinclude:: /extras/code_samples/eu/license_plate_v1.txt
     :language: Python
 
 .. autoclass:: mindee.documents.eu.LicensePlateV1
diff --git a/docs/predictions/standard/documents/financial_document_v1.rst b/docs/predictions/standard/documents/financial_document_v1.rst
@@ -1,4 +1,10 @@
 Financial Document V1
 ---------------------
+
+**Sample Code:**
+
+.. literalinclude:: /extras/code_samples/financial_document_v1.txt
+    :language: Python
+
 .. autoclass:: mindee.documents.FinancialDocumentV1
     :members:
diff --git a/docs/predictions/standard/documents/fr/bank_account_details_v1.rst b/docs/predictions/standard/documents/fr/bank_account_details_v1.rst
@@ -0,0 +1,10 @@
+Bank Account Details V1
+-----------------------
+
+**Sample Code:**
+
+.. literalinclude:: /extras/code_samples/fr/bank_account_details_v1.py
+    :language: Python
+
+.. autoclass:: mindee.documents.fr.BankAccountDetailsV1
+    :members:
diff --git a/docs/predictions/standard/documents/invoice_v3.rst b/docs/predictions/standard/documents/invoice_v3.rst
@@ -1,4 +1,10 @@
 Invoice V3
 ----------
+
+**Sample Code:**
+
+.. literalinclude:: /extras/code_samples/invoice_v3.txt
+    :language: Python
+
 .. autoclass:: mindee.documents.InvoiceV3
     :members:
diff --git a/docs/predictions/standard/documents/invoice_v4.rst b/docs/predictions/standard/documents/invoice_v4.rst
@@ -1,4 +1,10 @@
 Invoice V4
 ----------
+
+**Sample Code:**
+
+.. literalinclude:: /extras/code_samples/invoice_v4.txt
+    :language: Python
+
 .. autoclass:: mindee.documents.InvoiceV4
     :members:
diff --git a/docs/predictions/standard/documents/passport_v1.rst b/docs/predictions/standard/documents/passport_v1.rst
@@ -1,4 +1,10 @@
 Passport V1
 -----------
+
+**Sample Code:**
+
+.. literalinclude:: /extras/code_samples/passport_v1.txt
+    :language: Python
+
 .. autoclass:: mindee.documents.PassportV1
     :members:
diff --git a/docs/predictions/standard/documents/receipt_v3.rst b/docs/predictions/standard/documents/receipt_v3.rst
@@ -1,4 +1,10 @@
 Receipt V3
 ----------
+
+**Sample Code:**
+
+.. literalinclude:: /extras/code_samples/receipt_v3.txt
+    :language: Python
+
 .. autoclass:: mindee.documents.ReceiptV3
     :members:
diff --git a/docs/predictions/standard/documents/receipt_v4.rst b/docs/predictions/standard/documents/receipt_v4.rst
@@ -1,4 +1,10 @@
 Receipt V4
 ----------
+
+**Sample Code:**
+
+.. literalinclude:: /extras/code_samples/receipt_v4.txt
+    :language: Python
+
 .. autoclass:: mindee.documents.ReceiptV4
     :members:
diff --git a/docs/predictions/standard/documents/shipping_container_v1.rst b/docs/predictions/standard/documents/shipping_container_v1.rst
@@ -3,7 +3,7 @@ Shipping Container V1
 
 **Sample Code:**
 
-.. literalinclude:: /code_samples/shipping_container_v1.py
+.. literalinclude:: /extras/code_samples/shipping_container_v1.txt
     :language: Python
 
 .. autoclass:: mindee.documents.ShippingContainerV1
diff --git a/docs/predictions/standard/documents/us/bank_check_v1.rst b/docs/predictions/standard/documents/us/bank_check_v1.rst
@@ -1,6 +1,11 @@
 Bank Check V1
 -------------
 
+**Sample Code:**
+
+.. literalinclude:: /extras/code_samples/us/bank_check_v1.txt
+    :language: Python
+
 .. autoclass:: mindee.documents.us.BankCheckV1
     :members:
     :undoc-members:
diff --git a/docs/predictions/standard/fr.rst b/docs/predictions/standard/fr.rst
@@ -4,3 +4,4 @@ France
 .. include:: ./documents/fr/id_card_v1.rst
 .. include:: ./documents/fr/carte_vitale_v1.rst
 .. include:: ./documents/fr/carte_grise_v1.rst
+.. include:: ./documents/fr/bank_account_details_v1.rst
diff --git a/mindee/cli.py b/mindee/cli.py
@@ -66,6 +66,10 @@ class CommandConfig(Generic[TypeDoc]):
         help="FR ID Card",
         doc_class=documents.fr.TypeIdCardV1,
     ),
+    "fr-bank-account-details": CommandConfig(
+        help="FR Bank Account Details",
+        doc_class=documents.fr.TypeBankAccountDetailsV1,
+    ),
 }
 
 
diff --git a/mindee/client.py b/mindee/client.py
@@ -258,6 +258,11 @@ def _init_default_endpoints(self) -> None:
                 url_name="carte_vitale",
                 version="1",
             ),
+            ConfigSpec(
+                doc_class=documents.fr.BankAccountDetailsV1,
+                url_name="bank_account_details",
+                version="1",
+            ),
             ConfigSpec(
                 doc_class=documents.ShippingContainerV1,
                 url_name="shipping_containers",
diff --git a/mindee/documents/fr/__init__.py b/mindee/documents/fr/__init__.py
@@ -1,3 +1,7 @@
+from .bank_account_details.bank_account_details_v1 import (
+    BankAccountDetailsV1,
+    TypeBankAccountDetailsV1,
+)
 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
diff --git a/mindee/documents/fr/bank_account_details/__init__.py b/mindee/documents/fr/bank_account_details/__init__.py
diff --git a/mindee/documents/fr/bank_account_details/bank_account_details_v1.py b/mindee/documents/fr/bank_account_details/bank_account_details_v1.py
@@ -0,0 +1,73 @@
+from typing import Optional, TypeVar
+
+from mindee.documents.base import Document, TypeApiPrediction, clean_out_string
+from mindee.fields.text import TextField
+
+
+class BankAccountDetailsV1(Document):
+    """Bank Account Details v1 prediction results."""
+
+    iban: TextField
+    """The International Bank Account Number (IBAN)."""
+    account_holder_name: TextField
+    """The name of the account holder as seen on the document."""
+    swift: TextField
+    """The bank's SWIFT Business Identifier Code (BIC)."""
+
+    def __init__(
+        self,
+        api_prediction=None,
+        input_source=None,
+        page_n: Optional[int] = None,
+    ):
+        """
+        Bank Account Details 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="bank_account_details",
+            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.iban = TextField(
+            api_prediction["iban"],
+            page_n=page_n,
+        )
+        self.account_holder_name = TextField(
+            api_prediction["account_holder_name"],
+            page_n=page_n,
+        )
+        self.swift = TextField(
+            api_prediction["swift"],
+            page_n=page_n,
+        )
+
+    def __str__(self) -> str:
+        return clean_out_string(
+            "----- FR Bank Account Details V1 -----\n"
+            f"Filename: {self.filename or ''}\n"
+            f"IBAN: { self.iban }\n"
+            f"Account Holder's Name: { self.account_holder_name }\n"
+            f"SWIFT Code: { self.swift }\n"
+            "----------------------"
+        )
+
+
+TypeBankAccountDetailsV1 = TypeVar(
+    "TypeBankAccountDetailsV1", bound=BankAccountDetailsV1
+)
diff --git a/tests/data b/tests/data
@@ -1 +1 @@
-Subproject commit 23d4773247165be53c4a5efecdaffb72c0757a51
+Subproject commit 46e9cda689366b3ab9d05a2f23391b723ebd9310
diff --git a/tests/documents/fr/test_bank_account_details_v1.py b/tests/documents/fr/test_bank_account_details_v1.py
diff --git a/tests/test_cli.py b/tests/test_cli.py
