byteit 0.1.0__tar.gz → 0.1.2__tar.gz

byteit-0.1.2/CHANGELOG.md

@@ -0,0 +1,45 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## [0.1.2] - 2026-01-31
+
+### Changed
+- Processing migrated to top-enhanced production servers, reducing processing time by ~50%.
+
+- Adaptive polling improved for smoother operation.
+
+- Progress bar and output display enhanced for notebooks.
+
+- Increased `DEFAULT_TIMEOUT` from 10 minutes to 30 minutes for large documents
+
+## [0.1.1] - 2026-01-24
+
+### Changed
+- Increased `DEFAULT_TIMEOUT` from 30 seconds to 10 minutes for large documents
+- Adaptive polling in `_wait_for_completion`: starts at 2s, increases to max 10s
+
+### Added
+- Progress logging during document parsing
+
+## [0.1.0] - 2026-01-18
+
+### Added
+- Initial release of the ByteIT Python SDK
+- `ByteITClient` for AI-powered document parsing
+- Multiple output formats: text, JSON, Markdown, HTML
+- Input connectors:
+  - `LocalFileInputConnector`
+  - `S3InputConnector`
+- Output connector:
+  - `LocalFileOutputConnector`
+- Job management (list jobs, check status, download results)
+- Support for PDF, Word, Excel, and other common document formats
+- Batch processing support
+- Environment variable configuration
+- Custom base URL support (testing & staging)
+- Python 3.8+ support

{byteit-0.1.0 → byteit-0.1.2}/MANIFEST.in

@@ -2,4 +2,5 @@ recursive-include byteit *.py
 recursive-include tests *.py
 include README.md
 include LICENSE
+include CHANGELOG.md
 include pyproject.toml

byteit-0.1.2/PKG-INFO

