structocr 1.4.0__tar.gz → 1.5.0__tar.gz

structocr-1.5.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 StructOCR
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

structocr-1.5.0/MANIFEST.in

@@ -0,0 +1,2 @@
+include LICENSE
+include README.md

structocr-1.5.0/PKG-INFO

@@ -0,0 +1,112 @@
+Metadata-Version: 2.4
+Name: structocr
+Version: 1.5.0
+Summary: Official Python SDK for StructOCR Base64 document APIs, including images, PDFs, and account balance.
+Home-page: https://structocr.com
+Author: StructOCR Team
+Author-email: support@structocr.com
+License: MIT
+Project-URL: Homepage, https://structocr.com
+Project-URL: Documentation, https://structocr.com/developers
+Project-URL: Source, https://github.com/dracula911/structocr-python
+Project-URL: Tracker, https://github.com/dracula911/structocr-python/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering :: Image Recognition
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# StructOCR Python SDK
+
+Official Python client for the [StructOCR API](https://structocr.com/developers).
+
+The SDK accepts a local JPG, PNG, WebP, or PDF path, plus in-memory `bytes`. It validates the decoded file locally, converts it to Base64, and sends the API's required JSON payload: `{"img": "..."}`. The REST API itself does not accept file paths, bytes, URLs, or multipart uploads.
+
+## Install
+
+```bash
+pip install --upgrade structocr
+```
+
+Python 3.7+ is required.
+
+## Quick start
+
+```bash
+export STRUCTOCR_API_KEY="YOUR_API_KEY"
+```
+
+```python
+from structocr import StructOCR
+
+client = StructOCR()
+result = client.scan_passport("./passport.jpg")
+
+if result.get("success"):
+    data = result["data"]
+    print(data.get("passport_number"))
+    print(data.get("given_names"), data.get("surname"))
+```
+
+PDF paths work the same way:
+
+```python
+result = client.scan_invoice("./invoice.pdf")
+```
+
+FastAPI and other server frameworks can pass uploaded bytes without a temporary file:
+
+```python
+content = await upload.read()
+result = client.scan_passport(content)
+```
+
+## Methods
+
+```text
+scan_passport(file)
+scan_national_id(file)
+scan_driver_license(file)
+scan_invoice(file)
+scan_receipt(file)
+scan_vin(file)
+scan_hin(file)
+scan_container(file)
+scan_license_plate(file)
+scan_vehicle_registration(file)
+scan_atm_cassette(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.
+
+## Configuration
+
+```python
+client = StructOCR(
+    api_key="YOUR_API_KEY",
+    base_url="https://api.structocr.com/v1",
+    timeout=60,
+)
+```
+
+See the [API documentation](https://structocr.com/developers) for endpoint-specific response schemas and error codes.
+
+## License
+
+MIT

structocr-1.5.0/README.md

@@ -0,0 +1,79 @@
+# StructOCR Python SDK
+
+Official Python client for the [StructOCR API](https://structocr.com/developers).
+
+The SDK accepts a local JPG, PNG, WebP, or PDF path, plus in-memory `bytes`. It validates the decoded file locally, converts it to Base64, and sends the API's required JSON payload: `{"img": "..."}`. The REST API itself does not accept file paths, bytes, URLs, or multipart uploads.
+
+## Install
+
+```bash
+pip install --upgrade structocr
+```
+
+Python 3.7+ is required.
+
+## Quick start
+
+```bash
+export STRUCTOCR_API_KEY="YOUR_API_KEY"
+```
+
+```python
+from structocr import StructOCR
+
+client = StructOCR()
+result = client.scan_passport("./passport.jpg")
+
+if result.get("success"):
+    data = result["data"]
+    print(data.get("passport_number"))
+    print(data.get("given_names"), data.get("surname"))
+```
+
+PDF paths work the same way:
+
+```python
+result = client.scan_invoice("./invoice.pdf")
+```
+
+FastAPI and other server frameworks can pass uploaded bytes without a temporary file:
+
+```python
+content = await upload.read()
+result = client.scan_passport(content)
+```
+
+## Methods
+
+```text
+scan_passport(file)
+scan_national_id(file)
+scan_driver_license(file)
+scan_invoice(file)
+scan_receipt(file)
+scan_vin(file)
+scan_hin(file)
+scan_container(file)
+scan_license_plate(file)
+scan_vehicle_registration(file)
+scan_atm_cassette(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.
+
+## Configuration
+
+```python
+client = StructOCR(
+    api_key="YOUR_API_KEY",
+    base_url="https://api.structocr.com/v1",
+    timeout=60,
+)
+```
+
+See the [API documentation](https://structocr.com/developers) for endpoint-specific response schemas and error codes.
+
+## License
+
+MIT

structocr-1.5.0/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"

{structocr-1.4.0 → structocr-1.5.0}/setup.py

@@ -1,11 +1,17 @@
 from setuptools import setup, find_packages
+from pathlib import Path
+
+
+ROOT = Path(__file__).parent
 
 setup(
     name="structocr",
-    version="1.4.0",
-    description="The official Python SDK for StructOCR API - Passport, ID card, Driver License OCR, Invoice, Receipts, VIN, HIN, License plate, and Container OCR.",
-    long_description=open("README.md").read(),
+    version="1.5.0",
+    description="Official Python SDK for StructOCR Base64 document APIs, including images, PDFs, and account balance.",
+    long_description=(ROOT / "README.md").read_text(encoding="utf-8"),
     long_description_content_type="text/markdown",
+    license="MIT",
+    license_files=("LICENSE",),
     
     author="StructOCR Team",
     author_email="support@structocr.com",
@@ -15,8 +21,8 @@ setup(
     project_urls={
         "Homepage": "https://structocr.com",
         "Documentation": "https://structocr.com/developers", 
-        "Source": "https://github.com/structocr/structocr-python",
-        "Tracker": "https://github.com/structocr/structocr-python/issues", 
+        "Source": "https://github.com/dracula911/structocr-python",
+        "Tracker": "https://github.com/dracula911/structocr-python/issues",
     },
 
     packages=find_packages(),
@@ -29,5 +35,5 @@ setup(
         "Operating System :: OS Independent",
         "Topic :: Scientific/Engineering :: Image Recognition",
     ],
-    python_requires='>=3.6',
-)
+    python_requires='>=3.7',
+)

structocr-1.5.0/structocr/__init__.py

@@ -0,0 +1,5 @@
+__version__ = "1.5.0"
+
+from .client import StructOCR
+
+__all__ = ['StructOCR']

structocr-1.5.0/structocr/client.py

@@ -0,0 +1,125 @@
+import base64
+import os
+from pathlib import Path
+from typing import Any, Dict, Optional, Union
+
+import requests
+
+
+FileInput = Union[str, os.PathLike, bytes, bytearray, memoryview]
+MAX_FILE_SIZE = int(4.5 * 1024 * 1024)
+SUPPORTED_FORMATS = "JPG, PNG, WebP, and PDF"
+
+
+class StructOCR:
+    """Official Python client for the StructOCR Base64 JSON API."""
+
+    def __init__(
+        self,
+        api_key: Optional[str] = None,
+        base_url: str = "https://api.structocr.com/v1",
+        timeout: float = 30.0,
+    ) -> None:
+        self.api_key = api_key or os.environ.get("STRUCTOCR_API_KEY")
+        if not self.api_key:
+            raise ValueError("API Key is required. Get one at https://structocr.com")
+
+        self.base_url = base_url.rstrip("/")
+        self.timeout = timeout
+        self.session = requests.Session()
+        self.session.headers.update({
+            "x-api-key": self.api_key,
+            "Content-Type": "application/json",
+            "User-Agent": "StructOCR-Python/1.5.0",
+        })
+
+    @staticmethod
+    def _read_file(file: FileInput) -> bytes:
+        if isinstance(file, (bytes, bytearray, memoryview)):
+            content = bytes(file)
+        else:
+            path = Path(file)
+            if not path.is_file():
+                raise FileNotFoundError(f"File not found: {path}")
+            content = path.read_bytes()
+
+        if not content:
+            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:
+            raise ValueError(f"Unsupported file format. Supported formats: {SUPPORTED_FORMATS}")
+        return content
+
+    @staticmethod
+    def _detect_mime(content: bytes) -> Optional[str]:
+        if content.startswith(b"%PDF"):
+            return "application/pdf"
+        if content.startswith(b"\xff\xd8\xff"):
+            return "image/jpeg"
+        if content.startswith(b"\x89PNG\r\n\x1a\n"):
+            return "image/png"
+        if len(content) >= 12 and content[:4] == b"RIFF" and content[8:12] == b"WEBP":
+            return "image/webp"
+        return None
+
+    def _post_image(self, endpoint: str, file: FileInput) -> Dict[str, Any]:
+        """Read a local file or bytes and send it as Base64 JSON in ``img``."""
+        content = self._read_file(file)
+        payload = {"img": base64.b64encode(content).decode("ascii")}
+
+        try:
+            response = self.session.post(
+                f"{self.base_url}/{endpoint}",
+                json=payload,
+                timeout=self.timeout,
+            )
+            response.raise_for_status()
+            return response.json()
+        except requests.exceptions.RequestException as error:
+            raise RuntimeError(f"API request failed: {error}") from error
+
+    def get_account_balance(self) -> Dict[str, Any]:
+        """Return account-level and current-key usage from ``/account/balance``."""
+        try:
+            response = self.session.get(
+                f"{self.base_url}/account/balance",
+                timeout=self.timeout,
+            )
+            response.raise_for_status()
+            return response.json()
+        except requests.exceptions.RequestException as error:
+            raise RuntimeError(f"API request failed: {error}") from error
+
+    def scan_passport(self, file: FileInput) -> Dict[str, Any]:
+        return self._post_image("passport", file)
+
+    def scan_national_id(self, file: FileInput) -> Dict[str, Any]:
+        return self._post_image("national-id", file)
+
+    def scan_driver_license(self, file: FileInput) -> Dict[str, Any]:
+        return self._post_image("driver-license", file)
+
+    def scan_invoice(self, file: FileInput) -> Dict[str, Any]:
+        return self._post_image("invoice", file)
+
+    def scan_vin(self, file: FileInput) -> Dict[str, Any]:
+        return self._post_image("vin", file)
+
+    def scan_container(self, file: FileInput) -> Dict[str, Any]:
+        return self._post_image("container", file)
+
+    def scan_hin(self, file: FileInput) -> Dict[str, Any]:
+        return self._post_image("hin", file)
+
+    def scan_receipt(self, file: FileInput) -> Dict[str, Any]:
+        return self._post_image("receipt", file)
+
+    def scan_license_plate(self, file: FileInput) -> Dict[str, Any]:
+        return self._post_image("license-plate", file)
+
+    def scan_vehicle_registration(self, file: FileInput) -> Dict[str, Any]:
+        return self._post_image("vehicle-registration", file)
+
+    def scan_atm_cassette(self, file: FileInput) -> Dict[str, Any]:
+        return self._post_image("atm-cassette", file)

structocr-1.5.0/structocr.egg-info/PKG-INFO

@@ -0,0 +1,112 @@
+Metadata-Version: 2.4
+Name: structocr
+Version: 1.5.0
+Summary: Official Python SDK for StructOCR Base64 document APIs, including images, PDFs, and account balance.
+Home-page: https://structocr.com
+Author: StructOCR Team
+Author-email: support@structocr.com
+License: MIT
+Project-URL: Homepage, https://structocr.com
+Project-URL: Documentation, https://structocr.com/developers
+Project-URL: Source, https://github.com/dracula911/structocr-python
+Project-URL: Tracker, https://github.com/dracula911/structocr-python/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering :: Image Recognition
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# StructOCR Python SDK
+
+Official Python client for the [StructOCR API](https://structocr.com/developers).
+
+The SDK accepts a local JPG, PNG, WebP, or PDF path, plus in-memory `bytes`. It validates the decoded file locally, converts it to Base64, and sends the API's required JSON payload: `{"img": "..."}`. The REST API itself does not accept file paths, bytes, URLs, or multipart uploads.
+
+## Install
+
+```bash
+pip install --upgrade structocr
+```
+
+Python 3.7+ is required.
+
+## Quick start
+
+```bash
+export STRUCTOCR_API_KEY="YOUR_API_KEY"
+```
+
+```python
+from structocr import StructOCR
+
+client = StructOCR()
+result = client.scan_passport("./passport.jpg")
+
+if result.get("success"):
+    data = result["data"]
+    print(data.get("passport_number"))
+    print(data.get("given_names"), data.get("surname"))
+```
+
+PDF paths work the same way:
+
+```python
+result = client.scan_invoice("./invoice.pdf")
+```
+
+FastAPI and other server frameworks can pass uploaded bytes without a temporary file:
+
+```python
+content = await upload.read()
+result = client.scan_passport(content)
+```
+
+## Methods
+
+```text
+scan_passport(file)
+scan_national_id(file)
+scan_driver_license(file)
+scan_invoice(file)
+scan_receipt(file)
+scan_vin(file)
+scan_hin(file)
+scan_container(file)
+scan_license_plate(file)
+scan_vehicle_registration(file)
+scan_atm_cassette(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.
+
+## Configuration
+
+```python
+client = StructOCR(
+    api_key="YOUR_API_KEY",
+    base_url="https://api.structocr.com/v1",
+    timeout=60,
+)
+```
+
+See the [API documentation](https://structocr.com/developers) for endpoint-specific response schemas and error codes.
+
+## License
+
+MIT

{structocr-1.4.0 → structocr-1.5.0}/structocr.egg-info/SOURCES.txt

@@ -1,4 +1,7 @@
+LICENSE
+MANIFEST.in
 README.md
+pyproject.toml
 setup.py
 structocr/__init__.py
 structocr/client.py

structocr-1.4.0/PKG-INFO

@@ -1,137 +0,0 @@
-Metadata-Version: 2.4
-Name: structocr
-Version: 1.4.0
-Summary: The official Python SDK for StructOCR API - Passport, ID card, Driver License OCR, Invoice, Receipts, VIN, HIN, License plate, and Container OCR.
-Home-page: https://structocr.com
-Author: StructOCR Team
-Author-email: support@structocr.com
-Project-URL: Homepage, https://structocr.com
-Project-URL: Documentation, https://structocr.com/developers
-Project-URL: Source, https://github.com/structocr/structocr-python
-Project-URL: Tracker, https://github.com/structocr/structocr-python/issues
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Topic :: Scientific/Engineering :: Image Recognition
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-Requires-Dist: requests>=2.25.0
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: project-url
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-# StructOCR Python SDK
-
-[![PyPI version](https://badge.fury.io/py/structocr.svg)](https://badge.fury.io/py/structocr)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-
-**The official Python client for [StructOCR](https://structocr.com).**
-
-StructOCR is a powerful API tailored for developers to extract structured data from complex documents and physical assets with high accuracy. This SDK helps you integrate **Passport OCR**, **National ID OCR**, **Driver License OCR**, **Invoice OCR**, **Receipt OCR**, **VIN OCR**, **HIN OCR**, **Container OCR**, and **License Plate OCR** into your Python applications in minutes.
-
-👉 **[Get your Free API Key here](https://structocr.com)**
-
------
-
-## 🚀 What's New in 1.4.0
-
-* **License Plate OCR**: We've launched a specialized ALPR engine optimized for SEA plates. It accurately extracts native scripts (Thai, Khmer, etc.), plate numbers, colors, and vehicle types without forcing foreign formatting rules.
-* *Previous updates (Hybrid VIZ + MRZ AI for National IDs, marine & expense additions) remain fully supported.*
-
-Check out the [Quick Start](#quick-start) below to see how easy it is to use them!
-
------
-
-## Features
-
-  - **Passport OCR API**: Instantly extract MRZ, name, DOB, and expiry date from passports of 200+ countries.
-  - **National ID OCR**: Extract regional specific fields (CNP, CPF, NIN) and raw ICAO 9303 MRZ lines with hybrid validation.
-  - **Driver License OCR**: Extract vehicle class, license number, and personal details.
-  - **License Plate OCR**: Extract SEA-optimized plate numbers, regional texts, plate colors, and vehicle types.
-  - **Invoice OCR**: Extract invoice number, currency, merchant, customer, and financial totals.
-  - **Receipt OCR**: Extract merchants, dates, line items, taxes, and totals for expense management.
-  - **VIN OCR**: Extract VIN (Vehicle Identification Number) from windshield or engine bay images.
-  - **HIN OCR**: Validate and extract Hull Identification Numbers from marine vessels.
-  - **Container OCR**: Extract shipping container numbers accurately from images.
-  - **Secure & Fast**: Enterprise-grade encryption, SOC2 compliance, and sub-second response times with zero data retention.
-
-## Installation
-
-Install the package via pip:
-
-```bash
-pip install structocr
-
-```
-
-## Quick Start
-
-### 1. Initialize the Client
-
-```python
-from structocr import StructOCR
-
-# Initialize with your API Key
-client = StructOCR(api_key="sk_live_xxxxxxxx")
-
-```
-
-### 2. Scan a Passport (Passport OCR)
-
-```python
-# Pass the path to the passport image file
-result = client.scan_passport('./docs/passport_sample.jpg')
-
-print(f"Name: {result['data']['name']}")
-print(f"Passport Number: {result['data']['document_number']}")
-
-```
-
-### 3. Scan Other Documents and Assets
-
-```python
-# License Plate OCR (New in 1.4.0)
-plate_data = client.scan_license_plate('./docs/license_plate.jpg')
-
-# National ID OCR
-id_data = client.scan_national_id('./docs/id_card.png')
-
-# Driver License OCR
-license_data = client.scan_driver_license('./docs/license.jpg')
-
-# Invoice OCR
-invoice_data = client.scan_invoice('./docs/invoice.jpg')
-
-# Receipt OCR
-receipt_data = client.scan_receipt('./docs/receipt.jpg')
-
-# VIN OCR
-vin_data = client.scan_vin('./docs/vin.jpg')
-
-# HIN OCR
-hin_data = client.scan_hin('./docs/boat_hin.jpg')
-
-# Container OCR
-container_data = client.scan_container('./docs/container.jpg')
-
-```
-
-## Documentation
-
-For full API documentation, response examples, and error codes, please visit the [StructOCR Developer Docs](https://www.structocr.com/developers?ref=github).
-
-## Requirements
-
-* Python 3.7+
-* `requests` library
-
-## License
-
-MIT License. See [LICENSE](https://opensource.org/licenses/MIT) for details.

structocr-1.4.0/README.md

@@ -1,108 +0,0 @@
-# StructOCR Python SDK
-
-[![PyPI version](https://badge.fury.io/py/structocr.svg)](https://badge.fury.io/py/structocr)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-
-**The official Python client for [StructOCR](https://structocr.com).**
-
-StructOCR is a powerful API tailored for developers to extract structured data from complex documents and physical assets with high accuracy. This SDK helps you integrate **Passport OCR**, **National ID OCR**, **Driver License OCR**, **Invoice OCR**, **Receipt OCR**, **VIN OCR**, **HIN OCR**, **Container OCR**, and **License Plate OCR** into your Python applications in minutes.
-
-👉 **[Get your Free API Key here](https://structocr.com)**
-
------
-
-## 🚀 What's New in 1.4.0
-
-* **License Plate OCR**: We've launched a specialized ALPR engine optimized for SEA plates. It accurately extracts native scripts (Thai, Khmer, etc.), plate numbers, colors, and vehicle types without forcing foreign formatting rules.
-* *Previous updates (Hybrid VIZ + MRZ AI for National IDs, marine & expense additions) remain fully supported.*
-
-Check out the [Quick Start](#quick-start) below to see how easy it is to use them!
-
------
-
-## Features
-
-  - **Passport OCR API**: Instantly extract MRZ, name, DOB, and expiry date from passports of 200+ countries.
-  - **National ID OCR**: Extract regional specific fields (CNP, CPF, NIN) and raw ICAO 9303 MRZ lines with hybrid validation.
-  - **Driver License OCR**: Extract vehicle class, license number, and personal details.
-  - **License Plate OCR**: Extract SEA-optimized plate numbers, regional texts, plate colors, and vehicle types.
-  - **Invoice OCR**: Extract invoice number, currency, merchant, customer, and financial totals.
-  - **Receipt OCR**: Extract merchants, dates, line items, taxes, and totals for expense management.
-  - **VIN OCR**: Extract VIN (Vehicle Identification Number) from windshield or engine bay images.
-  - **HIN OCR**: Validate and extract Hull Identification Numbers from marine vessels.
-  - **Container OCR**: Extract shipping container numbers accurately from images.
-  - **Secure & Fast**: Enterprise-grade encryption, SOC2 compliance, and sub-second response times with zero data retention.
-
-## Installation
-
-Install the package via pip:
-
-```bash
-pip install structocr
-
-```
-
-## Quick Start
-
-### 1. Initialize the Client
-
-```python
-from structocr import StructOCR
-
-# Initialize with your API Key
-client = StructOCR(api_key="sk_live_xxxxxxxx")
-
-```
-
-### 2. Scan a Passport (Passport OCR)
-
-```python
-# Pass the path to the passport image file
-result = client.scan_passport('./docs/passport_sample.jpg')
-
-print(f"Name: {result['data']['name']}")
-print(f"Passport Number: {result['data']['document_number']}")
-
-```
-
-### 3. Scan Other Documents and Assets
-
-```python
-# License Plate OCR (New in 1.4.0)
-plate_data = client.scan_license_plate('./docs/license_plate.jpg')
-
-# National ID OCR
-id_data = client.scan_national_id('./docs/id_card.png')
-
-# Driver License OCR
-license_data = client.scan_driver_license('./docs/license.jpg')
-
-# Invoice OCR
-invoice_data = client.scan_invoice('./docs/invoice.jpg')
-
-# Receipt OCR
-receipt_data = client.scan_receipt('./docs/receipt.jpg')
-
-# VIN OCR
-vin_data = client.scan_vin('./docs/vin.jpg')
-
-# HIN OCR
-hin_data = client.scan_hin('./docs/boat_hin.jpg')
-
-# Container OCR
-container_data = client.scan_container('./docs/container.jpg')
-
-```
-
-## Documentation
-
-For full API documentation, response examples, and error codes, please visit the [StructOCR Developer Docs](https://www.structocr.com/developers?ref=github).
-
-## Requirements
-
-* Python 3.7+
-* `requests` library
-
-## License
-
-MIT License. See [LICENSE](https://opensource.org/licenses/MIT) for details.

structocr-1.4.0/structocr/__init__.py

@@ -1,5 +0,0 @@
-__version__ = "1.4.0"
-
-from .client import StructOCR
-
-__all__ = ['StructOCR']

structocr-1.4.0/structocr/client.py

@@ -1,138 +0,0 @@
-import requests
-import os
-import base64
-import json
-
-class StructOCR:
-    """
-    StructOCR Python Client
-    Get your API Key at: https://structocr.com
-    """
-    def __init__(self, api_key=None, base_url="https://api.structocr.com/v1"):
-        # Allow reading API Key from environment variables for better DX
-        self.api_key = api_key or os.environ.get('STRUCTOCR_API_KEY')
-        if not self.api_key:
-            raise ValueError("API Key is required. Get one at https://structocr.com")
-        
-        self.base_url = base_url.rstrip('/')
-        self.session = requests.Session()
-        
-        # Updated headers based on your API specification
-        self.session.headers.update({
-            "x-api-key": self.api_key,
-            "Content-Type": "application/json",
-            "User-Agent": "StructOCR-Python/1.4.0"
-        })
-
-    def _post_image(self, endpoint, file_path):
-        """
-        Internal method: Handle image encoding and API request.
-        """
-        url = f"{self.base_url}/{endpoint}"
-        
-        if not os.path.exists(file_path):
-            raise FileNotFoundError(f"File not found: {file_path}")
-
-        try:
-            # 1. Encode image to Base64
-            with open(file_path, "rb") as image_file:
-                base64_image = base64.b64encode(image_file.read()).decode('utf-8')
-
-            # 2. Prepare JSON payload
-            payload = {
-                "img": base64_image
-            }
-
-            # 3. Send Request
-            response = self.session.post(url, json=payload)
-            response.raise_for_status() # Raise error for 4xx/5xx responses
-            
-            return response.json()
-            
-        except requests.exceptions.RequestException as e:
-            # Handle connection errors or API errors
-            raise Exception(f"API Request failed: {str(e)}")
-
-    # --- Public Methods for Developers ---
-
-    def scan_passport(self, file_path):
-        """
-        Scan a Passport image.
-        path: Path to the passport image file.
-        Returns: Structured JSON data.
-        """
-        # Endpoint: /v1/passport
-        return self._post_image('passport', file_path)
-
-    def scan_national_id(self, file_path):
-        """
-        Scan a National ID card.
-        path: Path to the ID card image file.
-        Returns: Structured JSON data.
-                 Note: MRZ lines (if present) are located inside the 'additional_fields' object.
-        """
-        # Endpoint: /v1/national-id 
-        return self._post_image('national-id', file_path)
-
-    def scan_driver_license(self, file_path):
-        """
-        Scan a Driver License.
-        path: Path to the driver license image file.
-        Returns: Structured JSON data.
-        """
-        # Endpoint: /v1/driver-license
-        return self._post_image('driver-license', file_path)
-    
-    def scan_invoice(self, file_path):
-        """
-        Scan a Invoice.
-        path: Path to the invoice image file.
-        Returns: Structured JSON data.
-        """
-        # Endpoint: /v1/invoice 
-        return self._post_image('invoice', file_path)
-
-    def scan_vin(self, file_path):
-        """
-        Scan a VIN (Vehicle Identification Number).
-        path: Path to the VIN image file.
-        Returns: Structured JSON data.
-        """
-        # Endpoint: /v1/vin 
-        return self._post_image('vin', file_path)
-
-    def scan_container(self, file_path):
-        """
-        Scan a shipping container number.
-        path: Path to the container image file.
-        Returns: Structured JSON data.
-        """
-        # Endpoint: /v1/container 
-        return self._post_image('container', file_path)
-
-    def scan_hin(self, file_path):
-        """
-        Scan a Hull Identification Number (HIN) from a boat or watercraft.
-        path: Path to the HIN image file.
-        Returns: Structured JSON data.
-        """
-        # Endpoint: /v1/hin 
-        return self._post_image('hin', file_path)
-
-    def scan_receipt(self, file_path):
-        """
-        Scan a Retail/Dining Receipt for expense extraction.
-        path: Path to the receipt image file.
-        Returns: Structured JSON data.
-        """
-        # Endpoint: /v1/receipt 
-        return self._post_image('receipt', file_path)
-    
-    def scan_license_plate(self, file_path):
-        """
-        Scan a Vehicle License Plate (Optimized for Southeast Asia).
-        path: Path to the license plate image file.
-        Returns: Structured JSON data including plate_number, region_text, plate_color, etc.
-        """
-        # Endpoint: /v1/license-plate
-        return self._post_image('license-plate', file_path)

structocr-1.4.0/structocr.egg-info/PKG-INFO

@@ -1,137 +0,0 @@
-Metadata-Version: 2.4
-Name: structocr
-Version: 1.4.0
-Summary: The official Python SDK for StructOCR API - Passport, ID card, Driver License OCR, Invoice, Receipts, VIN, HIN, License plate, and Container OCR.
-Home-page: https://structocr.com
-Author: StructOCR Team
-Author-email: support@structocr.com
-Project-URL: Homepage, https://structocr.com
-Project-URL: Documentation, https://structocr.com/developers
-Project-URL: Source, https://github.com/structocr/structocr-python
-Project-URL: Tracker, https://github.com/structocr/structocr-python/issues
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Topic :: Scientific/Engineering :: Image Recognition
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-Requires-Dist: requests>=2.25.0
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: project-url
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-# StructOCR Python SDK
-
-[![PyPI version](https://badge.fury.io/py/structocr.svg)](https://badge.fury.io/py/structocr)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-
-**The official Python client for [StructOCR](https://structocr.com).**
-
-StructOCR is a powerful API tailored for developers to extract structured data from complex documents and physical assets with high accuracy. This SDK helps you integrate **Passport OCR**, **National ID OCR**, **Driver License OCR**, **Invoice OCR**, **Receipt OCR**, **VIN OCR**, **HIN OCR**, **Container OCR**, and **License Plate OCR** into your Python applications in minutes.
-
-👉 **[Get your Free API Key here](https://structocr.com)**
-
------
-
-## 🚀 What's New in 1.4.0
-
-* **License Plate OCR**: We've launched a specialized ALPR engine optimized for SEA plates. It accurately extracts native scripts (Thai, Khmer, etc.), plate numbers, colors, and vehicle types without forcing foreign formatting rules.
-* *Previous updates (Hybrid VIZ + MRZ AI for National IDs, marine & expense additions) remain fully supported.*
-
-Check out the [Quick Start](#quick-start) below to see how easy it is to use them!
-
------
-
-## Features
-
-  - **Passport OCR API**: Instantly extract MRZ, name, DOB, and expiry date from passports of 200+ countries.
-  - **National ID OCR**: Extract regional specific fields (CNP, CPF, NIN) and raw ICAO 9303 MRZ lines with hybrid validation.
-  - **Driver License OCR**: Extract vehicle class, license number, and personal details.
-  - **License Plate OCR**: Extract SEA-optimized plate numbers, regional texts, plate colors, and vehicle types.
-  - **Invoice OCR**: Extract invoice number, currency, merchant, customer, and financial totals.
-  - **Receipt OCR**: Extract merchants, dates, line items, taxes, and totals for expense management.
-  - **VIN OCR**: Extract VIN (Vehicle Identification Number) from windshield or engine bay images.
-  - **HIN OCR**: Validate and extract Hull Identification Numbers from marine vessels.
-  - **Container OCR**: Extract shipping container numbers accurately from images.
-  - **Secure & Fast**: Enterprise-grade encryption, SOC2 compliance, and sub-second response times with zero data retention.
-
-## Installation
-
-Install the package via pip:
-
-```bash
-pip install structocr
-
-```
-
-## Quick Start
-
-### 1. Initialize the Client
-
-```python
-from structocr import StructOCR
-
-# Initialize with your API Key
-client = StructOCR(api_key="sk_live_xxxxxxxx")
-
-```
-
-### 2. Scan a Passport (Passport OCR)
-
-```python
-# Pass the path to the passport image file
-result = client.scan_passport('./docs/passport_sample.jpg')
-
-print(f"Name: {result['data']['name']}")
-print(f"Passport Number: {result['data']['document_number']}")
-
-```
-
-### 3. Scan Other Documents and Assets
-
-```python
-# License Plate OCR (New in 1.4.0)
-plate_data = client.scan_license_plate('./docs/license_plate.jpg')
-
-# National ID OCR
-id_data = client.scan_national_id('./docs/id_card.png')
-
-# Driver License OCR
-license_data = client.scan_driver_license('./docs/license.jpg')
-
-# Invoice OCR
-invoice_data = client.scan_invoice('./docs/invoice.jpg')
-
-# Receipt OCR
-receipt_data = client.scan_receipt('./docs/receipt.jpg')
-
-# VIN OCR
-vin_data = client.scan_vin('./docs/vin.jpg')
-
-# HIN OCR
-hin_data = client.scan_hin('./docs/boat_hin.jpg')
-
-# Container OCR
-container_data = client.scan_container('./docs/container.jpg')
-
-```
-
-## Documentation
-
-For full API documentation, response examples, and error codes, please visit the [StructOCR Developer Docs](https://www.structocr.com/developers?ref=github).
-
-## Requirements
-
-* Python 3.7+
-* `requests` library
-
-## License
-
-MIT License. See [LICENSE](https://opensource.org/licenses/MIT) for details.