invoicedataextraction-sdk 0.1.0__tar.gz

invoicedataextraction_sdk-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Invoice Data Extraction
+
+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.

invoicedataextraction_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: invoicedataextraction-sdk
+Version: 0.1.0
+Summary: Official Python SDK for Invoice Data Extraction.
+Author-email: Invoice Data Extraction <developers@invoicedataextraction.com>
+License-Expression: MIT
+Project-URL: Homepage, https://invoicedataextraction.com
+Project-URL: Documentation, https://invoicedataextraction.com/docs
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.28.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Dynamic: license-file
+
+# invoicedataextraction-sdk
+
+Official Python SDK for [Invoice Data Extraction](https://invoicedataextraction.com). Handles file upload, extraction submission, polling, and result download so you can go from local files to structured output in a few lines of code.
+
+- Python 3.9 or later
+
+## Install
+
+```bash
+pip install invoicedataextraction-sdk
+```
+
+## Quick Start
+
+```python
+import os
+from invoicedataextraction import InvoiceDataExtraction
+
+client = InvoiceDataExtraction(
+    api_key=os.environ["INVOICE_DATA_EXTRACTION_API_KEY"],
+)
+
+result = client.extract(
+    folder_path="./invoices",
+    prompt="Extract invoice number and total",
+    output_structure="per_invoice",
+    download={
+        "formats": ["xlsx", "json"],
+        "output_path": "./output",
+    },
+    console_output=True,  # remove to disable console logging
+)
+```
+
+`extract(...)` uploads your files (pass a `folder_path` or a list of `files`), submits the extraction, polls until it finishes, and downloads the results. The returned `result` is the final polling response from the API. Check `result["pages"]["failed_count"]` to verify that all uploaded pages were processed successfully.
+
+Generate an API key from your [dashboard](https://invoicedataextraction.com/dashboard?view=API). Every account includes 50 free pages per month. Additional credits can be purchased on a pay-as-you-go basis with no subscription needed.
+
+## Staged Workflow
+
+If you need control over individual steps — for example, uploading files in one part of your system and extracting in another — use the lower-level methods:
+
+```python
+upload = client.upload_files(
+    files=["./invoice1.pdf", "./invoice2.pdf"],
+)
+
+submitted = client.submit_extraction(
+    upload_session_id=upload["upload_session_id"],
+    file_ids=upload["file_ids"],
+    prompt="Extract invoice number and total",
+    output_structure="per_invoice",
+)
+
+result = client.wait_for_extraction_to_finish(
+    extraction_id=submitted["extraction_id"],
+)
+
+client.download_output(
+    extraction_id=submitted["extraction_id"],
+    format="xlsx",
+    file_path="./output/invoices.xlsx",
+)
+```
+
+## Error Handling
+
+SDK methods raise exceptions on failure. The structured error body is on `error.body`:
+
+```python
+from invoicedataextraction import InvoiceDataExtraction
+from invoicedataextraction.errors import SdkError, ApiResponseError
+
+try:
+    client.extract(...)
+except (SdkError, ApiResponseError) as error:
+    print(error.body["error"]["code"])       # e.g. "INVALID_INPUT"
+    print(error.body["error"]["message"])     # Human-readable message
+    print(error.body["error"]["retryable"])
+```
+
+When an extraction task itself fails (e.g. insufficient credits), `extract(...)` returns the failed response rather than raising — check `result["status"]` for `"completed"` or `"failed"`.
+
+## Documentation
+
+- [Python SDK docs](https://invoicedataextraction.com/sdk/python) — full method reference, parameters, return shapes, and examples
+- [REST API docs](https://invoicedataextraction.com/api) — endpoint-level documentation for direct HTTP integration
+- [Dashboard](https://invoicedataextraction.com/dashboard?view=API) — manage API keys and view extraction results
+
+## License
+
+MIT

invoicedataextraction_sdk-0.1.0/README.md

@@ -0,0 +1,92 @@
+# invoicedataextraction-sdk
+
+Official Python SDK for [Invoice Data Extraction](https://invoicedataextraction.com). Handles file upload, extraction submission, polling, and result download so you can go from local files to structured output in a few lines of code.
+
+- Python 3.9 or later
+
+## Install
+
+```bash
+pip install invoicedataextraction-sdk
+```
+
+## Quick Start
+
+```python
+import os
+from invoicedataextraction import InvoiceDataExtraction
+
+client = InvoiceDataExtraction(
+    api_key=os.environ["INVOICE_DATA_EXTRACTION_API_KEY"],
+)
+
+result = client.extract(
+    folder_path="./invoices",
+    prompt="Extract invoice number and total",
+    output_structure="per_invoice",
+    download={
+        "formats": ["xlsx", "json"],
+        "output_path": "./output",
+    },
+    console_output=True,  # remove to disable console logging
+)
+```
+
+`extract(...)` uploads your files (pass a `folder_path` or a list of `files`), submits the extraction, polls until it finishes, and downloads the results. The returned `result` is the final polling response from the API. Check `result["pages"]["failed_count"]` to verify that all uploaded pages were processed successfully.
+
+Generate an API key from your [dashboard](https://invoicedataextraction.com/dashboard?view=API). Every account includes 50 free pages per month. Additional credits can be purchased on a pay-as-you-go basis with no subscription needed.
+
+## Staged Workflow
+
+If you need control over individual steps — for example, uploading files in one part of your system and extracting in another — use the lower-level methods:
+
+```python
+upload = client.upload_files(
+    files=["./invoice1.pdf", "./invoice2.pdf"],
+)
+
+submitted = client.submit_extraction(
+    upload_session_id=upload["upload_session_id"],
+    file_ids=upload["file_ids"],
+    prompt="Extract invoice number and total",
+    output_structure="per_invoice",
+)
+
+result = client.wait_for_extraction_to_finish(
+    extraction_id=submitted["extraction_id"],
+)
+
+client.download_output(
+    extraction_id=submitted["extraction_id"],
+    format="xlsx",
+    file_path="./output/invoices.xlsx",
+)
+```
+
+## Error Handling
+
+SDK methods raise exceptions on failure. The structured error body is on `error.body`:
+
+```python
+from invoicedataextraction import InvoiceDataExtraction
+from invoicedataextraction.errors import SdkError, ApiResponseError
+
+try:
+    client.extract(...)
+except (SdkError, ApiResponseError) as error:
+    print(error.body["error"]["code"])       # e.g. "INVALID_INPUT"
+    print(error.body["error"]["message"])     # Human-readable message
+    print(error.body["error"]["retryable"])
+```
+
+When an extraction task itself fails (e.g. insufficient credits), `extract(...)` returns the failed response rather than raising — check `result["status"]` for `"completed"` or `"failed"`.
+
+## Documentation
+
+- [Python SDK docs](https://invoicedataextraction.com/sdk/python) — full method reference, parameters, return shapes, and examples
+- [REST API docs](https://invoicedataextraction.com/api) — endpoint-level documentation for direct HTTP integration
+- [Dashboard](https://invoicedataextraction.com/dashboard?view=API) — manage API keys and view extraction results
+
+## License
+
+MIT

invoicedataextraction_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,30 @@
+[build-system]
+requires = ["setuptools>=68.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "invoicedataextraction-sdk"
+version = "0.1.0"
+description = "Official Python SDK for Invoice Data Extraction."
+readme = "README.md"
+authors = [
+    { name = "Invoice Data Extraction", email = "developers@invoicedataextraction.com" },
+]
+license = "MIT"
+requires-python = ">=3.9"
+dependencies = [
+    "requests>=2.28.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]
+
+[project.urls]
+Homepage = "https://invoicedataextraction.com"
+Documentation = "https://invoicedataextraction.com/docs"

invoicedataextraction_sdk-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

invoicedataextraction_sdk-0.1.0/src/invoicedataextraction/__init__.py

@@ -0,0 +1,3 @@
+from .client import InvoiceDataExtraction
+
+__all__ = ["InvoiceDataExtraction"]