structocr 1.1.6__tar.gz → 1.3.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. {structocr-1.1.6 → structocr-1.3.0}/PKG-INFO +32 -24
  2. structocr-1.3.0/README.md +101 -0
  3. {structocr-1.1.6 → structocr-1.3.0}/setup.py +3 -3
  4. structocr-1.3.0/structocr/__init__.py +5 -0
  5. {structocr-1.1.6 → structocr-1.3.0}/structocr/client.py +21 -2
  6. {structocr-1.1.6 → structocr-1.3.0}/structocr.egg-info/PKG-INFO +32 -24
  7. structocr-1.1.6/README.md +0 -93
  8. structocr-1.1.6/structocr/__init__.py +0 -5
  9. {structocr-1.1.6 → structocr-1.3.0}/setup.cfg +0 -0
  10. {structocr-1.1.6 → structocr-1.3.0}/structocr.egg-info/SOURCES.txt +0 -0
  11. {structocr-1.1.6 → structocr-1.3.0}/structocr.egg-info/dependency_links.txt +0 -0
  12. {structocr-1.1.6 → structocr-1.3.0}/structocr.egg-info/requires.txt +0 -0
  13. {structocr-1.1.6 → structocr-1.3.0}/structocr.egg-info/top_level.txt +0 -0
{structocr-1.1.6 → structocr-1.3.0}/PKG-INFO RENAMED
@@ -1,12 +1,12 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: structocr
3
- Version: 1.1.6
4
- Summary: The official Python SDK for StructOCR API - Passport, ID card, Driver License OCR, Invoice, VIN and Container OCR.
3
+ Version: 1.3.0
4
+ Summary: The official Python SDK for StructOCR API - Passport, ID card, Driver License OCR, Invoice, Receipts, VIN, HIN and Container OCR.
5
5
  Home-page: https://structocr.com
6
6
  Author: StructOCR Team
7
7
  Author-email: support@structocr.com
8
8
  Project-URL: Homepage, https://structocr.com
9
- Project-URL: Documentation, https://www.structocr.com/developers
9
+ Project-URL: Documentation, https://structocr.com/developers
10
10
  Project-URL: Source, https://github.com/structocr/structocr-python
11
11
  Project-URL: Tracker, https://github.com/structocr/structocr-python/issues
12
12
  Classifier: Programming Language :: Python :: 3
@@ -34,31 +34,33 @@ Dynamic: summary
34
34
 
