structocr 1.6.0__tar.gz → 1.7.0__tar.gz

{structocr-1.6.0/structocr.egg-info → structocr-1.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: structocr
-Version: 1.6.0
+Version: 1.7.0
 Summary: Official Python SDK for StructOCR Base64 document APIs, including images, PDFs, and account balance.
 Home-page: https://structocr.com
 Author: StructOCR Team
@@ -82,6 +82,7 @@ result = client.scan_passport(content)
 scan_passport(file)
 scan_national_id(file)
 scan_driver_license(file)
+scan_driver_license_pdf417(file)
 scan_invoice(file)
 scan_receipt(file)
 scan_vin(file)
@@ -94,18 +95,27 @@ scan_weighbridge_ticket(file)
 get_account_balance()
 ```
 
-All document methods accept a local path or bytes. Supported decoded formats are JPG, PNG, WebP, and PDF, up to 4.5MB.
+All document methods accept a local path or bytes, up to 4.5MB. Most methods support JPG, PNG, WebP, and PDF. `scan_driver_license_pdf417` accepts JPG, PNG, and WebP only.
 
-Receipt v2 provides a richer response. Enhanced accuracy requires v2 and costs 2 credits instead of the standard 1 credit:
+The Receipt endpoint returns v2 by default. Enhanced accuracy costs 2 credits instead of the standard 1 credit and is enabled with the `accuracy` parameter:
 
 ```python
 receipt = client.scan_receipt(
     "./receipt.jpg",
-    response_version=2,
     accuracy="enhanced",
 )
 ```
 
+`response_version=2` remains accepted for compatibility but is not required. Receipt v1 is retired.
+
+US driver license PDF417 example:
+
+```python
+result = client.scan_driver_license_pdf417("./license-back.jpg")
+if result.get("success"):
+    print(result["data"]["document_number"])
+```
+
 Weighbridge ticket example:
 
 ```python

{structocr-1.6.0 → structocr-1.7.0}/README.md

@@ -49,6 +49,7 @@ result = client.scan_passport(content)
 scan_passport(file)
 scan_national_id(file)
 scan_driver_license(file)
+scan_driver_license_pdf417(file)
 scan_invoice(file)
 scan_receipt(file)
 scan_vin(file)
@@ -61,18 +62,27 @@ scan_weighbridge_ticket(file)
 get_account_balance()
 ```
 
-All document methods accept a local path or bytes. Supported decoded formats are JPG, PNG, WebP, and PDF, up to 4.5MB.
+All document methods accept a local path or bytes, up to 4.5MB. Most methods support JPG, PNG, WebP, and PDF. `scan_driver_license_pdf417` accepts JPG, PNG, and WebP only.
 
-Receipt v2 provides a richer response. Enhanced accuracy requires v2 and costs 2 credits instead of the standard 1 credit:
+The Receipt endpoint returns v2 by default. Enhanced accuracy costs 2 credits instead of the standard 1 credit and is enabled with the `accuracy` parameter:
 
 ```python
 receipt = client.scan_receipt(
     "./receipt.jpg",
-    response_version=2,
     accuracy="enhanced",
 )
 ```
 
+`response_version=2` remains accepted for compatibility but is not required. Receipt v1 is retired.
+
+US driver license PDF417 example:
+
+```python
+result = client.scan_driver_license_pdf417("./license-back.jpg")
+if result.get("success"):
+    print(result["data"]["document_number"])
+```
+
 Weighbridge ticket example:
 
 ```python

{structocr-1.6.0 → structocr-1.7.0}/structocr/client.py

@@ -11,6 +11,7 @@ from .version import __version__
 FileInput = Union[str, os.PathLike, bytes, bytearray, memoryview]
 MAX_FILE_SIZE = int(4.5 * 1024 * 1024)
 SUPPORTED_FORMATS = "JPG, PNG, WebP, and PDF"
+IMAGE_ONLY_FORMATS = "JPG, PNG, and WebP"
 RETRYABLE_STATUS_CODES = {429, 502, 503, 504}
 
 
@@ -56,7 +57,7 @@ class StructOCR:
         })
 
     @staticmethod
-    def _read_file(file: FileInput) -> bytes:
+    def _read_file(file: FileInput, *, allow_pdf: bool = True) -> bytes:
         if isinstance(file, (bytes, bytearray, memoryview)):
             content = bytes(file)
         else:
@@ -69,8 +70,11 @@ class StructOCR:
             raise ValueError("File is empty")
         if len(content) > MAX_FILE_SIZE:
             raise ValueError("File exceeds the maximum allowed size of 4.5MB")
-        if StructOCR._detect_mime(content) is None:
+        mime_type = StructOCR._detect_mime(content)
+        if mime_type is None:
             raise ValueError(f"Unsupported file format. Supported formats: {SUPPORTED_FORMATS}")
