| Name | doctra JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | https://github.com/AdemBoukhris457/Doctra |
| Summary | Parse, extract, and analyze documents with ease |
| upload_time | 2025-08-26 16:36:25 |
| maintainer | None |
| docs_url | None |
| author | Adem Boukhris |
| requires_python | >=3.8 |
| license | 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 [yyyy] [name of copyright owner]
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.
|
| keywords |
pdf
parser
document
extraction
ocr
layout-detection
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 🚀 **Doctra - Document Parser Library** 📑🔎
<div align="center">
[](https://github.com/AdemBoukhris457/Doctra/stargazers)
[](https://github.com/AdemBoukhris457/Doctra/forks)
</div>
## 📋 Table of Contents
- [Installation](#installation)
- [Quick Start](#quick-start)
- [Core Components](#core-components)
- [StructuredPDFParser](#structuredpdfparser)
- [ChartTablePDFParser](#charttablepdfparser)
- [Visualization](#visualization)
- [Usage Examples](#usage-examples)
- [Features](#features)
- [Requirements](#requirements)
## 🛠️ Installation
### From PyPI (recommended)
```bash
pip install doctra
```
### From source
```bash
git clone https://github.com/AdemBoukhris457/Doctra.git
cd Doctra
pip install .
```
## ⚡ Quick Start
```python
from doctra.parsers.structured_pdf_parser import StructuredPDFParser
# Initialize the parser
parser = StructuredPDFParser()
# Parse a PDF document
parser.parse("path/to/your/document.pdf")
```
## 🔧 Core Components
### StructuredPDFParser
The `StructuredPDFParser` is a comprehensive PDF parser that extracts all types of content from PDF documents. It processes PDFs through layout detection, extracts text using OCR, saves images for visual elements, and optionally converts charts/tables to structured data using Vision Language Models (VLM).
#### Key Features:
- **Layout Detection**: Uses PaddleOCR for accurate document layout analysis
- **OCR Processing**: Extracts text from all document elements
- **Visual Element Extraction**: Saves figures, charts, and tables as images
- **VLM Integration**: Optional conversion of visual elements to structured data
- **Multiple Output Formats**: Generates Markdown, Excel, and structured JSON
#### Basic Usage:
```python
from doctra.parsers.structured_pdf_parser import StructuredPDFParser
# Basic parser without VLM
parser = StructuredPDFParser()
# Parser with VLM for structured data extraction
parser = StructuredPDFParser(
use_vlm=True,
vlm_provider="openai", # or "gemini"
vlm_api_key="your_api_key_here"
)
# Parse document
parser.parse("document.pdf")
```
#### Advanced Configuration:
```python
parser = StructuredPDFParser(
# VLM Settings
use_vlm=True,
vlm_provider="openai",
vlm_model="gpt-4o",
vlm_api_key="your_api_key",
# Layout Detection Settings
layout_model_name="PP-DocLayout_plus-L",
dpi=200,
min_score=0.0,
# OCR Settings
ocr_lang="eng",
ocr_psm=4,
ocr_oem=3,
ocr_extra_config="",
# Output Settings
box_separator="\n"
)
```
### ChartTablePDFParser
The `ChartTablePDFParser` is a specialized parser focused specifically on extracting charts and tables from PDF documents. It's optimized for scenarios where you only need these specific elements, providing faster processing and more targeted output.
#### Key Features:
- **Focused Extraction**: Extracts only charts and/or tables
- **Selective Processing**: Choose to extract charts, tables, or both
- **VLM Integration**: Optional conversion to structured data
- **Organized Output**: Separate directories for charts and tables
- **Progress Tracking**: Real-time progress bars for extraction
#### Basic Usage:
```python
from doctra.parsers.table_chart_extractor import ChartTablePDFParser
# Extract both charts and tables
parser = ChartTablePDFParser(
extract_charts=True,
extract_tables=True
)
# Extract only charts
parser = ChartTablePDFParser(
extract_charts=True,
extract_tables=False
)
# Parse with custom output directory
parser.parse("document.pdf", output_base_dir="my_outputs")
```
#### Advanced Configuration:
```python
parser = ChartTablePDFParser(
# Extraction Settings
extract_charts=True,
extract_tables=True,
# VLM Settings
use_vlm=True,
vlm_provider="openai",
vlm_model="gpt-4o",
vlm_api_key="your_api_key",
# Layout Detection Settings
layout_model_name="PP-DocLayout_plus-L",
dpi=200,
min_score=0.0
)
```
## 🎨 Visualization
Doctra provides powerful visualization capabilities to help you understand how the layout detection works and verify the accuracy of element extraction.
### Layout Detection Visualization
The `StructuredPDFParser` includes a built-in visualization method that displays PDF pages with bounding boxes overlaid on detected elements. This is perfect for:
- **Debugging**: Verify that layout detection is working correctly
- **Quality Assurance**: Check the accuracy of element identification
- **Documentation**: Create visual documentation of extraction results
- **Analysis**: Understand document structure and layout patterns
#### Basic Visualization:
```python
from doctra.parsers.structured_pdf_parser import StructuredPDFParser
# Initialize parser
parser = StructuredPDFParser()
# Display visualization (opens in default image viewer)
parser.display_pages_with_boxes("document.pdf")
```
#### Advanced Visualization with Custom Settings:
```python
# Custom visualization configuration
parser.display_pages_with_boxes(
pdf_path="document.pdf",
num_pages=5, # Number of pages to visualize
cols=3, # Number of columns in grid
page_width=600, # Width of each page in pixels
spacing=30, # Spacing between pages
save_path="layout_visualization.png" # Save to file instead of displaying
)
```
#### Visualization Features:
- **Color-coded Elements**: Each element type (text, table, chart, figure) has a distinct color
- **Confidence Scores**: Shows detection confidence for each element
- **Grid Layout**: Multiple pages displayed in an organized grid
- **Interactive Legend**: Color legend showing all detected element types
- **High Quality**: High-resolution output suitable for documentation
- **Flexible Output**: Display on screen or save to file
#### Example Output:
The visualization shows:
- **Blue boxes**: Text elements
- **Red boxes**: Tables
- **Green boxes**: Charts
- **Orange boxes**: Figures
- **Labels**: Element type and confidence score (e.g., "table (0.95)")
- **Page titles**: Page number and element count
- **Summary statistics**: Total elements detected by type
### Use Cases for Visualization:
1. **Document Analysis**: Quickly assess document structure and complexity
2. **Quality Control**: Verify extraction accuracy before processing
3. **Debugging**: Identify issues with layout detection
4. **Documentation**: Create visual reports of extraction results
5. **Training**: Help users understand how the system works
### Visualization Configuration Options:
| Parameter | Default | Description |
|-----------|---------|-------------|
| `num_pages` | 3 | Number of pages to visualize |
| `cols` | 2 | Number of columns in grid layout |
| `page_width` | 800 | Width of each page in pixels |
| `spacing` | 40 | Spacing between pages in pixels |
| `save_path` | None | Path to save visualization (if None, displays on screen) |
## 📖 Usage Examples
### Example 1: Basic Document Processing
```python
from doctra.parsers.structured_pdf_parser import StructuredPDFParser
# Initialize parser
parser = StructuredPDFParser()
# Process document
parser.parse("financial_report.pdf")
# Output will be saved to: outputs/financial_report/
# - Extracted text content
# - Cropped images of figures, charts, and tables
# - Markdown file with all content
```
### Example 2: Chart and Table Extraction with VLM
```python
from doctra.parsers.table_chart_extractor import ChartTablePDFParser
# Initialize parser with VLM
parser = ChartTablePDFParser(
extract_charts=True,
extract_tables=True,
use_vlm=True,
vlm_provider="openai",
vlm_api_key="your_gemini_api_key"
)
# Process document
parser.parse("data_report.pdf", output_base_dir="extracted_data")
# Output will include:
# - Cropped chart and table images
# - Structured data in Excel format
# - Markdown tables with extracted data
```
### Example 3: Custom Configuration
```python
from doctra.parsers.structured_pdf_parser import StructuredPDFParser
# Custom configuration for high-quality processing
parser = StructuredPDFParser(
use_vlm=True,
vlm_provider="openai",
vlm_api_key="your_openai_api_key",
vlm__model="gpt-4o",
layout_model_name="PP-DocLayout_plus-L",
dpi=300, # Higher DPI for better quality
min_score=0.5, # Higher confidence threshold
ocr_lang="eng",
ocr_psm=6, # Uniform block of text
box_separator="\n\n" # Double line breaks between elements
)
parser.parse("complex_document.pdf")
```
### Example 4: Layout Visualization
```python
from doctra.parsers.structured_pdf_parser import StructuredPDFParser
# Initialize parser
parser = StructuredPDFParser()
# Create a comprehensive visualization
parser.display_pages_with_boxes(
pdf_path="research_paper.pdf",
num_pages=6, # Visualize first 6 pages
cols=2, # 2 columns layout
page_width=700, # Larger pages for better detail
spacing=50, # More spacing between pages
save_path="research_paper_layout.png" # Save for documentation
)
# For quick preview (displays on screen)
parser.display_pages_with_boxes("document.pdf")
```
## ✨ Features
### 🔍 Layout Detection
- Advanced document layout analysis using PaddleOCR
- Accurate identification of text, tables, charts, and figures
- Configurable confidence thresholds
### 📝 OCR Processing
- High-quality text extraction using Tesseract
- Support for multiple languages
- Configurable OCR parameters
### 🖼️ Visual Element Extraction
- Automatic cropping and saving of figures, charts, and tables
- Organized output directory structure
- High-resolution image preservation
### 🤖 VLM Integration
- Vision Language Model support for structured data extraction
- Multiple provider options (Gemini, OpenAI)
- Automatic conversion of charts and tables to structured formats
### 📊 Multiple Output Formats
- **Markdown**: Human-readable document with embedded images and tables
- **Excel**: Structured data in spreadsheet format
- **JSON**: Programmatically accessible structured data
- **Images**: High-quality cropped visual elements
### ⚙️ Flexible Configuration
- Extensive customization options
- Performance tuning parameters
- Output format selection
## 📋 Requirements
### Core Dependencies
- **PaddleOCR**: Document layout detection
- **Outlines**: Structured output generation
- **Tesseract**: OCR text extraction
- **Pillow**: Image processing
- **OpenCV**: Computer vision operations
- **Pandas**: Data manipulation
- **OpenPyXL**: Excel file generation
- **Google Generative AI**: For Gemini VLM integration
- **OpenAI**: For GPT-4 VLM integration
Raw data
{
"_id": null,
"home_page": "https://github.com/AdemBoukhris457/Doctra",
"name": "doctra",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "pdf, parser, document, extraction, ocr, layout-detection",
"author": "Adem Boukhris",
"author_email": "Adem Boukhris <boukhrisadam98@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/60/2d/16a286f5d18eaa40ea1dc0473f2dac545297ab66e38a966a686be18bbe49/doctra-0.1.0.tar.gz",
"platform": null,
"description": "# \ud83d\ude80 **Doctra - Document Parser Library** \ud83d\udcd1\ud83d\udd0e\r\n\r\n\r\n\r\n<div align=\"center\">\r\n\r\n[](https://github.com/AdemBoukhris457/Doctra/stargazers)\r\n[](https://github.com/AdemBoukhris457/Doctra/forks)\r\n\r\n</div>\r\n\r\n## \ud83d\udccb Table of Contents\r\n\r\n- [Installation](#installation)\r\n- [Quick Start](#quick-start)\r\n- [Core Components](#core-components)\r\n - [StructuredPDFParser](#structuredpdfparser)\r\n - [ChartTablePDFParser](#charttablepdfparser)\r\n- [Visualization](#visualization)\r\n- [Usage Examples](#usage-examples)\r\n- [Features](#features)\r\n- [Requirements](#requirements)\r\n\r\n## \ud83d\udee0\ufe0f Installation\r\n\r\n### From PyPI (recommended)\r\n\r\n```bash\r\npip install doctra\r\n```\r\n\r\n### From source\r\n\r\n```bash\r\ngit clone https://github.com/AdemBoukhris457/Doctra.git\r\ncd Doctra\r\npip install .\r\n```\r\n\r\n## \u26a1 Quick Start\r\n\r\n```python\r\nfrom doctra.parsers.structured_pdf_parser import StructuredPDFParser\r\n\r\n# Initialize the parser\r\nparser = StructuredPDFParser()\r\n\r\n# Parse a PDF document\r\nparser.parse(\"path/to/your/document.pdf\")\r\n```\r\n\r\n## \ud83d\udd27 Core Components\r\n\r\n### StructuredPDFParser\r\n\r\nThe `StructuredPDFParser` is a comprehensive PDF parser that extracts all types of content from PDF documents. It processes PDFs through layout detection, extracts text using OCR, saves images for visual elements, and optionally converts charts/tables to structured data using Vision Language Models (VLM).\r\n\r\n#### Key Features:\r\n- **Layout Detection**: Uses PaddleOCR for accurate document layout analysis\r\n- **OCR Processing**: Extracts text from all document elements\r\n- **Visual Element Extraction**: Saves figures, charts, and tables as images\r\n- **VLM Integration**: Optional conversion of visual elements to structured data\r\n- **Multiple Output Formats**: Generates Markdown, Excel, and structured JSON\r\n\r\n#### Basic Usage:\r\n\r\n```python\r\nfrom doctra.parsers.structured_pdf_parser import StructuredPDFParser\r\n\r\n# Basic parser without VLM\r\nparser = StructuredPDFParser()\r\n\r\n# Parser with VLM for structured data extraction\r\nparser = StructuredPDFParser(\r\n use_vlm=True,\r\n vlm_provider=\"openai\", # or \"gemini\"\r\n vlm_api_key=\"your_api_key_here\"\r\n)\r\n\r\n# Parse document\r\nparser.parse(\"document.pdf\")\r\n```\r\n\r\n#### Advanced Configuration:\r\n\r\n```python\r\nparser = StructuredPDFParser(\r\n # VLM Settings\r\n use_vlm=True,\r\n vlm_provider=\"openai\",\r\n vlm_model=\"gpt-4o\",\r\n vlm_api_key=\"your_api_key\",\r\n \r\n # Layout Detection Settings\r\n layout_model_name=\"PP-DocLayout_plus-L\",\r\n dpi=200,\r\n min_score=0.0,\r\n \r\n # OCR Settings\r\n ocr_lang=\"eng\",\r\n ocr_psm=4,\r\n ocr_oem=3,\r\n ocr_extra_config=\"\",\r\n \r\n # Output Settings\r\n box_separator=\"\\n\"\r\n)\r\n```\r\n\r\n### ChartTablePDFParser\r\n\r\nThe `ChartTablePDFParser` is a specialized parser focused specifically on extracting charts and tables from PDF documents. It's optimized for scenarios where you only need these specific elements, providing faster processing and more targeted output.\r\n\r\n#### Key Features:\r\n- **Focused Extraction**: Extracts only charts and/or tables\r\n- **Selective Processing**: Choose to extract charts, tables, or both\r\n- **VLM Integration**: Optional conversion to structured data\r\n- **Organized Output**: Separate directories for charts and tables\r\n- **Progress Tracking**: Real-time progress bars for extraction\r\n\r\n#### Basic Usage:\r\n\r\n```python\r\nfrom doctra.parsers.table_chart_extractor import ChartTablePDFParser\r\n\r\n# Extract both charts and tables\r\nparser = ChartTablePDFParser(\r\n extract_charts=True,\r\n extract_tables=True\r\n)\r\n\r\n# Extract only charts\r\nparser = ChartTablePDFParser(\r\n extract_charts=True,\r\n extract_tables=False\r\n)\r\n\r\n# Parse with custom output directory\r\nparser.parse(\"document.pdf\", output_base_dir=\"my_outputs\")\r\n```\r\n\r\n#### Advanced Configuration:\r\n\r\n```python\r\nparser = ChartTablePDFParser(\r\n # Extraction Settings\r\n extract_charts=True,\r\n extract_tables=True,\r\n \r\n # VLM Settings\r\n use_vlm=True,\r\n vlm_provider=\"openai\",\r\n vlm_model=\"gpt-4o\",\r\n vlm_api_key=\"your_api_key\",\r\n \r\n # Layout Detection Settings\r\n layout_model_name=\"PP-DocLayout_plus-L\",\r\n dpi=200,\r\n min_score=0.0\r\n)\r\n```\r\n\r\n## \ud83c\udfa8 Visualization\r\n\r\nDoctra provides powerful visualization capabilities to help you understand how the layout detection works and verify the accuracy of element extraction.\r\n\r\n### Layout Detection Visualization\r\n\r\nThe `StructuredPDFParser` includes a built-in visualization method that displays PDF pages with bounding boxes overlaid on detected elements. This is perfect for:\r\n\r\n- **Debugging**: Verify that layout detection is working correctly\r\n- **Quality Assurance**: Check the accuracy of element identification\r\n- **Documentation**: Create visual documentation of extraction results\r\n- **Analysis**: Understand document structure and layout patterns\r\n\r\n#### Basic Visualization:\r\n\r\n```python\r\nfrom doctra.parsers.structured_pdf_parser import StructuredPDFParser\r\n\r\n# Initialize parser\r\nparser = StructuredPDFParser()\r\n\r\n# Display visualization (opens in default image viewer)\r\nparser.display_pages_with_boxes(\"document.pdf\")\r\n```\r\n\r\n#### Advanced Visualization with Custom Settings:\r\n\r\n```python\r\n# Custom visualization configuration\r\nparser.display_pages_with_boxes(\r\n pdf_path=\"document.pdf\",\r\n num_pages=5, # Number of pages to visualize\r\n cols=3, # Number of columns in grid\r\n page_width=600, # Width of each page in pixels\r\n spacing=30, # Spacing between pages\r\n save_path=\"layout_visualization.png\" # Save to file instead of displaying\r\n)\r\n```\r\n\r\n#### Visualization Features:\r\n\r\n- **Color-coded Elements**: Each element type (text, table, chart, figure) has a distinct color\r\n- **Confidence Scores**: Shows detection confidence for each element\r\n- **Grid Layout**: Multiple pages displayed in an organized grid\r\n- **Interactive Legend**: Color legend showing all detected element types\r\n- **High Quality**: High-resolution output suitable for documentation\r\n- **Flexible Output**: Display on screen or save to file\r\n\r\n#### Example Output:\r\n\r\nThe visualization shows:\r\n- **Blue boxes**: Text elements\r\n- **Red boxes**: Tables\r\n- **Green boxes**: Charts\r\n- **Orange boxes**: Figures\r\n- **Labels**: Element type and confidence score (e.g., \"table (0.95)\")\r\n- **Page titles**: Page number and element count\r\n- **Summary statistics**: Total elements detected by type\r\n\r\n### Use Cases for Visualization:\r\n\r\n1. **Document Analysis**: Quickly assess document structure and complexity\r\n2. **Quality Control**: Verify extraction accuracy before processing\r\n3. **Debugging**: Identify issues with layout detection\r\n4. **Documentation**: Create visual reports of extraction results\r\n5. **Training**: Help users understand how the system works\r\n\r\n### Visualization Configuration Options:\r\n\r\n| Parameter | Default | Description |\r\n|-----------|---------|-------------|\r\n| `num_pages` | 3 | Number of pages to visualize |\r\n| `cols` | 2 | Number of columns in grid layout |\r\n| `page_width` | 800 | Width of each page in pixels |\r\n| `spacing` | 40 | Spacing between pages in pixels |\r\n| `save_path` | None | Path to save visualization (if None, displays on screen) |\r\n\r\n## \ud83d\udcd6 Usage Examples\r\n\r\n### Example 1: Basic Document Processing\r\n\r\n```python\r\nfrom doctra.parsers.structured_pdf_parser import StructuredPDFParser\r\n\r\n# Initialize parser\r\nparser = StructuredPDFParser()\r\n\r\n# Process document\r\nparser.parse(\"financial_report.pdf\")\r\n\r\n# Output will be saved to: outputs/financial_report/\r\n# - Extracted text content\r\n# - Cropped images of figures, charts, and tables\r\n# - Markdown file with all content\r\n```\r\n\r\n### Example 2: Chart and Table Extraction with VLM\r\n\r\n```python\r\nfrom doctra.parsers.table_chart_extractor import ChartTablePDFParser\r\n\r\n# Initialize parser with VLM\r\nparser = ChartTablePDFParser(\r\n extract_charts=True,\r\n extract_tables=True,\r\n use_vlm=True,\r\n vlm_provider=\"openai\",\r\n vlm_api_key=\"your_gemini_api_key\"\r\n)\r\n\r\n# Process document\r\nparser.parse(\"data_report.pdf\", output_base_dir=\"extracted_data\")\r\n\r\n# Output will include:\r\n# - Cropped chart and table images\r\n# - Structured data in Excel format\r\n# - Markdown tables with extracted data\r\n```\r\n\r\n### Example 3: Custom Configuration\r\n\r\n```python\r\nfrom doctra.parsers.structured_pdf_parser import StructuredPDFParser\r\n\r\n# Custom configuration for high-quality processing\r\nparser = StructuredPDFParser(\r\n use_vlm=True,\r\n vlm_provider=\"openai\",\r\n vlm_api_key=\"your_openai_api_key\",\r\n vlm__model=\"gpt-4o\",\r\n layout_model_name=\"PP-DocLayout_plus-L\",\r\n dpi=300, # Higher DPI for better quality\r\n min_score=0.5, # Higher confidence threshold\r\n ocr_lang=\"eng\",\r\n ocr_psm=6, # Uniform block of text\r\n box_separator=\"\\n\\n\" # Double line breaks between elements\r\n)\r\n\r\nparser.parse(\"complex_document.pdf\")\r\n```\r\n\r\n### Example 4: Layout Visualization\r\n\r\n```python\r\nfrom doctra.parsers.structured_pdf_parser import StructuredPDFParser\r\n\r\n# Initialize parser\r\nparser = StructuredPDFParser()\r\n\r\n# Create a comprehensive visualization\r\nparser.display_pages_with_boxes(\r\n pdf_path=\"research_paper.pdf\",\r\n num_pages=6, # Visualize first 6 pages\r\n cols=2, # 2 columns layout\r\n page_width=700, # Larger pages for better detail\r\n spacing=50, # More spacing between pages\r\n save_path=\"research_paper_layout.png\" # Save for documentation\r\n)\r\n\r\n# For quick preview (displays on screen)\r\nparser.display_pages_with_boxes(\"document.pdf\")\r\n```\r\n\r\n## \u2728 Features\r\n\r\n### \ud83d\udd0d Layout Detection\r\n- Advanced document layout analysis using PaddleOCR\r\n- Accurate identification of text, tables, charts, and figures\r\n- Configurable confidence thresholds\r\n\r\n### \ud83d\udcdd OCR Processing\r\n- High-quality text extraction using Tesseract\r\n- Support for multiple languages\r\n- Configurable OCR parameters\r\n\r\n### \ud83d\uddbc\ufe0f Visual Element Extraction\r\n- Automatic cropping and saving of figures, charts, and tables\r\n- Organized output directory structure\r\n- High-resolution image preservation\r\n\r\n### \ud83e\udd16 VLM Integration\r\n- Vision Language Model support for structured data extraction\r\n- Multiple provider options (Gemini, OpenAI)\r\n- Automatic conversion of charts and tables to structured formats\r\n\r\n### \ud83d\udcca Multiple Output Formats\r\n- **Markdown**: Human-readable document with embedded images and tables\r\n- **Excel**: Structured data in spreadsheet format\r\n- **JSON**: Programmatically accessible structured data\r\n- **Images**: High-quality cropped visual elements\r\n\r\n### \u2699\ufe0f Flexible Configuration\r\n- Extensive customization options\r\n- Performance tuning parameters\r\n- Output format selection\r\n\r\n## \ud83d\udccb Requirements\r\n\r\n### Core Dependencies\r\n- **PaddleOCR**: Document layout detection\r\n- **Outlines**: Structured output generation\r\n- **Tesseract**: OCR text extraction\r\n- **Pillow**: Image processing\r\n- **OpenCV**: Computer vision operations\r\n- **Pandas**: Data manipulation\r\n- **OpenPyXL**: Excel file generation\r\n- **Google Generative AI**: For Gemini VLM integration\r\n- **OpenAI**: For GPT-4 VLM integration\r\n",
"bugtrack_url": null,
"license": "Apache License\r\n Version 2.0, January 2004\r\n http://www.apache.org/licenses/\r\n \r\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\r\n \r\n 1. Definitions.\r\n \r\n \"License\" shall mean the terms and conditions for use, reproduction,\r\n and distribution as defined by Sections 1 through 9 of this document.\r\n \r\n \"Licensor\" shall mean the copyright owner or entity authorized by\r\n the copyright owner that is granting the License.\r\n \r\n \"Legal Entity\" shall mean the union of the acting entity and all\r\n other entities that control, are controlled by, or are under common\r\n control with that entity. For the purposes of this definition,\r\n \"control\" means (i) the power, direct or indirect, to cause the\r\n direction or management of such entity, whether by contract or\r\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\r\n outstanding shares, or (iii) beneficial ownership of such entity.\r\n \r\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\r\n exercising permissions granted by this License.\r\n \r\n \"Source\" form shall mean the preferred form for making modifications,\r\n including but not limited to software source code, documentation\r\n source, and configuration files.\r\n \r\n \"Object\" form shall mean any form resulting from mechanical\r\n transformation or translation of a Source form, including but\r\n not limited to compiled object code, generated documentation,\r\n and conversions to other media types.\r\n \r\n \"Work\" shall mean the work of authorship, whether in Source or\r\n Object form, made available under the License, as indicated by a\r\n copyright notice that is included in or attached to the work\r\n (an example is provided in the Appendix below).\r\n \r\n \"Derivative Works\" shall mean any work, whether in Source or Object\r\n form, that is based on (or derived from) the Work and for which the\r\n editorial revisions, annotations, elaborations, or other modifications\r\n represent, as a whole, an original work of authorship. For the purposes\r\n of this License, Derivative Works shall not include works that remain\r\n separable from, or merely link (or bind by name) to the interfaces of,\r\n the Work and Derivative Works thereof.\r\n \r\n \"Contribution\" shall mean any work of authorship, including\r\n the original version of the Work and any modifications or additions\r\n to that Work or Derivative Works thereof, that is intentionally\r\n submitted to Licensor for inclusion in the Work by the copyright owner\r\n or by an individual or Legal Entity authorized to submit on behalf of\r\n the copyright owner. For the purposes of this definition, \"submitted\"\r\n means any form of electronic, verbal, or written communication sent\r\n to the Licensor or its representatives, including but not limited to\r\n communication on electronic mailing lists, source code control systems,\r\n and issue tracking systems that are managed by, or on behalf of, the\r\n Licensor for the purpose of discussing and improving the Work, but\r\n excluding communication that is conspicuously marked or otherwise\r\n designated in writing by the copyright owner as \"Not a Contribution.\"\r\n \r\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\r\n on behalf of whom a Contribution has been received by Licensor and\r\n subsequently incorporated within the Work.\r\n \r\n 2. Grant of Copyright License. Subject to the terms and conditions of\r\n this License, each Contributor hereby grants to You a perpetual,\r\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\r\n copyright license to reproduce, prepare Derivative Works of,\r\n publicly display, publicly perform, sublicense, and distribute the\r\n Work and such Derivative Works in Source or Object form.\r\n \r\n 3. Grant of Patent License. Subject to the terms and conditions of\r\n this License, each Contributor hereby grants to You a perpetual,\r\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\r\n (except as stated in this section) patent license to make, have made,\r\n use, offer to sell, sell, import, and otherwise transfer the Work,\r\n where such license applies only to those patent claims licensable\r\n by such Contributor that are necessarily infringed by their\r\n Contribution(s) alone or by combination of their Contribution(s)\r\n with the Work to which such Contribution(s) was submitted. If You\r\n institute patent litigation against any entity (including a\r\n cross-claim or counterclaim in a lawsuit) alleging that the Work\r\n or a Contribution incorporated within the Work constitutes direct\r\n or contributory patent infringement, then any patent licenses\r\n granted to You under this License for that Work shall terminate\r\n as of the date such litigation is filed.\r\n \r\n 4. Redistribution. You may reproduce and distribute copies of the\r\n Work or Derivative Works thereof in any medium, with or without\r\n modifications, and in Source or Object form, provided that You\r\n meet the following conditions:\r\n \r\n (a) You must give any other recipients of the Work or\r\n Derivative Works a copy of this License; and\r\n \r\n (b) You must cause any modified files to carry prominent notices\r\n stating that You changed the files; and\r\n \r\n (c) You must retain, in the Source form of any Derivative Works\r\n that You distribute, all copyright, patent, trademark, and\r\n attribution notices from the Source form of the Work,\r\n excluding those notices that do not pertain to any part of\r\n the Derivative Works; and\r\n \r\n (d) If the Work includes a \"NOTICE\" text file as part of its\r\n distribution, then any Derivative Works that You distribute must\r\n include a readable copy of the attribution notices contained\r\n within such NOTICE file, excluding those notices that do not\r\n pertain to any part of the Derivative Works, in at least one\r\n of the following places: within a NOTICE text file distributed\r\n as part of the Derivative Works; within the Source form or\r\n documentation, if provided along with the Derivative Works; or,\r\n within a display generated by the Derivative Works, if and\r\n wherever such third-party notices normally appear. The contents\r\n of the NOTICE file are for informational purposes only and\r\n do not modify the License. You may add Your own attribution\r\n notices within Derivative Works that You distribute, alongside\r\n or as an addendum to the NOTICE text from the Work, provided\r\n that such additional attribution notices cannot be construed\r\n as modifying the License.\r\n \r\n You may add Your own copyright statement to Your modifications and\r\n may provide additional or different license terms and conditions\r\n for use, reproduction, or distribution of Your modifications, or\r\n for any such Derivative Works as a whole, provided Your use,\r\n reproduction, and distribution of the Work otherwise complies with\r\n the conditions stated in this License.\r\n \r\n 5. Submission of Contributions. Unless You explicitly state otherwise,\r\n any Contribution intentionally submitted for inclusion in the Work\r\n by You to the Licensor shall be under the terms and conditions of\r\n this License, without any additional terms or conditions.\r\n Notwithstanding the above, nothing herein shall supersede or modify\r\n the terms of any separate license agreement you may have executed\r\n with Licensor regarding such Contributions.\r\n \r\n 6. Trademarks. This License does not grant permission to use the trade\r\n names, trademarks, service marks, or product names of the Licensor,\r\n except as required for reasonable and customary use in describing the\r\n origin of the Work and reproducing the content of the NOTICE file.\r\n \r\n 7. Disclaimer of Warranty. Unless required by applicable law or\r\n agreed to in writing, Licensor provides the Work (and each\r\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\r\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\r\n implied, including, without limitation, any warranties or conditions\r\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\r\n PARTICULAR PURPOSE. You are solely responsible for determining the\r\n appropriateness of using or redistributing the Work and assume any\r\n risks associated with Your exercise of permissions under this License.\r\n \r\n 8. Limitation of Liability. In no event and under no legal theory,\r\n whether in tort (including negligence), contract, or otherwise,\r\n unless required by applicable law (such as deliberate and grossly\r\n negligent acts) or agreed to in writing, shall any Contributor be\r\n liable to You for damages, including any direct, indirect, special,\r\n incidental, or consequential damages of any character arising as a\r\n result of this License or out of the use or inability to use the\r\n Work (including but not limited to damages for loss of goodwill,\r\n work stoppage, computer failure or malfunction, or any and all\r\n other commercial damages or losses), even if such Contributor\r\n has been advised of the possibility of such damages.\r\n \r\n 9. Accepting Warranty or Additional Liability. While redistributing\r\n the Work or Derivative Works thereof, You may choose to offer,\r\n and charge a fee for, acceptance of support, warranty, indemnity,\r\n or other liability obligations and/or rights consistent with this\r\n License. However, in accepting such obligations, You may act only\r\n on Your own behalf and on Your sole responsibility, not on behalf\r\n of any other Contributor, and only if You agree to indemnify,\r\n defend, and hold each Contributor harmless for any liability\r\n incurred by, or claims asserted against, such Contributor by reason\r\n of your accepting any such warranty or additional liability.\r\n \r\n END OF TERMS AND CONDITIONS\r\n \r\n APPENDIX: How to apply the Apache License to your work.\r\n \r\n To apply the Apache License to your work, attach the following\r\n boilerplate notice, with the fields enclosed by brackets \"[]\"\r\n replaced with your own identifying information. (Don't include\r\n the brackets!) The text should be enclosed in the appropriate\r\n comment syntax for the file format. We also recommend that a\r\n file or class name and description of purpose be included on the\r\n same \"printed page\" as the copyright notice for easier\r\n identification within third-party archives.\r\n \r\n Copyright [yyyy] [name of copyright owner]\r\n \r\n Licensed under the Apache License, Version 2.0 (the \"License\");\r\n you may not use this file except in compliance with the License.\r\n You may obtain a copy of the License at\r\n \r\n http://www.apache.org/licenses/LICENSE-2.0\r\n \r\n Unless required by applicable law or agreed to in writing, software\r\n distributed under the License is distributed on an \"AS IS\" BASIS,\r\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\n See the License for the specific language governing permissions and\r\n limitations under the License.\r\n ",
"summary": "Parse, extract, and analyze documents with ease",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/AdemBoukhris457/Doctra",
"Issues": "https://github.com/AdemBoukhris457/Doctra/issues",
"Repository": "https://github.com/AdemBoukhris457/Doctra"
},
"split_keywords": [
"pdf",
" parser",
" document",
" extraction",
" ocr",
" layout-detection"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0e0b0d28b701bb7332f2c7beba816153f46a3b73f7dfe11d1df34d5aa7c37411",
"md5": "f39b6cc405c5b80b6cc9eb711d222898",
"sha256": "ad1b2f9d3a476dff29a63f821c21be4fa1d95f36d906e03cb173649186bf8189"
},
"downloads": -1,
"filename": "doctra-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f39b6cc405c5b80b6cc9eb711d222898",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 55042,
"upload_time": "2025-08-26T16:36:23",
"upload_time_iso_8601": "2025-08-26T16:36:23.436148Z",
"url": "https://files.pythonhosted.org/packages/0e/0b/0d28b701bb7332f2c7beba816153f46a3b73f7dfe11d1df34d5aa7c37411/doctra-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "602d16a286f5d18eaa40ea1dc0473f2dac545297ab66e38a966a686be18bbe49",
"md5": "9872a6b91dea724ae8358f6378be1314",
"sha256": "8eaf70486ba1589e12641b64e119ffca414a4f37704d7ff5c39e1791c9092ff6"
},
"downloads": -1,
"filename": "doctra-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "9872a6b91dea724ae8358f6378be1314",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 53608,
"upload_time": "2025-08-26T16:36:25",
"upload_time_iso_8601": "2025-08-26T16:36:25.495052Z",
"url": "https://files.pythonhosted.org/packages/60/2d/16a286f5d18eaa40ea1dc0473f2dac545297ab66e38a966a686be18bbe49/doctra-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-26 16:36:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AdemBoukhris457",
"github_project": "Doctra",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "doctra"
}