35
35
  **The official Python client for [StructOCR](https://structocr.com).**
36
36
 
37
- 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**, **Driver License OCR**, **Invoice OCR**, **VIN OCR**, and **Container OCR** into your Python applications in minutes.
37
+ 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**, and **Container OCR** into your Python applications in minutes.
38
38
 
39
39
  👉 **[Get your Free API Key here](https://structocr.com)**
40
40
 
41
- ---
41
+ -----
42
42
 
43
- ## 🚀 What's New in 1.1.6
44
- We've massively expanded our logistics and finance capabilities! The SDK now natively supports:
45
- * **Container OCR**: Accurately parse shipping container numbers from images.
46
- * **VIN OCR**: Read Vehicle Identification Numbers from windshields or chassis.
47
- * **Invoice OCR**: Automatically extract invoice numbers, currencies, merchants, and customers.
43
+ ## 🚀 What's New in 1.3.0
48
44
 
49
- Check out the [Quick Start](#3-scan-a-national-id-driver-license-invoice-vin-or-container) below to see how easy it is to use them!
45
+ We've massively upgraded our Identity Verification engine!
46
+ * **Hybrid VIZ + MRZ AI for National IDs**: The SDK now automatically cross-validates unstructured Visual Zone (VIZ) data against cryptographic Machine Readable Zone (MRZ) checksums (TD1/TD2) for zero hallucination. Raw MRZ lines are now accessible via `additional_fields`.
47
+ * *Previous marine & expense additions (Receipt OCR, HIN OCR, Container OCR) remain fully supported.*
50
48
 
51
- ---
49
+ Check out the [Quick Start](#quick-start) below to see how easy it is to use them!
50
+
51
+ -----
52
52
 
53
53
  ## Features
54
54
 
55
- - **Passport OCR API**: Instantly extract MRZ, name, DOB, and expiry date from passports of 200+ countries.
56
- - **National ID OCR**: Support for ID cards with automatic field mapping.
57
- - **Driver License OCR**: Extract vehicle class, license number, and personal details.
58
- - **Invoice OCR**: Extract invoice number, currency, merchant, customer.
59
- - **VIN OCR**: Extract VIN (Vehicle Identification Number) from windshield or engine bay images.
60
- - **Container OCR**: Extract shipping container numbers accurately from images.
61
- - **Secure & Fast**: Enterprise-grade encryption and sub-second response times.
55
+ - **Passport OCR API**: Instantly extract MRZ, name, DOB, and expiry date from passports of 200+ countries.
56
+ - **National ID OCR**: Extract regional specific fields (CNP, CPF, NIN) and raw ICAO 9303 MRZ lines with hybrid validation.
57
+ - **Driver License OCR**: Extract vehicle class, license number, and personal details.
58
+ - **Invoice OCR**: Extract invoice number, currency, merchant, customer, and financial totals.
59
+ - **Receipt OCR**: Extract merchants, dates, line items, taxes, and totals for expense management.
60
+ - **VIN OCR**: Extract VIN (Vehicle Identification Number) from windshield or engine bay images.
61
+ - **HIN OCR**: Validate and extract Hull Identification Numbers from marine vessels.
62
+ - **Container OCR**: Extract shipping container numbers accurately from images.
63
+ - **Secure & Fast**: Enterprise-grade encryption, SOC2 compliance, and sub-second response times with zero data retention.
62
64
 
63
65
  ## Installation
64
66
 
@@ -70,7 +72,7 @@ pip install structocr
70
72
 
71
73
  ## Quick Start
72
74
 
73
- ### 1. Initialize the Client
75
+ ### 1\. Initialize the Client
74
76
 
75
77
  ```python
76
78
  from structocr import StructOCR
@@ -79,7 +81,7 @@ from structocr import StructOCR
79
81
  client = StructOCR(api_key="sk_live_xxxxxxxx")
80
82
  ```
81
83
 
82
- ### 2. Scan a Passport (Passport OCR)
84
+ ### 2\. Scan a Passport (Passport OCR)
83
85
 
84
86
  ```python
85
87
  # Pass the path to the passport image file
@@ -89,7 +91,7 @@ print(f"Name: {result['data']['name']}")
89
91
  print(f"Passport Number: {result['data']['document_number']}")
90
92
  ```
91
93
 
92
- ### 3. Scan a National ID, Driver License, Invoice, VIN, or Container
94
+ ### 3\. Scan Other Documents and Assets
93
95
 
94
96
  ```python
95
97
  # National ID OCR
@@ -101,9 +103,15 @@ license_data = client.scan_driver_license('./docs/license.jpg')
101
103
  # Invoice OCR
102
104
  invoice_data = client.scan_invoice('./docs/invoice.jpg')
103
105
 
106
+ # Receipt OCR (New in 1.2.0)
107
+ receipt_data = client.scan_receipt('./docs/receipt.jpg')
108
+
104
109
  # VIN OCR
105
110
  vin_data = client.scan_vin('./docs/vin.jpg')
106
111
 
112
+ # HIN OCR (New in 1.2.0)
113
+ hin_data = client.scan_hin('./docs/boat_hin.jpg')
114
+
107
115
  # Container OCR
108
116
  container_data = client.scan_container('./docs/container.jpg')
109
117
  ```
@@ -114,8 +122,8 @@ For full API documentation, response examples, and error codes, please visit the
114
122
 
115
123
  ## Requirements
116
124
 
117
- * Python 3.6+
118
- * `requests` library
125
+ * Python 3.7+
126
+ * `requests` library
119
127
 
120
128
  ## License
121
129
 
structocr-1.3.0/README.md ADDED
@@ -0,0 +1,101 @@
1
+ # StructOCR Python SDK
2
+
3
+ [![PyPI version](https://badge.fury.io/py/structocr.svg)](https://badge.fury.io/py/structocr)
4
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5
+
6
+ **The official Python client for [StructOCR](https://structocr.com).**
7
+
8
+ 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**, and **Container OCR** into your Python applications in minutes.
9
+
10
+ 👉 **[Get your Free API Key here](https://structocr.com)**
11
+
12
+ -----
13
+
14
+ ## 🚀 What's New in 1.3.0
15
+
16
+ We've massively upgraded our Identity Verification engine!
17
+ * **Hybrid VIZ + MRZ AI for National IDs**: The SDK now automatically cross-validates unstructured Visual Zone (VIZ) data against cryptographic Machine Readable Zone (MRZ) checksums (TD1/TD2) for zero hallucination. Raw MRZ lines are now accessible via `additional_fields`.
18
+ * *Previous marine & expense additions (Receipt OCR, HIN OCR, Container OCR) remain fully supported.*
19
+
20
+ Check out the [Quick Start](#quick-start) below to see how easy it is to use them!
21
+
22
+ -----
23
+
24
+ ## Features
25
+
26
+ - **Passport OCR API**: Instantly extract MRZ, name, DOB, and expiry date from passports of 200+ countries.
27
+ - **National ID OCR**: Extract regional specific fields (CNP, CPF, NIN) and raw ICAO 9303 MRZ lines with hybrid validation.
28
+ - **Driver License OCR**: Extract vehicle class, license number, and personal details.
29
+ - **Invoice OCR**: Extract invoice number, currency, merchant, customer, and financial totals.
30
+ - **Receipt OCR**: Extract merchants, dates, line items, taxes, and totals for expense management.
31
+ - **VIN OCR**: Extract VIN (Vehicle Identification Number) from windshield or engine bay images.
32
+ - **HIN OCR**: Validate and extract Hull Identification Numbers from marine vessels.
33
+ - **Container OCR**: Extract shipping container numbers accurately from images.
34
+ - **Secure & Fast**: Enterprise-grade encryption, SOC2 compliance, and sub-second response times with zero data retention.
35
+
36
+ ## Installation
37
+
38
+ Install the package via pip:
39
+
40
+ ```bash
41
+ pip install structocr
42
+ ```
43
+
44
+ ## Quick Start
45
+
46
+ ### 1\. Initialize the Client
47
+
48
+ ```python
49
+ from structocr import StructOCR
50
+
51
+ # Initialize with your API Key
52
+ client = StructOCR(api_key="sk_live_xxxxxxxx")
53
+ ```
54
+
55
+ ### 2\. Scan a Passport (Passport OCR)
56
+
57
+ ```python
58
+ # Pass the path to the passport image file
59
+ result = client.scan_passport('./docs/passport_sample.jpg')
60
+
61
+ print(f"Name: {result['data']['name']}")
62
+ print(f"Passport Number: {result['data']['document_number']}")
63
+ ```
64
+
65
+ ### 3\. Scan Other Documents and Assets
66
+
67
+ ```python
68
+ # National ID OCR
69
+ id_data = client.scan_national_id('./docs/id_card.png')
70
+
71
+ # Driver License OCR
72
+ license_data = client.scan_driver_license('./docs/license.jpg')
73
+
74
+ # Invoice OCR
75
+ invoice_data = client.scan_invoice('./docs/invoice.jpg')
76
+
77
+ # Receipt OCR (New in 1.2.0)
78
+ receipt_data = client.scan_receipt('./docs/receipt.jpg')
79
+
80
+ # VIN OCR
81
+ vin_data = client.scan_vin('./docs/vin.jpg')
82
+
83
+ # HIN OCR (New in 1.2.0)
84
+ hin_data = client.scan_hin('./docs/boat_hin.jpg')
85
+
86
+ # Container OCR
87
+ container_data = client.scan_container('./docs/container.jpg')
88
+ ```
89
+
90
+ ## Documentation
91
+
92
+ For full API documentation, response examples, and error codes, please visit the [StructOCR Developer Docs](https://www.structocr.com/developers?ref=github).
93
+
94
+ ## Requirements
95
+
96
+ * Python 3.7+
97
+ * `requests` library
98
+
99
+ ## License
100
+
101
+ MIT License. See [LICENSE](https://opensource.org/licenses/MIT) for details.
{structocr-1.1.6 → structocr-1.3.0}/setup.py RENAMED
@@ -2,8 +2,8 @@ from setuptools import setup, find_packages
2
2
 
3
3
  setup(
4
4
  name="structocr",
5
- version="1.1.6",
6
- description="The official Python SDK for StructOCR API - Passport, ID card, Driver License OCR, Invoice, VIN and Container OCR.",
5
+ version="1.3.0",
6
+ description="The official Python SDK for StructOCR API - Passport, ID card, Driver License OCR, Invoice, Receipts, VIN, HIN and Container OCR.",
7
7
  long_description=open("README.md").read(),
8
8
  long_description_content_type="text/markdown",
9
9
 
@@ -16,7 +16,7 @@ setup(
16
16
  # 2. 这里定义侧边栏的具体链接 (Homepage, Documentation, Source 等)
17
17
  project_urls={
18
18
  "Homepage": "https://structocr.com",
19
- "Documentation": "https://www.structocr.com/developers", # 假设你的文档在这里
19
+ "Documentation": "https://structocr.com/developers", # 假设你的文档在这里
20
20
  "Source": "https://github.com/structocr/structocr-python",
21
21
  "Tracker": "https://github.com/structocr/structocr-python/issues", # 问题追踪
22
22
  },
structocr-1.3.0/structocr/__init__.py ADDED
@@ -0,0 +1,5 @@
1
+ __version__ = "1.2.0"
2
+
3
+ from .client import StructOCR
4
+
5
+ __all__ = ['StructOCR']
{structocr-1.1.6 → structocr-1.3.0}/structocr/client.py RENAMED
@@ -21,7 +21,7 @@ class StructOCR:
21
21
  self.session.headers.update({
22
22
  "x-api-key": self.api_key,
23
23
  "Content-Type": "application/json",
24
- "User-Agent": "StructOCR-Python/1.1.6"
24
+ "User-Agent": "StructOCR-Python/1.3.0"
25
25
  })
26
26
 
27
27
  def _post_image(self, endpoint, file_path):
@@ -69,6 +69,7 @@ class StructOCR:
69
69
  Scan a National ID card.
70
70
  path: Path to the ID card image file.
71
71
  Returns: Structured JSON data.
72
+ Note: MRZ lines (if present) are located inside the 'additional_fields' object.
72
73
  """
73
74
  # Endpoint: /v1/national-id
74
75
  return self._post_image('national-id', file_path)
@@ -107,4 +108,22 @@ class StructOCR:
107
108
  Returns: Structured JSON data.
108
109
  """
109
110
  # Endpoint: /v1/container (这里假设你的后端路由是 container，如果不同请替换)
110
- return self._post_image('container', file_path)
111
+ return self._post_image('container', file_path)
112
+
113
+ def scan_hin(self, file_path):
114
+ """
115
+ Scan a Hull Identification Number (HIN) from a boat or watercraft.
116
+ path: Path to the HIN image file.
117
+ Returns: Structured JSON data.
118
+ """
119
+ # Endpoint: /v1/hin
120
+ return self._post_image('hin', file_path)
121
+
122
+ def scan_receipt(self, file_path):
123
+ """
124
+ Scan a Retail/Dining Receipt for expense extraction.
125
+ path: Path to the receipt image file.
126
+ Returns: Structured JSON data.
127
+ """
128
+ # Endpoint: /v1/receipt
129
+ return self._post_image('receipt', file_path)
{structocr-1.1.6 → structocr-1.3.0}/structocr.egg-info/PKG-INFO RENAMED
@@ -1,12 +1,12 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: structocr
3
- Version: 1.1.6
4
- Summary: The official Python SDK for StructOCR API - Passport, ID card, Driver License OCR, Invoice, VIN and Container OCR.
3
+ Version: 1.3.0
4
+ Summary: The official Python SDK for StructOCR API - Passport, ID card, Driver License OCR, Invoice, Receipts, VIN, HIN and Container OCR.
5
5
  Home-page: https://structocr.com
6
6
  Author: StructOCR Team
7
7
  Author-email: support@structocr.com
8
8
  Project-URL: Homepage, https://structocr.com
9
- Project-URL: Documentation, https://www.structocr.com/developers
9
+ Project-URL: Documentation, https://structocr.com/developers
10
10
  Project-URL: Source, https://github.com/structocr/structocr-python
11
11
  Project-URL: Tracker, https://github.com/structocr/structocr-python/issues
12
12
  Classifier: Programming Language :: Python :: 3
@@ -34,31 +34,33 @@ Dynamic: summary
34
34
 
35
35
  **The official Python client for [StructOCR](https://structocr.com).**
36
36
 
37
- 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**, **Driver License OCR**, **Invoice OCR**, **VIN OCR**, and **Container OCR** into your Python applications in minutes.
37
+ 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**, and **Container OCR** into your Python applications in minutes.
38
38
 
39
39
  👉 **[Get your Free API Key here](https://structocr.com)**
40
40
 
41
- ---
41
+ -----
42
42
 
43
- ## 🚀 What's New in 1.1.6
44
- We've massively expanded our logistics and finance capabilities! The SDK now natively supports:
45
- * **Container OCR**: Accurately parse shipping container numbers from images.
46
- * **VIN OCR**: Read Vehicle Identification Numbers from windshields or chassis.
47
- * **Invoice OCR**: Automatically extract invoice numbers, currencies, merchants, and customers.
43
+ ## 🚀 What's New in 1.3.0
48
44
 
49
- Check out the [Quick Start](#3-scan-a-national-id-driver-license-invoice-vin-or-container) below to see how easy it is to use them!
45
+ We've massively upgraded our Identity Verification engine!
46
+ * **Hybrid VIZ + MRZ AI for National IDs**: The SDK now automatically cross-validates unstructured Visual Zone (VIZ) data against cryptographic Machine Readable Zone (MRZ) checksums (TD1/TD2) for zero hallucination. Raw MRZ lines are now accessible via `additional_fields`.
47
+ * *Previous marine & expense additions (Receipt OCR, HIN OCR, Container OCR) remain fully supported.*
50
48
 
51
- ---
49
+ Check out the [Quick Start](#quick-start) below to see how easy it is to use them!
50
+
51
+ -----
52
52
 
53
53
  ## Features
54
54
 
55
- - **Passport OCR API**: Instantly extract MRZ, name, DOB, and expiry date from passports of 200+ countries.
56
- - **National ID OCR**: Support for ID cards with automatic field mapping.
57
- - **Driver License OCR**: Extract vehicle class, license number, and personal details.
58
- - **Invoice OCR**: Extract invoice number, currency, merchant, customer.
59
- - **VIN OCR**: Extract VIN (Vehicle Identification Number) from windshield or engine bay images.
60
- - **Container OCR**: Extract shipping container numbers accurately from images.
61
- - **Secure & Fast**: Enterprise-grade encryption and sub-second response times.
55
+ - **Passport OCR API**: Instantly extract MRZ, name, DOB, and expiry date from passports of 200+ countries.
56
+ - **National ID OCR**: Extract regional specific fields (CNP, CPF, NIN) and raw ICAO 9303 MRZ lines with hybrid validation.
57
+ - **Driver License OCR**: Extract vehicle class, license number, and personal details.
58
+ - **Invoice OCR**: Extract invoice number, currency, merchant, customer, and financial totals.
59
+ - **Receipt OCR**: Extract merchants, dates, line items, taxes, and totals for expense management.
60
+ - **VIN OCR**: Extract VIN (Vehicle Identification Number) from windshield or engine bay images.
61
+ - **HIN OCR**: Validate and extract Hull Identification Numbers from marine vessels.
62
+ - **Container OCR**: Extract shipping container numbers accurately from images.
63
+ - **Secure & Fast**: Enterprise-grade encryption, SOC2 compliance, and sub-second response times with zero data retention.
62
64
 
63
65
  ## Installation
64
66
 
@@ -70,7 +72,7 @@ pip install structocr
70
72
 
71
73
  ## Quick Start
72
74
 
73
- ### 1. Initialize the Client
75
+ ### 1\. Initialize the Client
74
76
 
75
77
  ```python
76
78
  from structocr import StructOCR
@@ -79,7 +81,7 @@ from structocr import StructOCR
79
81
  client = StructOCR(api_key="sk_live_xxxxxxxx")
80
82
  ```
81
83
 
82
- ### 2. Scan a Passport (Passport OCR)
84
+ ### 2\. Scan a Passport (Passport OCR)
83
85
 
84
86
  ```python
85
87
  # Pass the path to the passport image file
@@ -89,7 +91,7 @@ print(f"Name: {result['data']['name']}")
89
91
  print(f"Passport Number: {result['data']['document_number']}")
90
92
  ```
91
93
 
92
- ### 3. Scan a National ID, Driver License, Invoice, VIN, or Container
94
+ ### 3\. Scan Other Documents and Assets
93
95
 
94
96
  ```python
95
97
  # National ID OCR
@@ -101,9 +103,15 @@ license_data = client.scan_driver_license('./docs/license.jpg')
101
103
  # Invoice OCR
102
104
  invoice_data = client.scan_invoice('./docs/invoice.jpg')
103
105
 
106
+ # Receipt OCR (New in 1.2.0)
107
+ receipt_data = client.scan_receipt('./docs/receipt.jpg')
108
+
104
109
  # VIN OCR
105
110
  vin_data = client.scan_vin('./docs/vin.jpg')
106
111
 
112
+ # HIN OCR (New in 1.2.0)
113
+ hin_data = client.scan_hin('./docs/boat_hin.jpg')
114
+
107
115
  # Container OCR
108
116
  container_data = client.scan_container('./docs/container.jpg')
109
117
  ```
@@ -114,8 +122,8 @@ For full API documentation, response examples, and error codes, please visit the
114
122
 
115
123
  ## Requirements
116
124
 
117
- * Python 3.6+
118
- * `requests` library
125
+ * Python 3.7+
126
+ * `requests` library
119
127
 
120
128
  ## License
121
129
 
structocr-1.1.6/README.md DELETED
@@ -1,93 +0,0 @@
1
- # StructOCR Python SDK
2
-
3
- [![PyPI version](https://badge.fury.io/py/structocr.svg)](https://badge.fury.io/py/structocr)
4
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5
-
6
- **The official Python client for [StructOCR](https://structocr.com).**
7
-
8
- 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**, **Driver License OCR**, **Invoice OCR**, **VIN OCR**, and **Container OCR** into your Python applications in minutes.
9
-
10
- 👉 **[Get your Free API Key here](https://structocr.com)**
11
-
12
- ---
13
-
14
- ## 🚀 What's New in 1.1.6
15
- We've massively expanded our logistics and finance capabilities! The SDK now natively supports:
16
- * **Container OCR**: Accurately parse shipping container numbers from images.
17
- * **VIN OCR**: Read Vehicle Identification Numbers from windshields or chassis.
18
- * **Invoice OCR**: Automatically extract invoice numbers, currencies, merchants, and customers.
19
-
20
- Check out the [Quick Start](#3-scan-a-national-id-driver-license-invoice-vin-or-container) below to see how easy it is to use them!
21
-
22
- ---
23
-
24
- ## Features
25
-
26
- - **Passport OCR API**: Instantly extract MRZ, name, DOB, and expiry date from passports of 200+ countries.
27
- - **National ID OCR**: Support for ID cards with automatic field mapping.
28
- - **Driver License OCR**: Extract vehicle class, license number, and personal details.
29
- - **Invoice OCR**: Extract invoice number, currency, merchant, customer.
30
- - **VIN OCR**: Extract VIN (Vehicle Identification Number) from windshield or engine bay images.
31
- - **Container OCR**: Extract shipping container numbers accurately from images.
32
- - **Secure & Fast**: Enterprise-grade encryption and sub-second response times.
33
-
34
- ## Installation
35
-
36
- Install the package via pip:
37
-
38
- ```bash
39
- pip install structocr
40
- ```
41
-
42
- ## Quick Start
43
-
44
- ### 1. Initialize the Client
45
-
46
- ```python
47
- from structocr import StructOCR
48
-
49
- # Initialize with your API Key
50
- client = StructOCR(api_key="sk_live_xxxxxxxx")
51
- ```
52
-
53
- ### 2. Scan a Passport (Passport OCR)
54
-
55
- ```python
56
- # Pass the path to the passport image file
57
- result = client.scan_passport('./docs/passport_sample.jpg')
58
-
59
- print(f"Name: {result['data']['name']}")
60
- print(f"Passport Number: {result['data']['document_number']}")
61
- ```
62
-
63
- ### 3. Scan a National ID, Driver License, Invoice, VIN, or Container
64
-
65
- ```python
66
- # National ID OCR
67
- id_data = client.scan_national_id('./docs/id_card.png')
68
-
69
- # Driver License OCR
70
- license_data = client.scan_driver_license('./docs/license.jpg')
71
-
72
- # Invoice OCR
73
- invoice_data = client.scan_invoice('./docs/invoice.jpg')
74
-
75
- # VIN OCR
76
- vin_data = client.scan_vin('./docs/vin.jpg')
77
-
78
- # Container OCR
79
- container_data = client.scan_container('./docs/container.jpg')
80
- ```
81
-
82
- ## Documentation
83
-
84
- For full API documentation, response examples, and error codes, please visit the [StructOCR Developer Docs](https://www.structocr.com/developers?ref=github).
85
-
86
- ## Requirements
87
-
88
- * Python 3.6+
89
- * `requests` library
90
-
91
- ## License
92
-
93
- MIT License. See [LICENSE](https://opensource.org/licenses/MIT) for details.
structocr-1.1.6/structocr/__init__.py DELETED
@@ -1,5 +0,0 @@
1
- __version__ = "1.1.6"
2
-
3
- from .client import StructOCR
4
-
5
- __all__ = ['StructOCR']
{structocr-1.1.6 → structocr-1.3.0}/setup.cfg RENAMED
File without changes