byteit 0.1.0__tar.gz

byteit-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 ByteIT GmbH
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

byteit-0.1.0/MANIFEST.in

@@ -0,0 +1,5 @@
+recursive-include byteit *.py
+recursive-include tests *.py
+include README.md
+include LICENSE
+include pyproject.toml

byteit-0.1.0/PKG-INFO

@@ -0,0 +1,424 @@
+Metadata-Version: 2.1
+Name: byteit
+Version: 0.1.0
+Summary: AI-powered document intelligence platform - Turn your data into structured data with a single line of code.
+Author-email: ByteIT GmbH <support@byteit.ai>
+License: Apache-2.0
+Project-URL: Homepage, https://byteit.ai
+Project-URL: Repository, https://github.com/byteit-ai/byteit-api
+Project-URL: Pricing, https://byteit.ai/pricing
+Project-URL: Support, https://byteit.ai/support
+Project-URL: Contact, https://byteit.ai/contact
+Keywords: document-processing,ai,document-intelligence,pdf,data-extraction,machine-learning,ocr
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Office/Business
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.28.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: isort>=5.0.0; extra == "dev"
+Requires-Dist: flake8>=6.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+
+# ByteIT API Library
+
+**Turn your data into AI - Transform documents into structured data with a single line of code.**
+
+ByteIT is an AI-powered document intelligence platform that extracts clean, structured data from PDFs, Word, Excel, and many other file formats. This Python SDK provides a simple, developer-first interface to ByteIT's advanced document processing capabilities.
+
+---
+
+## Why ByteIT?
+
+- **Lightning Fast** - Process documents in under 2 seconds
+- **AI-Powered** - Advanced ML models trained on millions of documents
+- **Simple API** - Parse documents in one line: `client.parse("document.pdf")`
+- **Developer First** - Clean code, full type hints, comprehensive SDKs
+- **Enterprise Security** - End-to-end encryption and GDPR compliance
+- **Smart Extraction** - Extract text, tables, forms, and structured data with AI precision
+
+---
+
+## Quick Start
+
+### Installation
+
+```bash
+pip install byteit
+```
+
+### Basic Usage
+
+```python
+from byteit import ByteITClient
+
+# Initialize client
+client = ByteITClient(api_key="your_api_key")
+
+# Parse a document
+result = client.parse("invoice.pdf")
+print(result.decode())
+```
+
+That's it. Your document is now structured text.
+
+---
+
+## Features
+
+### Parse Any Document
+
+```python
+# Local files
+result = client.parse("contract.pdf")
+
+# Different formats
+txt_result = client.parse("doc.pdf", output_format="txt")
+json_result = client.parse("doc.pdf", output_format="json")
+md_result = client.parse("doc.pdf", output_format="md")
+html_result = client.parse("doc.pdf", output_format="html")
+
+# Save to file
+client.parse("doc.pdf", output="result.txt")
+```
+
+### S3 Integration
+
+Process files directly from S3 without downloading - perfect for high-volume workflows:
+
+```python
+from byteit.connectors import S3InputConnector
+
+# Parse from S3
+result = client.parse(
+    S3InputConnector(
+        source_bucket="my-documents",
+        source_path_inside_bucket="invoices/jan-2024.pdf"
+    )
+)
+```
+
+### Job Management
+
+Track and retrieve processing jobs:
+
+```python
+# List all jobs
+jobs = client.get_all_jobs()
+for job in jobs:
+    print(f"{job.id}: {job.processing_status}")
+
+# Get specific job
+job = client.get_job_by_id("job_123")
+
+# Download result later
+if job.is_completed:
+    result = client.get_result(job.id)
+```
+
+### Context Manager
+
+Automatic resource cleanup:
+
+```python
+with ByteITClient(api_key="your_key") as client:
+    result = client.parse("document.pdf")
+    # Session automatically closed
+```
+
+---
+
+## API Reference
+
+### ByteITClient
+
+**`ByteITClient(api_key: str)`**
+
+Initialize the ByteIT client.
+
+**Parameters:**
+- `api_key` (str): Your ByteIT API key
+
+**Methods:**
+
+#### `parse(input, output_format="txt", output=None)`
+
+Parse a document and return the result.
+
+**Parameters:**
+- `input` (str | Path | InputConnector): File to parse
+  - `str` or `Path`: Local file path
+  - `S3InputConnector`: For S3 files
+- `output_format` (str): Output format - "txt", "json", "md", or "html" (default: "txt")
+- `output` (str | Path | None): Optional file path to save result
+
+**Returns:** `bytes` - Parsed content
+
+**Example:**
+```python
+result = client.parse("doc.pdf", output_format="json")
+```
+
+#### `get_all_jobs()`
+
+Get all jobs for your account.
+
+**Returns:** `List[Job]` - List of Job objects
+
+#### `get_job_by_id(job_id: str)`
+
+Get a specific job by ID.
+
+**Parameters:**
+- `job_id` (str): The job ID
+
+**Returns:** `Job` - Job object
+
+#### `get_result(job_id: str)`
+
+Download result for a completed job.
+
+**Parameters:**
+- `job_id` (str): The job ID
+
+**Returns:** `bytes` - Result content
+
+---
+
+## Connectors
+
+### LocalFileInputConnector
+
+Read files from local filesystem.
+
+```python
+from byteit.connectors import LocalFileInputConnector
+
+connector = LocalFileInputConnector("path/to/file.pdf")
+result = client.parse(connector)
+```
+
+### S3InputConnector
+
+Read files from Amazon S3 using IAM role authentication - files never pass through your machine.
+
+**Prerequisites:**
+1. Contact [ByteIT support](https://byteit.ai/contact) to set up AWS connection
+2. Provide IAM role ARN for ByteIT to assume
+3. Grant role read access to your bucket
+
+```python
+from byteit.connectors import S3InputConnector
+
+connector = S3InputConnector(
+    source_bucket="my-bucket",
+    source_path_inside_bucket="documents/file.pdf"
+)
+result = client.parse(connector)
+```
+
+---
+
+## Error Handling
+
+ByteIT SDK provides specific exceptions for different error scenarios:
+
+```python
+from byteit.exceptions import (
+    APIKeyError,           # Invalid API key
+    AuthenticationError,   # Authentication failed
+    ValidationError,       # Invalid parameters
+    ResourceNotFoundError, # Job/resource not found
+    RateLimitError,        # Rate limit exceeded
+    ServerError,           # Server-side error (5xx)
+    JobProcessingError,    # Job processing failed
+)
+
+try:
+    result = client.parse("document.pdf")
+except ValidationError as e:
+    print(f"Invalid input: {e.message}")
+except RateLimitError:
+    print("Rate limit exceeded - please wait")
+except JobProcessingError as e:
+    print(f"Processing failed: {e.message}")
+```
+
+All exceptions inherit from `ByteITError`:
+
+```python
+from byteit.exceptions import ByteITError
+
+try:
+    result = client.parse("document.pdf")
+except ByteITError as e:
+    print(f"ByteIT error: {e.message}")
+    print(f"Status code: {e.status_code}")
+    print(f"Response: {e.response}")
+```
+
+---
+
+## Advanced Usage
+
+### Batch Processing
+
+Process multiple files efficiently:
+
+```python
+files = ["doc1.pdf", "doc2.pdf", "doc3.pdf"]
+results = []
+
+for file in files:
+    result = client.parse(file, output_format="json")
+    results.append(result)
+```
+
+### Custom Output Paths
+
+Organize results systematically:
+
+```python
+from pathlib import Path
+
+input_dir = Path("inputs")
+output_dir = Path("outputs")
+output_dir.mkdir(exist_ok=True)
+
+for pdf_file in input_dir.glob("*.pdf"):
+    output_file = output_dir / f"{pdf_file.stem}.txt"
+    client.parse(pdf_file, output=output_file)
+```
+
+### S3 Workflow
+
+High-volume cloud processing:
+
+```python
+from byteit.connectors import S3InputConnector
+
+# Process multiple S3 files
+s3_files = [
+    "invoices/2024-01.pdf",
+    "invoices/2024-02.pdf",
+    "invoices/2024-03.pdf",
+]
+
+for s3_path in s3_files:
+    connector = S3InputConnector(
+        source_bucket="my-documents",
+        source_path_inside_bucket=s3_path
+    )
+    result = client.parse(connector, output_format="json")
+    # Process result...
+```
+
+---
+
+## Configuration
+
+### Environment Variables
+
+Set your API key via environment variable:
+
+```bash
+export BYTEIT_API_KEY="your_api_key_here"
+```
+
+```python
+import os
+from byteit import ByteITClient
+
+client = ByteITClient(api_key=os.getenv("BYTEIT_API_KEY"))
+```
+
+### Custom Base URL
+
+For testing or custom deployments:
+
+```python
+from byteit import ByteITClient
+
+# Set custom URL (for development/testing)
+ByteITClient.BASE_URL = "http://localhost:8000"
+client = ByteITClient(api_key="test_key")
+```
+
+---
+
+## Testing
+
+The SDK includes comprehensive unit and integration tests.
+
+### Run Unit Tests
+
+```bash
+pytest
+```
+
+### Run Integration Tests
+
+Integration tests require a running ByteIT API and valid API key:
+
+```bash
+export BYTEIT_API_KEY="your_api_key"
+pytest -m integration
+```
+
+### Run All Tests
+
+```bash
+pytest -m ""
+```
+
+---
+
+## Requirements
+
+- Python 3.8+
+- `requests` library
+
+---
+
+## About ByteIT
+
+ByteIT transforms unstructured documents into clean, structured data with AI-powered precision. Built for scale, designed for developers.
+
+**Get started today:** [Start Processing Free](https://byteit.ai/pricing) - 1,000 free pages/month
+
+---
+
+## Support & Resources
+
+- **Website:** [https://byteit.ai](https://byteit.ai)
+- **Pricing:** [https://byteit.ai/pricing](https://byteit.ai/pricing)
+- **Support:** [https://byteit.ai/support](https://byteit.ai/support)
+- **Contact:** [https://byteit.ai/contact](https://byteit.ai/contact)
+- **LinkedIn:** [ByteIT on LinkedIn](https://www.linkedin.com/company/byteit-ai)
+
+---
+
+## Legal
+
+© 2026 ByteIT GmbH. All rights reserved.
+
+- **Privacy Policy:** [https://byteit.ai/privacy-policy](https://byteit.ai/privacy-policy)
+- **Terms of Service:** [https://byteit.ai/terms](https://byteit.ai/terms)
+- **Impressum:** [https://byteit.ai/impressum](https://byteit.ai/impressum)
+
+This project is licensed under the terms specified in the [LICENSE](LICENSE) file.