structocr 1.1.1__py3-none-any.whl

structocr/__init__.py

@@ -0,0 +1,3 @@
+from .client import StructOCR
+
+__all__ = ['StructOCR']

structocr/client.py

@@ -0,0 +1,92 @@
+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.0.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.
+        """
+        # 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_driver_license(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)

structocr-1.1.1.dist-info/METADATA

@@ -0,0 +1,92 @@
+Metadata-Version: 2.1
+Name: structocr
+Version: 1.1.1
+Summary: The official Python SDK for StructOCR API - Passport, ID card, Driver License OCR, and Invoice.
+Home-page: https://structocr.com
+Author: StructOCR Team
+Author-email: support@structocr.com
+Project-URL: Homepage, https://structocr.com
+Project-URL: Documentation, https://www.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)
+
+# 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 identity documents with high accuracy. This SDK helps you integrate **Passport OCR**, **National ID OCR**, and **Driver License OCR** into your Python applications in minutes.
+
+👉 **[Get your Free API Key here](https://structocr.com)**
+
+## Features
+
+- **Passport OCR API**: Instantly extract MRZ, name, DOB, and expiry date from passports of 200+ countries.
+- **National ID OCR**: Support for ID cards with automatic field mapping.
+- **Driver License OCR**: Extract vehicle class, license number, and personal details.
+- **Secure & Fast**: Enterprise-grade encryption and sub-second response times.
+
+## 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 a National ID or Driver License
+
+```python
+# 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')
+
+```
+
+## 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.6+
+* `requests` library
+
+## License
+
+MIT License. See [LICENSE](https://www.google.com/search?q=LICENSE) for details.

structocr-1.1.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+structocr/__init__.py,sha256=q0dim8G5HQBYxPY6nSv9zkz1UMbAsvmmTseENFBNubc,54
+structocr/client.py,sha256=vqXvJq-6_enyHEPvrmPsXpMRqBo0zhQ5tFLubmW6UN0,3012
+structocr-1.1.1.dist-info/METADATA,sha256=f9CS0F9gDXENgD6szMch9sRR_znZkF06oLCjgAlL25I,2860
+structocr-1.1.1.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
+structocr-1.1.1.dist-info/top_level.txt,sha256=r71IAG7a0LhuKvYrrZDO-2QVLYuT-Dzyle4k4gHFJQw,10
+structocr-1.1.1.dist-info/RECORD,,

structocr-1.1.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.38.4)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

structocr-1.1.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+structocr