@@ -0,0 +1,275 @@
+Metadata-Version: 2.1
+Name: byteit
+Version: 0.1.2
+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
+Requires-Dist: tqdm>=4.65.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 Python SDK
+
+ByteIT's Python library for extracting structured data from documents.
+It is designed for backend services and ETL pipelines that require reliable, consistent document parsing at scale through a simple API.
+
+---
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install byteit
+```
+
+Python 3.8 or newer is required.
+
+---
+
+## Quick Start
+
+```python
+from byteit import ByteITClient
+
+client = ByteITClient(api_key="your_api_key")
+
+result = client.parse("document.pdf")
+print(result.decode())
+```
+
+The returned value is raw bytes containing the parsed document content.
+
+---
+
+## Supported Input File Types
+
+ByteIT supports the following file types as input:
+
+* PDF (`.pdf`)
+* Word (`.docx`)
+* PowerPoint (`.pptx`)
+* HTML (`.html`)
+* Markdown (`.md`)
+* Plain text (`.txt`)
+* JSON (`.json`)
+* XML (`.xml`)
+
+---
+
+## Basic Usage
+
+### Parse a Local File
+
+```python
+result = client.parse("invoice.pdf")
+```
+
+By default, the output format is **Markdown (`md`)**.
+
+---
+
+## Output Formats
+
+You can choose the output format depending on your pipeline needs:
+
+```python
+txt = client.parse("doc.pdf", output_format="txt")
+json = client.parse("doc.pdf", output_format="json")
+md = client.parse("doc.pdf", output_format="md")
+html = client.parse("doc.pdf", output_format="html")
+```
+
+Supported output formats:
+
+* Plain text (`txt`)
+* JSON (`json`)
+* Markdown (`md`) *(default)*
+* HTML (`html`)
+
+---
+
+## Save Output to File
+
+```python
+client.parse(
+    "doc.pdf",
+    output_format="md",
+    output="result.md"
+)
+```
+
+When `output` is provided, the parsed result is written directly to disk.
+
+---
+
+## Notebook Integration
+
+When used in Jupyter notebooks, ByteIT automatically displays results in a readable format:
+
+* **JSON**: Interactive, expandable/collapsible tree view
+* **Markdown**: Rendered with formatting (headers, lists, etc.)
+* **HTML**: Rendered as HTML
+* **Text**: Code block with syntax highlighting
+
+```python
+# In a Jupyter notebook - automatically displays formatted result
+result = client.parse("document.pdf", result_format="json")
+```
+
+To disable auto-display, save to a file instead:
+
+```python
+# Saves to file, no auto-display
+result = client.parse("doc.pdf", result_format="json", output="output.json")
+```
+
+---
+
+## Typical Use Cases
+
+* Extracting structured data from documents in ETL pipelines
+* Preprocessing documents before indexing or downstream processing
+* Automating ingestion of invoices, contracts, or reports
+* Interactive document exploration in Jupyter notebooks
+
+---
+
+## API Reference
+
+### `ByteITClient`
+
+```python
+ByteITClient(api_key: str)
+```
+
+Creates a new ByteIT client.
+
+#### Parameters
+
+* `api_key` (`str`): Your ByteIT API key
+
+---
+
+### `parse(...)`
+
+```python
+parse(
+    input,
+    output_format: str = "md",
+    output = None
+)
+```
+
+Parse a document and return the extracted content.
+
+#### Parameters
+
+* `input` (`str | Path`): Path to a local document
+* `output_format` (`str`): Output format (`txt`, `json`, `md`, `html`)
+* `output` (`str | Path | None`): Optional path to save the result
+
+#### Returns
+
+* `bytes`: Parsed document content
+
+---
+
+## Error Handling
+
+The SDK exposes specific exceptions for common error cases:
+
+```python
+from byteit.exceptions import (
+    ByteITError,
+    ValidationError,
+    AuthenticationError,
+    RateLimitError,
+    ServerError,
+)
+
+try:
+    result = client.parse("document.pdf")
+except ValidationError as e:
+    print("Invalid input:", e.message)
+except AuthenticationError:
+    print("Invalid API key")
+except RateLimitError:
+    print("Rate limit exceeded")
+except ByteITError as e:
+    print("ByteIT error:", e.message)
+```
+
+All exceptions inherit from `ByteITError`.
+
+---
+
+## Configuration
+
+### Environment Variable
+
+You can provide the API key via environment variable:
+
+```bash
+export BYTEIT_API_KEY="your_api_key"
+```
+
+```python
+import os
+from byteit import ByteITClient
+
+client = ByteITClient(api_key=os.getenv("BYTEIT_API_KEY"))
+```
+
+---
+
+## Requirements
+
+* Python 3.8+
+* `requests`
+
+---
+
+## About ByteIT
+
+ByteIT provides document parsing and data extraction APIs designed for backend systems and automation workflows.
+
+Website: [https://byteit.ai](https://byteit.ai)
+
+---
+
+## License
+
+This project is licensed under the terms specified in the [LICENSE](LICENSE) file.
+
+© 2026 ByteIT GmbH
+
+---

byteit-0.1.2/README.md

@@ -0,0 +1,237 @@
+# ByteIT Python SDK
+
+ByteIT's Python library for extracting structured data from documents.
+It is designed for backend services and ETL pipelines that require reliable, consistent document parsing at scale through a simple API.
+
+---
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install byteit
+```
+
+Python 3.8 or newer is required.
+
+---
+
+## Quick Start
+
+```python
+from byteit import ByteITClient
+
+client = ByteITClient(api_key="your_api_key")
+
+result = client.parse("document.pdf")
+print(result.decode())
+```
+
+The returned value is raw bytes containing the parsed document content.
+
+---
+
+## Supported Input File Types
+
+ByteIT supports the following file types as input:
+
+* PDF (`.pdf`)
+* Word (`.docx`)
+* PowerPoint (`.pptx`)
+* HTML (`.html`)
+* Markdown (`.md`)
+* Plain text (`.txt`)
+* JSON (`.json`)
+* XML (`.xml`)
+
+---
+
+## Basic Usage
+
+### Parse a Local File
+
+```python
+result = client.parse("invoice.pdf")
+```
+
+By default, the output format is **Markdown (`md`)**.
+
+---
+
+## Output Formats
+
+You can choose the output format depending on your pipeline needs:
+
+```python
+txt = client.parse("doc.pdf", output_format="txt")
+json = client.parse("doc.pdf", output_format="json")
+md = client.parse("doc.pdf", output_format="md")
+html = client.parse("doc.pdf", output_format="html")
+```
+
+Supported output formats:
+
+* Plain text (`txt`)
+* JSON (`json`)
+* Markdown (`md`) *(default)*
+* HTML (`html`)
+
+---
+
+## Save Output to File
+
+```python
+client.parse(
+    "doc.pdf",
+    output_format="md",
+    output="result.md"
+)
+```
+
+When `output` is provided, the parsed result is written directly to disk.
+
+---
+
+## Notebook Integration
+
+When used in Jupyter notebooks, ByteIT automatically displays results in a readable format:
+
+* **JSON**: Interactive, expandable/collapsible tree view
+* **Markdown**: Rendered with formatting (headers, lists, etc.)
+* **HTML**: Rendered as HTML
+* **Text**: Code block with syntax highlighting
+
+```python
+# In a Jupyter notebook - automatically displays formatted result
+result = client.parse("document.pdf", result_format="json")
+```
+
+To disable auto-display, save to a file instead:
+
+```python
+# Saves to file, no auto-display
+result = client.parse("doc.pdf", result_format="json", output="output.json")
+```
+
+---
+
+## Typical Use Cases
+
+* Extracting structured data from documents in ETL pipelines
+* Preprocessing documents before indexing or downstream processing
+* Automating ingestion of invoices, contracts, or reports
+* Interactive document exploration in Jupyter notebooks
+
+---
+
+## API Reference
+
+### `ByteITClient`
+
+```python
+ByteITClient(api_key: str)
+```
+
+Creates a new ByteIT client.
+
+#### Parameters
+
+* `api_key` (`str`): Your ByteIT API key
+
+---
+
+### `parse(...)`
+
+```python
+parse(
+    input,
+    output_format: str = "md",
+    output = None
+)
+```
+
+Parse a document and return the extracted content.
+
+#### Parameters
+
+* `input` (`str | Path`): Path to a local document
+* `output_format` (`str`): Output format (`txt`, `json`, `md`, `html`)
+* `output` (`str | Path | None`): Optional path to save the result
+
+#### Returns
+
+* `bytes`: Parsed document content
+
+---
+
+## Error Handling
+
+The SDK exposes specific exceptions for common error cases:
+
+```python
+from byteit.exceptions import (
+    ByteITError,
+    ValidationError,
+    AuthenticationError,
+    RateLimitError,
+    ServerError,
+)
+
+try:
+    result = client.parse("document.pdf")
+except ValidationError as e:
+    print("Invalid input:", e.message)
+except AuthenticationError:
+    print("Invalid API key")
+except RateLimitError:
+    print("Rate limit exceeded")
+except ByteITError as e:
+    print("ByteIT error:", e.message)
+```
+
+All exceptions inherit from `ByteITError`.
+
+---
+
+## Configuration
+
+### Environment Variable
+
+You can provide the API key via environment variable:
+
+```bash
+export BYTEIT_API_KEY="your_api_key"
+```
+
+```python
+import os
+from byteit import ByteITClient
+
+client = ByteITClient(api_key=os.getenv("BYTEIT_API_KEY"))
+```
+
+---
+
+## Requirements
+
+* Python 3.8+
+* `requests`
+
+---
+
+## About ByteIT
+
+ByteIT provides document parsing and data extraction APIs designed for backend systems and automation workflows.
+
+Website: [https://byteit.ai](https://byteit.ai)
+
+---
+
+## License
+
+This project is licensed under the terms specified in the [LICENSE](LICENSE) file.
+
+© 2026 ByteIT GmbH
+
+---