+        if not allow_pdf and mime_type == "application/pdf":
+            raise ValueError(f"Unsupported file format. Supported formats: {IMAGE_ONLY_FORMATS}")
         return content
 
     @staticmethod
@@ -132,9 +136,11 @@ class StructOCR:
         endpoint: str,
         file: FileInput,
         params: Optional[Dict[str, Any]] = None,
+        *,
+        allow_pdf: bool = True,
     ) -> Dict[str, Any]:
         """Read a local file or bytes and send it as Base64 JSON in ``img``."""
-        content = self._read_file(file)
+        content = self._read_file(file, allow_pdf=allow_pdf)
         payload = {"img": base64.b64encode(content).decode("ascii")}
 
         try:
@@ -182,6 +188,9 @@ class StructOCR:
     def scan_driver_license(self, file: FileInput) -> Dict[str, Any]:
         return self._post_image("driver-license", file)
 
+    def scan_driver_license_pdf417(self, file: FileInput) -> Dict[str, Any]:
+        return self._post_image("driver-license-pdf417", file, allow_pdf=False)
+
     def scan_invoice(self, file: FileInput) -> Dict[str, Any]:
         return self._post_image("invoice", file)
 
@@ -197,27 +206,30 @@ class StructOCR:
     def scan_receipt(
         self,
         file: FileInput,
-        response_version: int = 1,
+        response_version: Optional[int] = None,
         accuracy: str = "standard",
     ) -> Dict[str, Any]:
-        if response_version not in (1, 2):
-            raise StructOCRError("response_version must be 1 or 2", code="INVALID_OPTIONS")
-        if accuracy not in ("standard", "enhanced"):
+        if response_version not in (None, 2):
             raise StructOCRError(
-                'accuracy must be "standard" or "enhanced"',
+                "response_version must be 2 when provided; Receipt v1 is retired",
                 code="INVALID_OPTIONS",
             )
-        if accuracy == "enhanced" and response_version != 2:
+        if accuracy not in ("standard", "enhanced"):
             raise StructOCRError(
-                "Enhanced accuracy requires response_version=2",
+                'accuracy must be "standard" or "enhanced"',
                 code="INVALID_OPTIONS",
             )
-        if response_version == 1 and accuracy == "standard":
+        if accuracy == "standard" and response_version is None:
             return self._post_image("receipt", file)
+        params: Dict[str, Any] = {}
+        if response_version == 2:
+            params["response_version"] = 2
+        if accuracy == "enhanced":
+            params["accuracy"] = "enhanced"
         return self._post_image(
             "receipt",
             file,
-            params={"response_version": response_version, "accuracy": accuracy},
+            params=params,
         )
 
     def scan_license_plate(self, file: FileInput) -> Dict[str, Any]:

structocr-1.7.0/structocr/version.py

@@ -0,0 +1 @@
+__version__ = "1.7.0"

{structocr-1.6.0 → structocr-1.7.0/structocr.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: structocr
-Version: 1.6.0
+Version: 1.7.0
 Summary: Official Python SDK for StructOCR Base64 document APIs, including images, PDFs, and account balance.
 Home-page: https://structocr.com
 Author: StructOCR Team
@@ -82,6 +82,7 @@ result = client.scan_passport(content)
 scan_passport(file)
 scan_national_id(file)
 scan_driver_license(file)
+scan_driver_license_pdf417(file)
 scan_invoice(file)
 scan_receipt(file)
 scan_vin(file)
@@ -94,18 +95,27 @@ scan_weighbridge_ticket(file)
 get_account_balance()
 ```
 
-All document methods accept a local path or bytes. Supported decoded formats are JPG, PNG, WebP, and PDF, up to 4.5MB.
+All document methods accept a local path or bytes, up to 4.5MB. Most methods support JPG, PNG, WebP, and PDF. `scan_driver_license_pdf417` accepts JPG, PNG, and WebP only.
 
-Receipt v2 provides a richer response. Enhanced accuracy requires v2 and costs 2 credits instead of the standard 1 credit:
+The Receipt endpoint returns v2 by default. Enhanced accuracy costs 2 credits instead of the standard 1 credit and is enabled with the `accuracy` parameter:
 
 ```python
 receipt = client.scan_receipt(
     "./receipt.jpg",
-    response_version=2,
     accuracy="enhanced",
 )
 ```
 
+`response_version=2` remains accepted for compatibility but is not required. Receipt v1 is retired.
+
+US driver license PDF417 example:
+
+```python
+result = client.scan_driver_license_pdf417("./license-back.jpg")
+if result.get("success"):
+    print(result["data"]["document_number"])
+```
+
 Weighbridge ticket example:
 
 ```python

structocr-1.6.0/structocr/version.py

@@ -1 +0,0 @@
-__version__ = "1.6.0"