kreuzberg 1.3.0__py3-none-any.whl → 1.5.0__py3-none-any.whl

kreuzberg-1.5.0.dist-info/METADATA

@@ -0,0 +1,318 @@
+Metadata-Version: 2.2
+Name: kreuzberg
+Version: 1.5.0
+Summary: A text extraction library supporting PDFs, images, office documents and more
+Author-email: Na'aman Hirschfeld <nhirschfed@gmail.com>
+License: MIT
+Project-URL: homepage, https://github.com/Goldziher/kreuzberg
+Keywords: document-processing,image-to-text,ocr,pandoc,pdf-extraction,rag,tesseract,text-extraction,text-processing
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: General
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: anyio>=4.8.0
+Requires-Dist: charset-normalizer>=3.4.1
+Requires-Dist: html-to-markdown>=1.2.0
+Requires-Dist: pypdfium2>=4.30.1
+Requires-Dist: python-pptx>=1.0.2
+Requires-Dist: typing-extensions>=4.12.2; python_version < "3.10"
+
+# Kreuzberg
+
+Kreuzberg is a modern Python library for text extraction from documents, designed for simplicity and efficiency. It provides a unified async interface for extracting text from a wide range of file formats including PDFs, images, office documents, and more.
+
+## Why Kreuzberg?
+
+- **Simple and Hassle-Free**: Clean API that just works, without complex configuration
+- **Local Processing**: No external API calls or cloud dependencies required
+- **Resource Efficient**: Lightweight processing without GPU requirements
+- **Format Support**: Comprehensive support for documents, images, and text formats
+- **Modern Python**: Built with async/await, type hints, and current best practices
+
+Kreuzberg was created to solve text extraction needs in RAG (Retrieval Augmented Generation) applications, but it's suitable for any text extraction use case. Unlike many commercial solutions that require API calls or complex setups, Kreuzberg focuses on local processing with minimal dependencies.
+
+## Features
+
+- **Universal Text Extraction**: Extract text from PDFs (both searchable and scanned), images, office documents, and more
+- **Smart Processing**: Automatic OCR for scanned documents, encoding detection for text files
+- **Modern Python Design**:
+  - Async-first API using `anyio`
+  - Comprehensive type hints for better IDE support
+  - Detailed error handling with context information
+- **Production Ready**:
+  - Robust error handling
+  - Detailed debugging information
+  - Memory efficient processing
+
+## Installation
+
+### 1. Install the Python Package
+
+```shell
+pip install kreuzberg
+```
+
+### 2. Install System Dependencies
+
+Kreuzberg requires two open-source tools:
+
+- [Pandoc](https://pandoc.org/installing.html) - For document format conversion
+
+  - GPL v2.0 licensed (used via CLI only)
+  - Handles office documents and markup formats
+
+- [Tesseract OCR](https://tesseract-ocr.github.io/) - For image and PDF OCR
+  - Apache License
+  - Required for scanned documents and images
+
+## Architecture
+
+Kreuzberg is designed as a high-level async abstraction over established open-source tools. It integrates:
+
+- **PDF Processing**:
+  - `pdfium2` for searchable PDFs
+  - Tesseract OCR for scanned content
+- **Document Conversion**:
+  - Pandoc for office documents and markup
+  - `python-pptx` for PowerPoint files
+  - `html-to-markdown` for HTML content
+- **Text Processing**:
+  - Smart encoding detection
+  - Markdown and plain text handling
+
+### Supported Formats
+
+#### Document Formats
+
+- PDF (`.pdf`, both searchable and scanned documents)
+- Microsoft Word (`.docx`, `.doc`)
+- PowerPoint presentations (`.pptx`)
+- OpenDocument Text (`.odt`)
+- Rich Text Format (`.rtf`)
+- EPUB (`.epub`)
+- DocBook XML (`.dbk`, `.xml`)
+- FictionBook (`.fb2`)
+- LaTeX (`.tex`, `.latex`)
+- Typst (`.typ`)
+
+#### Markup and Text Formats
+
+- HTML (`.html`, `.htm`)
+- Plain text (`.txt`) and Markdown (`.md`, `.markdown`)
+- reStructuredText (`.rst`)
+- Org-mode (`.org`)
+- DokuWiki (`.txt`)
+- Pod (`.pod`)
+- Man pages (`.1`, `.2`, etc.)
+
+#### Data and Research Formats
+
+- CSV (`.csv`) and TSV (`.tsv`) files
+- Jupyter Notebooks (`.ipynb`)
+- BibTeX (`.bib`) and BibLaTeX (`.bib`)
+- CSL-JSON (`.json`)
+- EndNote XML (`.xml`)
+- RIS (`.ris`)
+- JATS XML (`.xml`)
+
+#### Image Formats
+
+- JPEG (`.jpg`, `.jpeg`, `.pjpeg`)
+- PNG (`.png`)
+- TIFF (`.tiff`, `.tif`)
+- BMP (`.bmp`)
+- GIF (`.gif`)
+- WebP (`.webp`)
+- JPEG 2000 (`.jp2`, `.jpx`, `.jpm`, `.mj2`)
+- Portable Anymap (`.pnm`)
+- Portable Bitmap (`.pbm`)
+- Portable Graymap (`.pgm`)
+- Portable Pixmap (`.ppm`)
+
+## Usage
+
+Kreuzberg provides a simple, async-first API for text extraction. The library exports two main functions:
+
+- `extract_file()`: Extract text from a file (accepts string path or `pathlib.Path`)
+- `extract_bytes()`: Extract text from bytes (accepts a byte string)
+
+### Quick Start
+
+```python
+from pathlib import Path
+from kreuzberg import extract_file, extract_bytes
+
+# Basic file extraction
+async def extract_document():
+    # Extract from a PDF file
+    pdf_result = await extract_file("document.pdf")
+    print(f"PDF text: {pdf_result.content}")
+
+    # Extract from an image
+    img_result = await extract_file("scan.png")
+    print(f"Image text: {img_result.content}")
+
+    # Extract from Word document
+    docx_result = await extract_file(Path("document.docx"))
+    print(f"Word text: {docx_result.content}")
+```
+
+### Processing Uploaded Files
+
+```python
+from kreuzberg import extract_bytes
+
+async def process_upload(file_content: bytes, mime_type: str):
+    """Process uploaded file content with known MIME type."""
+    result = await extract_bytes(file_content, mime_type=mime_type)
+    return result.content
+
+# Example usage with different file types
+async def handle_uploads():
+    # Process PDF upload
+    pdf_result = await extract_bytes(pdf_bytes, mime_type="application/pdf")
+
+    # Process image upload
+    img_result = await extract_bytes(image_bytes, mime_type="image/jpeg")
+
+    # Process Word document upload
+    docx_result = await extract_bytes(docx_bytes,
+        mime_type="application/vnd.openxmlformats-officedocument.wordprocessingml.document")
+```
+
+### Advanced Features
+
+#### PDF Processing Options
+
+```python
+from kreuzberg import extract_file
+
+async def process_pdf():
+    # Force OCR for PDFs with embedded images or scanned content
+    result = await extract_file("document.pdf", force_ocr=True)
+
+    # Process a scanned PDF (automatically uses OCR)
+    scanned = await extract_file("scanned.pdf")
+```
+
+#### ExtractionResult Object
+
+All extraction functions return an `ExtractionResult` containing:
+
+- `content`: The extracted text (str)
+- `mime_type`: Output format ("text/plain" or "text/markdown" for Pandoc conversions)
+
+```python
+from kreuzberg import ExtractionResult
+
+async def process_document(path: str) -> tuple[str, str]:
+    # Access as a named tuple
+    result: ExtractionResult = await extract_file(path)
+    print(f"Content: {result.content}")
+    print(f"Format: {result.mime_type}")
+
+    # Or unpack as a tuple
+    content, mime_type = await extract_file(path)
+    return content, mime_type
+```
+
+### Error Handling
+
+Kreuzberg provides detailed error handling with two main exception types:
+
+```python
+from kreuzberg import extract_file
+from kreuzberg.exceptions import ValidationError, ParsingError
+
+async def safe_extract(path: str) -> str:
+    try:
+        result = await extract_file(path)
+        return result.content
+
+    except ValidationError as e:
+        # Handles input validation issues:
+        # - Unsupported file types
+        # - Missing files
+        # - Invalid MIME types
+        print(f"Invalid input: {e.message}")
+        print(f"Details: {e.context}")
+
+    except ParsingError as e:
+        # Handles processing errors:
+        # - PDF parsing failures
+        # - OCR errors
+        # - Format conversion issues
+        print(f"Processing failed: {e.message}")
+        print(f"Details: {e.context}")
+
+    return ""
+
+# Example error contexts
+try:
+    result = await extract_file("document.xyz")
+except ValidationError as e:
+    # e.context might contain:
+    # {
+    #    "file_path": "document.xyz",
+    #    "error": "Unsupported file type",
+    #    "supported_types": ["pdf", "docx", ...]
+    # }
+
+try:
+    result = await extract_file("scan.pdf")
+except ParsingError as e:
+    # e.context might contain:
+    # {
+    #    "file_path": "scan.pdf",
+    #    "error": "OCR processing failed",
+    #    "details": "Tesseract error: Unable to process image"
+    # }
+```
+
+## Roadmap
+
+V1:
+
+- [x] - html file text extraction
+- [ ] - better PDF table extraction
+- [ ] - batch APIs
+- [ ] - sync APIs
+
+V2:
+
+- [ ] - metadata extraction (breaking change)
+- [ ] - TBD
+
+## Contribution
+
+This library is open to contribution. Feel free to open issues or submit PRs. Its better to discuss issues before
+submitting PRs to avoid disappointment.
+
+### Local Development
+
+1. Clone the repo
+2. Install the system dependencies
+3. Install the full dependencies with `uv sync`
+4. Install the pre-commit hooks with:
+   ```shell
+   pre-commit install && pre-commit install --hook-type commit-msg
+   ```
+5. Make your changes and submit a PR
+
+## License
+
+This library uses the MIT license.

kreuzberg-1.5.0.dist-info/RECORD

@@ -0,0 +1,15 @@
+kreuzberg/__init__.py,sha256=5IBPjPsZ7faK15gFB9ZEROHhkEX7KKQmrHPCZuGnhb0,285
+kreuzberg/_extractors.py,sha256=k6xO_2ItaftPmlqzfXyxTn8rdaWdwrJHGziBbo7gCio,6599
+kreuzberg/_mime_types.py,sha256=0ZYtRrMAaKpCMDkhpTbWAXHCsVob5MFRMGlbni8iYSA,2573
+kreuzberg/_pandoc.py,sha256=DC6y_NN_CG9dF6fhAj3WumXqKIJLjYmnql2H53_KHnE,13766
+kreuzberg/_string.py,sha256=4txRDnkdR12oO6G8V-jXEMlA9ivgmw8E8EbjyhfL-W4,1106
+kreuzberg/_sync.py,sha256=ovsFHFdkcczz7gNEUJsbZzY8KHG0_GAOOYipQNE4hIY,874
+kreuzberg/_tesseract.py,sha256=nnhkjRIS0BSoovjMIqOlBEXlzngE0QJeFDe7BIqUik8,7872
+kreuzberg/exceptions.py,sha256=pxoEPS0T9e5QSgxsfXn1VmxsY_EGXvTwY0gETPiNn8E,945
+kreuzberg/extraction.py,sha256=gux3fkPIs8IbIKtRGuPFWJBLB5jO6Y9JsBfhHRcpQ0k,6160
+kreuzberg/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kreuzberg-1.5.0.dist-info/LICENSE,sha256=-8caMvpCK8SgZ5LlRKhGCMtYDEXqTKH9X8pFEhl91_4,1066
+kreuzberg-1.5.0.dist-info/METADATA,sha256=O462ss7M6Cb8cO6fJXwqsOdzkzaZekqa1oGwb7Vrgx8,9641
+kreuzberg-1.5.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+kreuzberg-1.5.0.dist-info/top_level.txt,sha256=rbGkygffkZiyKhL8UN41ZOjLfem0jJPA1Whtndne0rE,10
+kreuzberg-1.5.0.dist-info/RECORD,,

kreuzberg-1.3.0.dist-info/METADATA

@@ -1,306 +0,0 @@
-Metadata-Version: 2.2
-Name: kreuzberg
-Version: 1.3.0
-Summary: A text extraction library supporting PDFs, images, office documents and more
-Author-email: Na'aman Hirschfeld <nhirschfed@gmail.com>
-License: MIT
-Project-URL: homepage, https://github.com/Goldziher/kreuzberg
-Keywords: document-processing,docx,image-to-text,latex,markdown,ocr,odt,office-documents,pandoc,pdf,pdf-extraction,rag,text-extraction,text-processing
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3 :: Only
-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 :: Scientific/Engineering :: Artificial Intelligence
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Topic :: Text Processing :: General
-Classifier: Topic :: Utilities
-Classifier: Typing :: Typed
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: anyio>=4.8.0
-Requires-Dist: charset-normalizer>=3.4.1
-Requires-Dist: html-to-markdown>=1.2.0
-Requires-Dist: pypandoc>=1.15
-Requires-Dist: pypdfium2>=4.30.1
-Requires-Dist: pytesseract>=0.3.13
-Requires-Dist: python-pptx>=1.0.2
-Requires-Dist: typing-extensions>=4.12.2
-
-# Kreuzberg
-
-Kreuzberg is a library for simplified text extraction from PDF files. It's meant to offer simple, hassle free text
-extraction.
-
-Why?
-
-I am building, like many do now, a RAG focused service (checkout https://grantflow.ai). I have text extraction needs.
-There are quite a lot of commercial options out there, and several open-source + paid options.
-But I wanted something simple, which does not require expansive round-trips to an external API.
-Furthermore, I wanted something that is easy to run locally and isn't very heavy / requires a GPU.
-
-Hence, this library.
-
-## Features
-
-- Extract text from PDFs, images, office documents and more (see supported formats below)
-- Use modern Python with async (via `anyio`) and proper type hints
-- Extensive error handling for easy debugging
-
-## Installation
-
-1. Begin by installing the python package:
-
-   ```shell
-
-   pip install kreuzberg
-
-   ```
-
-2. Install the system dependencies:
-
-- [pandoc](https://pandoc.org/installing.html) (non-pdf text extraction, GPL v2.0 licensed but used via CLI only)
-- [tesseract-ocr](https://tesseract-ocr.github.io/) (for image/PDF OCR, Apache License)
-
-## Dependencies and Philosophy
-
-This library is built to be minimalist and simple. It also aims to utilize OSS tools for the job. Its fundamentally a
-high order async abstraction on top of other tools, think of it like the library you would bake in your code base, but
-polished and well maintained.
-
-### Dependencies
-
-- PDFs are processed using pdfium2 for searchable PDFs + Tesseract OCR for scanned documents
-- Images are processed using Tesseract OCR
-- Office documents and other formats are processed using Pandoc
-- PPTX files are converted using python-pptx
-- HTML files are converted using html-to-markdown
-- Plain text files are read directly with appropriate encoding detection
-
-### Roadmap
-
-V1:
-
-- [x] - html file text extraction
-- [ ] - better PDF table extraction
-- [ ] - TBD
-
-V2:
-
-- [ ] - extra install groups (to make dependencies optional)
-- [ ] - metadata extraction (possible breaking change)
-- [ ] - TBD
-
-### Feature Requests
-
-Feel free to open a discussion in GitHub or an issue if you have any feature requests
-
-### Contribution
-
-Is welcome! Read guidelines below.
-
-## Supported File Types
-
-Kreuzberg supports a wide range of file formats:
-
-### Document Formats
-
-- PDF (`.pdf`) - both searchable and scanned documents
-- Word Documents (`.docx`, `.doc`)
-- Power Point Presentations (`.pptx`)
-- OpenDocument Text (`.odt`)
-- Rich Text Format (`.rtf`)
-
-### Image Formats
-
-- JPEG, JPG (`.jpg`, `.jpeg`, `.pjpeg`)
-- PNG (`.png`)
-- TIFF (`.tiff`, `.tif`)
-- BMP (`.bmp`)
-- GIF (`.gif`)
-- WebP (`.webp`)
-- JPEG 2000 (`.jp2`, `.jpx`, `.jpm`, `.mj2`)
-- Portable Anymap (`.pnm`)
-- Portable Bitmap (`.pbm`)
-- Portable Graymap (`.pgm`)
-- Portable Pixmap (`.ppm`)
-
-#### Text and Markup Formats
-
-- HTML (`.html`, `.htm`)
-- Plain Text (`.txt`)
-- Markdown (`.md`)
-- reStructuredText (`.rst`)
-- LaTeX (`.tex`)
-
-#### Data Formats
-
-- Comma-Separated Values (`.csv`)
-- Tab-Separated Values (`.tsv`)
-
-## Usage
-
-Kreuzberg exports two async functions:
-
-- Extract text from a file (string path or `pathlib.Path`) using `extract_file()`
-- Extract text from a byte-string using `extract_bytes()`
-
-### Extract from File
-
-```python
-from pathlib import Path
-from kreuzberg import extract_file
-
-
-# Extract text from a PDF file
-async def extract_pdf():
-    result = await extract_file("document.pdf")
-    print(f"Extracted text: {result.content}")
-    print(f"Output mime type: {result.mime_type}")
-
-
-# Extract text from an image
-async def extract_image():
-    result = await extract_file("scan.png")
-    print(f"Extracted text: {result.content}")
-
-
-# or use Path
-
-async def extract_pdf():
-    result = await extract_file(Path("document.pdf"))
-    print(f"Extracted text: {result.content}")
-    print(f"Output mime type: {result.mime_type}")
-```
-
-### Extract from Bytes
-
-```python
-from kreuzberg import extract_bytes
-
-
-# Extract text from PDF bytes
-async def process_uploaded_pdf(pdf_content: bytes):
-    result = await extract_bytes(pdf_content, mime_type="application/pdf")
-    return result.content
-
-
-# Extract text from image bytes
-async def process_uploaded_image(image_content: bytes):
-    result = await extract_bytes(image_content, mime_type="image/jpeg")
-    return result.content
-```
-
-### Forcing OCR
-
-When extracting a PDF file or bytes, you might want to force OCR - for example, if the PDF includes images that have text that should be extracted etc.
-You can do this by passing `force_ocr=True`:
-
-```python
-from kreuzberg import extract_bytes
-
-
-# Extract text from PDF bytes and force OCR
-async def process_uploaded_pdf(pdf_content: bytes):
-    result = await extract_bytes(pdf_content, mime_type="application/pdf", force_ocr=True)
-    return result.content
-```
-
-### Error Handling
-
-Kreuzberg raises two exception types:
-
-#### ValidationError
-
-Raised when there are issues with input validation:
-
-- Unsupported mime types
-- Undetectable mime types
-- Path doesn't point at an exist file
-
-#### ParsingError
-
-Raised when there are issues during the text extraction process:
-
-- PDF parsing failures
-- OCR errors
-- Pandoc conversion errors
-
-```python
-from kreuzberg import extract_file
-from kreuzberg.exceptions import ValidationError, ParsingError
-
-
-async def safe_extract():
-    try:
-        result = await extract_file("document.doc")
-        return result.content
-    except ValidationError as e:
-        print(f"Validation error: {e.message}")
-        print(f"Context: {e.context}")
-    except ParsingError as e:
-        print(f"Parsing error: {e.message}")
-        print(f"Context: {e.context}")  # Contains detailed error information
-```
-
-Both error types include helpful context information for debugging:
-
-```python
-try:
-    result = await extract_file("scanned.pdf")
-except ParsingError as e:
-# e.context might contain:
-# {
-#    "file_path": "scanned.pdf",
-#    "error": "Tesseract OCR failed: Unable to process image"
-# }
-```
-
-### ExtractionResult
-
-All extraction functions return an ExtractionResult named tuple containing:
-
-- `content`: The extracted text as a string
-- `mime_type`: The mime type of the output (either "text/plain" or, if pandoc is used- "text/markdown")
-
-```python
-from kreuzberg import ExtractionResult
-
-
-async def process_document(path: str) -> str:
-    result: ExtractionResult = await extract_file(path)
-    return result.content
-
-
-# or access the result as tuple
-
-async def process_document(path: str) -> str:
-    content, mime_type = await extract_file(path)
-    # do something with mime_type
-    return content
-```
-
-## Contribution
-
-This library is open to contribution. Feel free to open issues or submit PRs. Its better to discuss issues before
-submitting PRs to avoid disappointment.
-
-### Local Development
-
-1. Clone the repo
-2. Install the system dependencies
-3. Install the full dependencies with `uv sync`
-4. Install the pre-commit hooks with:
-   ```shell
-   pre-commit install && pre-commit install --hook-type commit-msg
-   ```
-5. Make your changes and submit a PR
-
-## License
-
-This library uses the MIT license.

kreuzberg-1.3.0.dist-info/RECORD

@@ -1,13 +0,0 @@
-kreuzberg/__init__.py,sha256=5IBPjPsZ7faK15gFB9ZEROHhkEX7KKQmrHPCZuGnhb0,285
-kreuzberg/_extractors.py,sha256=eiWPpjnZOZFDwlQL4XsgavJEWqxGtzLVvS8YU28RBAo,8095
-kreuzberg/_mime_types.py,sha256=hR6LFXWn8dtCDB05PkADYk2l__HpmETNyf4YFixhecE,2918
-kreuzberg/_string.py,sha256=O023sxdYoC4DhFCU1z430UBdbxqwXKmyymUDDx3J_i8,1156
-kreuzberg/_sync.py,sha256=ovsFHFdkcczz7gNEUJsbZzY8KHG0_GAOOYipQNE4hIY,874
-kreuzberg/exceptions.py,sha256=jrXyvcuSU-694OEtXPZfHYcUbpoRZzNKw9Lo3wIZwL0,770
-kreuzberg/extraction.py,sha256=cgX8uoCVXf-Va30g8T8DwrZUqsSPHIzmPfDgnWOqNNU,6148
-kreuzberg/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kreuzberg-1.3.0.dist-info/LICENSE,sha256=-8caMvpCK8SgZ5LlRKhGCMtYDEXqTKH9X8pFEhl91_4,1066
-kreuzberg-1.3.0.dist-info/METADATA,sha256=3wiaAuaiA865lg5oCjwlAKaZqRQn1w8VqaQXeoEdip4,8579
-kreuzberg-1.3.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-kreuzberg-1.3.0.dist-info/top_level.txt,sha256=rbGkygffkZiyKhL8UN41ZOjLfem0jJPA1Whtndne0rE,10
-kreuzberg-1.3.0.dist-info/RECORD,,