GoblinTools
GoblinTools is a Python library designed for text extraction, archive handling, OCR integration, and text cleaning. It supports a wide range of file formats and offers both local and cloud-based OCR options.
Overview
GoblinTools provides a unified toolkit for extracting text from documents (PDF, DOCX, XLSX, etc.), handling archives (ZIP, RAR, 7z, 30+ formats), and cleaning text with Brazilian Portuguese support. OCR can use local Tesseract or AWS Textract. When AWS credentials are missing, the library falls back to local Tesseract with a warning. For native PDFs, optional table extraction (via pdfplumber) can detect grids and embed them as Markdown or return structured row matrices — useful for editais, planilhas orçamentárias, and similar bidding documents.
Architecture
goblintools/
├── parser.py # TextExtractor - main extraction, format parsers
├── table_extractor.py # PDF table detection (pdfplumber), Markdown, quality filters
├── structured/ # Parallel StructuredExtractor (HTML tables + quality gate)
├── pypdf_workarounds.py # PyPDF monkey-patches (indirect font metrics, optional stream cap)
├── file_handling.py # FileManager, ArchiveHandler, FileValidator
├── text_cleaner.py # TextCleaner - clean_text, remove_text_noise, stopwords
├── config.py # GoblinConfig, OCRConfig
├── log_policy.py # configure() - library warning verbosity
├── ocr_parser.py # OCRProcessor - Tesseract / AWS Textract
└── retry.py # retry_with_backoff utility
Processing Flow
- Text extraction: File → parser by extension; if unknown or no extension, magic-byte sniffing (PDF, RTF, Office Open XML) → extracted text (with
file_path_pwdtag) - Folder extraction: Each file’s tag uses the path relative to the folder (as inside a zip), e.g.
edital/arquivo.pdfnot the full filesystem path - PDF text: pypdf (≥ 6.15.0) with built-in workarounds for common producer bugs (e.g. font widths as indirect references). The reader tries the file as-is, merges text from an internal resave when some pages fail, then uses plain and layout extraction modes. Pages whose text turns out to be an undecoded font encoding (glyph-code garbage — see below) are retried with pdfplumber, then handed to OCR per page. Optional OCR (
ocr_handler=True): full-document OCR when the PDF has images but almost no text, or per-page OCR for pages PyPDF still cannot decode or that decoded to unreadable glyph codes (requires Poppler forpdf2imageand Tesseract for local OCR) - PDF tables (opt-in on
TextExtractor): withextract_tables=True, pdfplumber detects tables on each page; the library filters one-column text boxes, collapses split headers, merges continuation rows, and appends Markdown tables after that page’s text (or returns structured matrices viaextract_tables_from_pdf) - Structured extraction (parallel API):
StructuredExtractorextracts item-oriented tables from PDF / XLSX / CSV / DOCX into matrices + quality scores, and can render MinerU-compatiblefull.mdwith HTML<table>blocks — without changing plainTextExtractorbehaviour - Archive extraction: Format handler → extract to temp → flatten with stable names (extensionless entries preserved) → optionally remove source. Misnamed archives (e.g.
.zipthat is a PDF) use magic-byte fallbacks
Installation
pip install goblintools
Requirements
- Python: 3.9 or newer
- pypdf: 6.15.0 or newer (declared in package metadata; used for PDF text extraction)
- pdfplumber: Used for optional PDF table detection (
extract_tables=True/extract_tables_from_pdf) - Tesseract OCR: Required for local OCR support (Installation Guide)
- Portuguese Language Pack: Install
tesseract-ocr-porfor Portuguese text recognition
- Portuguese Language Pack: Install
- Poppler: Required when using OCR on PDFs (
pdf2image); installpoppler-utils(Debian/Ubuntu) or your OS equivalent - AWS Credentials: Required for AWS Textract cloud OCR
PDF extraction notes
- Importing
TextExtractorapplies pypdf workarounds once (idempotent): on older pypdf, safer/Widths/space_widthhandling; on pypdf 6.15+ the stock text extractor is kept (legacy monkey-patches would break RTL helpers) and only light font-width guards are applied. - If your pypdf build exposes
MAX_ARRAY_BASED_STREAM_OUTPUT_LENGTHonpypdf.filters, the library increases that limit slightly so very large but legitimate content streams can still be decoded; if the attribute is missing (some forks or versions), that step is skipped automatically. - For scanned PDFs or pages with no usable text layer, enable
TextExtractor(ocr_handler=True)and install Poppler + Tesseract. - Table extraction targets native (digital) PDFs with a text layer and visible table structure. Scanned pages need OCR first; table detection from scans (Textract TABLES / img2table) is not wired yet.
- Broken font encoding (non-scanned PDFs): some PDFs use a font
/Encodingwith a/Differencesarray mapping character codes to non-standard glyph names, with no working/ToUnicodeCMap. Neither pypdf nor pdfminer can recover real characters from that — the mapping genuinely isn't in the file, even though the PDF renders correctly in any viewer (rendering uses the embedded font program directly, not this metadata). The library detects the resulting garbage — pypdf's raw/143-style glyph-name tokens, pdfminer/pdfplumber's(cid:143)markers, or a per-glyph substitution where codes land on ASCII punctuation/digits instead of the real letters — and retries affected pages with pdfplumber, then withocr_handler(page-level, not a full-document re-OCR) when configured. Without anocr_handler, such pages are returned as-is (unreadable) with a warning logged; this cannot be fixed without OCR since the correct characters are not recoverable from the text layer.
System Dependencies
Archive Support
For complete archive format support, install these system tools (required by patoolib):
| OS | Command |
|---|---|
| Debian/Ubuntu | sudo apt install unrar p7zip-full p7zip-rar |
| Arch Linux | sudo pacman -S unrar p7zip |
| macOS | brew install unrar p7zip |
Tesseract OCR with Portuguese Support
| OS | Command |
|---|---|
| Debian/Ubuntu | sudo apt install tesseract-ocr tesseract-ocr-por |
| Arch Linux | sudo pacman -S tesseract tesseract-data-por |
| macOS | brew install tesseract tesseract-lang |
| Windows | Download from UB Mannheim and select Portuguese during installation |
Key Features
- Broad File Support: Extract text from 20+ document, spreadsheet, and presentation formats
- Archive Handling: Supports
.zip,.rar,.7z,.tar,.gz, and 30+ more formats - OCR Integration: Local Tesseract or cloud AWS Textract support
- Text Cleaning:
clean_text(accent folding via unidecode, optional stopwords);remove_text_noise(spacing / repeated dots only, preserves Unicode) - Portuguese OCR: Optimized for Brazilian Portuguese documents with Tesseract
- Batch Processing: Parallel archive extraction
- File Management: Comprehensive file/directory operations
- File Path Tagging: Automatically includes file path metadata in extracted text (relative paths for folder extraction)
- Extensionless files: PDFs and other types without a filename extension are detected from content
- Robust PDF pipeline: PyPDF workarounds, resave merge for partial failures, optional targeted OCR for stubborn pages when an OCR handler is configured
- PDF table extraction: Opt-in pdfplumber detection with quality filters; embed Markdown in extracted text or get structured
rowsmatrices - Structured extraction: Parallel
StructuredExtractorfor PDF/XLSX/CSV/DOCX → HTMLfull.md+ok_for_itemsquality gate (plain text path unchanged) - Quiet logs: Optional suppression of GoblinTools warning logs via
configure()or constructor flags
Quick Start
Basic Text Extraction
from goblintools import TextExtractor
extractor = TextExtractor()
text = extractor.extract_from_file("document.pdf")
print(text[:200] + "..." if text else "No text extracted")
# Output includes file path tag:
# file_path_pwd:"document.pdf"
# [extracted text content...]
PDF table extraction
By default, PDF text is flattened (columns lost). Enable tables with extract_tables=True to append Markdown tables after each page’s text, or call extract_tables_from_pdf for structured data.
from goblintools import TextExtractor, extract_pdf_tables, table_to_markdown
# 1) Embed Markdown tables in the usual str output (good for LLM / RAG)
extractor = TextExtractor(extract_tables=True) # table_format="markdown"
text = extractor.extract_from_file("edital.pdf")
# file_path_pwd:"edital.pdf"
# ...page text...
#
# <!-- table page=26 index=0 -->
# | ITEM | DESCRIÇÃO | CÓDIGO | UND. | QUANT | VALOR . UNT. | VALOR TOTAL |
# | --- | --- | --- | --- | --- | --- | --- |
# | 1. | ... | ... | SERV | 12 | R$ 16.511,45 | R$ 198.137,40 |
# 2) Structured matrices (page is 1-based)
tables = extractor.extract_tables_from_pdf("edital.pdf")
# [{"page": 26, "index": 0, "rows": [["ITEM", ...], ["1.", ...], ...]}, ...]
# Optional page limit for large editais
tables = extractor.extract_tables_from_pdf("edital.pdf", max_pages=40)
# Helpers also importable directly
tables = extract_pdf_tables("edital.pdf")
print(table_to_markdown(tables[0]["rows"]))
What the pipeline does before returning tables:
- Drops likely false positives (e.g. single-column bordered text)
- Removes empty rows, collapses split headers, merges continuation lines into the previous item row
extract_tables=False (default) leaves PDF extraction unchanged.
Dev helper at the repo root:
python scripts/dev_extract_tables.py --max-pages 40
python scripts/dev_extract_tables.py --all-pages
Structured extraction (parallel to plain text)
Use this when you need HTML tables and an item-quality gate (e.g. bidding item pipelines). It does not alter TextExtractor.extract_from_file.
from goblintools import StructuredExtractor
# or: from goblintools.structured import StructuredExtractor
ext = StructuredExtractor()
doc = ext.extract_from_file("edital.pdf")
# doc.tables -> List[TableBlock] with rows + quality
# doc.ok_for_items -> True when at least one table looks like ITEM/DESCRIÇÃO/QTD
if doc.ok_for_items:
md = ext.to_full_md(doc) # prose + <table>...</table>
ext.write_full_md(doc, "out/full.md")
# Also: .xlsx / .xlsm / .csv / .docx
docs = ext.extract_from_folder("prepared/")
Supported suffixes: .pdf, .docx, .xlsx, .xlsm, .csv. Other formats return an empty document with ok_for_items=False.
python scripts/dev_structured_extract.py --max-pages 40
python scripts/dev_structured_extract.py path/to/file.xlsx --write-md /tmp/out
OCR-Enabled Extraction
# Local OCR with Tesseract
extractor = TextExtractor(ocr_handler=True)
text = extractor.extract_from_file("scanned_document.pdf")
# Output: file_path_pwd:"scanned_document.pdf" [OCR extracted text]
# AWS Textract OCR
extractor = TextExtractor(
ocr_handler=True,
use_aws=True,
aws_access_key="your-key",
aws_secret_key="your-secret",
aws_region="us-east-1"
)
text = extractor.extract_from_file("document.pdf")
# Output: file_path_pwd:"document.pdf" [AWS Textract extracted text]
Configuration Management
from goblintools import GoblinConfig, OCRConfig, TextExtractor
# Create config programmatically
config = GoblinConfig(
max_file_size=50 * 1024 * 1024, # 50MB limit
ocr=OCRConfig(
use_aws=True,
aws_access_key="your-key",
aws_secret_key="your-secret",
aws_region="us-west-2",
tesseract_lang="por" # Portuguese OCR (default)
)
)
# Use config with extractor
extractor = TextExtractor(ocr_handler=True, config=config)
# Save config to file
config.to_file("goblin_config.json")
# Load config from file
config = GoblinConfig.from_file("goblin_config.json")
extractor = TextExtractor(ocr_handler=True, config=config)
Example config file (goblin_config.json):
{
"max_file_size": 52428800,
"ocr": {
"use_aws": false,
"aws_access_key": null,
"aws_secret_key": null,
"aws_region": "us-east-1",
"tesseract_lang": "por"
}
}
Supported Tesseract Languages:
"por"- Portuguese (default)"eng"- English"spa"- Spanish"por+eng"- Portuguese + English (multi-language)- See Tesseract documentation for more languages
Warning logs (library-only)
GoblinTools can hide its own warning log lines (errors and third-party libraries such as patool are unchanged):
import goblintools
from goblintools import TextExtractor, FileManager
goblintools.configure(suppress_warnings=True)
# Or per component:
extractor = TextExtractor(suppress_warnings=True)
file_manager = FileManager(suppress_warnings=True)
Passing suppress_warnings=False turns warnings back on. If you omit the argument on TextExtractor(), the current setting is left unchanged (so a prior configure() call still applies).
Advanced Features
# Extract from entire folder (respects max_file_size limit)
# Each file's tag uses the path RELATIVE to folder_path (stable layout after zip extract)
text = extractor.extract_from_folder("/path/to/documents")
# Example: file_path_pwd:"edital/anexo_1" ... file_path_pwd:"anexo.pdf" ...
# Check if PDF needs OCR
if extractor.pdf_needs_ocr("document.pdf"):
print("This PDF requires OCR processing")
# Validate installation
status = extractor.validate_installation()
print(f"Tesseract available: {status['tesseract']}")
if 'aws_textract' in status:
print(f"AWS Textract available: {status['aws_textract']}")
# Add custom file parser
def custom_parser(file_path):
# Your custom extraction logic
return "extracted text"
extractor.add_parser('.custom', custom_parser)
text = extractor.extract_from_file("file.custom")
# Output: file_path_pwd:"file.custom" extracted text
# Direct OCR processing with config
from goblintools import OCRProcessor, OCRConfig
ocr_config = OCRConfig(use_aws=True, aws_access_key="key", aws_secret_key="secret")
ocr = OCRProcessor(ocr_config)
text = ocr.extract_text_from_pdf("scanned.pdf")
File Path Tagging
All extracted text automatically includes the file path as metadata using the file_path_pwd tag:
# Single file extraction — tag uses the path you pass in
text = extractor.extract_from_file("document.pdf")
# file_path_pwd:"document.pdf"
# Folder extraction — tag uses path relative to the folder (like inside a zip)
text = extractor.extract_from_folder("/cache/bidding_123")
# file_path_pwd:"edital/anexo_1"
# file_path_pwd:"docs/planilha.xlsx"
File Path Tagging Features:
- Automatic tagging: Every extracted text includes a source path in the tag
- Folder mode: Relative paths only (not the full
/cache/...prefix), so tags stay stable across machines - Extensionless names: Files like
anexo_1(PDF without extension) are still parsed when content matches known types - Consistent format:
file_path_pwd:"path/to/file"prefix for easy parsing
Example helper script (repo root):
python scripts/extract_zip_and_text.py path/to/archive.zip [--ocr] [--suppress-warnings] [--work-dir DIR]
Archive Extraction
from goblintools import FileManager, FileValidator, ArchiveHandler
# Single archive extraction (handles nested archives); class methods work unchanged
FileManager.extract_files_recursive("archive.zip", "output_folder")
# Or construct FileManager if you need suppress_warnings=True for the session
fm = FileManager(suppress_warnings=True)
# fm.extract_files_recursive(...) # same APIs as on the class
# Parallel batch extraction
results = FileManager.batch_extract(["file1.zip", "file2.rar"], "output_folder")
print(f"Extraction results: {results}") # [True, False, ...]
# Batch extraction with progress tracking
def progress_callback(current, total):
print(f"Progress: {current}/{total} ({current/total*100:.1f}%)")
results = FileManager.batch_extract(
["file1.zip", "file2.rar", "file3.7z"],
"output_folder",
progress_callback=progress_callback
)
# File validation
if FileValidator.is_archive("file.zip"):
print("File is a supported archive")
if FileValidator.is_empty("file.txt"):
print("File is empty")
# Direct archive handling (remove_source=True deletes archive after extraction)
ArchiveHandler.extract("archive.7z", "output")
ArchiveHandler.extract("archive.7z", "output", remove_source=False) # Keep source
# Add custom archive format
ArchiveHandler.add_format('.custom', lambda f, d: custom_extract(f, d))
# File operations with conflict resolution
FileManager.move_file("source.txt", "destination.txt") # Auto-renames if exists
FileManager.delete_folder("temp_folder")
FileManager.move_files("folder_path") # Flatten: relative paths → safe names (e.g. edital/arquivo.pdf → edital_arquivo.pdf); extensionless entries keep the basename
Text Cleaning
from goblintools import TextCleaner
# Default Portuguese stopwords
cleaner = TextCleaner()
raw_text = "Isso é um Teste com Acentos!"
# Basic cleaning (remove accents)
clean = cleaner.clean_text(raw_text)
# Output: "Isso e um Teste com Acentos!"
# Full cleaning (lowercase + remove stopwords)
clean = cleaner.clean_text(raw_text, lowercase=True, remove_stopwords=True)
# Output: "teste acentos"
# Custom stopwords
custom_cleaner = TextCleaner(custom_stopwords=['custom', 'words'])
clean = custom_cleaner.remove_stopwords("custom text with words")
# Output: "text with"
# Portuguese text processing example
portuguese_text = "Este é um documento em português com acentuação!"
clean_pt = cleaner.clean_text(portuguese_text, lowercase=True, remove_stopwords=True)
# Output: "documento portugues acentuacao"
# Light noise removal only (collapse whitespace, strip runs of dots) — keeps accents
noisy = "São Paulo... centro"
cleaner.remove_text_noise(noisy)
# Output: "São Paulo centro"
clean_text vs remove_text_noise
clean_text |
remove_text_noise |
|
|---|---|---|
| Repeated dots / extra spaces | Yes | Yes |
| Accent handling | ASCII fold (unidecode) |
Unchanged (keeps ç, ã, etc.) |
| Stopwords / lowercase | Optional | No |
Brazilian Portuguese Support
GoblinTools is optimized for Brazilian Portuguese users:
from goblintools import TextExtractor, TextCleaner, OCRConfig
# Portuguese OCR configuration
config = OCRConfig(
tesseract_lang="por", # Portuguese language
use_aws=False # Use local Tesseract
)
# Extract Portuguese documents
extractor = TextExtractor(ocr_handler=True, config=config)
text = extractor.extract_from_file("documento_brasileiro.pdf")
# Clean Portuguese text (removes Portuguese stopwords)
cleaner = TextCleaner() # Uses Portuguese stopwords by default
clean_text = cleaner.clean_text(
"Este é um texto em português com acentos!",
lowercase=True,
remove_stopwords=True
)
print(clean_text) # Output: "texto portugues acentos"
# Multi-language OCR (Portuguese + English)
multi_config = OCRConfig(tesseract_lang="por+eng")
extractor_multi = TextExtractor(ocr_handler=True, config=multi_config)
Portuguese Features:
- Default Portuguese stopwords (400+ words)
- Portuguese Tesseract OCR support
- Accent removal with
unidecode - Brazilian document format support
Supported Formats
Documents
.pdf, .docx, .odt, .rtf, .txt, .csv, .xml, .html
Spreadsheets
.xlsx, .xls, .ods, .dbf
Presentations
.pptx
Archives
.zip, .rar, .7z, .tar, .gz, .bz2, .iso, .deb, .rpm, .jar, .war, .ear, .cbz, .cbr, .cb7, .tgz, .txz, .cbt, .udf, .ace, .cba, .arj, .cab, .chm, .cpio, .dms, .lha, .lzh, .lzma, .lzo, .xz, .zst, .zoo, .adf, .alz, .arc, .shn, .rz, .lrz, .a, .Z
API Reference
configure (module-level)
Import from the package: from goblintools import configure (or import goblintools; goblintools.configure(...)).
configure(suppress_warnings=None)- IfTrue/False, sets whether GoblinTools emits warning logs for the process. Omit or passNonefor no change.
TextExtractor
__init__(ocr_handler=False, use_aws=False, aws_access_key=None, aws_secret_key=None, aws_region='us-east-1', config=None, suppress_warnings=None, extract_tables=False, table_format='markdown')-suppress_warnings: ifTrue/False, updates library warning policy; ifNone, leaves current setting (e.g. fromconfigure()).extract_tables: whenTrue, detect PDF tables with pdfplumber and embed them in the text.table_format: currently only"markdown"extract_from_file(file_path, display_path=None)- Extract text from single file. Returnsstrwithfile_path_pwdtag; optionaldisplay_pathoverrides the tag pathextract_from_folder(folder_path)- Extract text from all files in folder (recursively). Tags use paths relative tofolder_pathextract_tables_from_pdf(file_path, max_pages=None)- Return a list of{"page", "index", "rows"}from a PDF (does not requireextract_tables=Trueon the constructor)pdf_needs_ocr(pdf_path)- Check if PDF requires OCR processingadd_parser(extension, parser_func)- Add custom parser for file extensionvalidate_installation()- Check if dependencies are properly installed
Output Format:
- Always returns
str(string) with extracted text - Each file's text is prefixed with a
file_path_pwd:"…"tag (relative path for folder extraction) - Multiple files are joined with blank lines between segments
- With
extract_tables=True, Markdown tables are appended per page after markers like<!-- table page=N index=M -->
Table helpers
Import from the package: from goblintools import extract_pdf_tables, table_to_markdown, is_meaningful_table, normalize_table_rows.
extract_pdf_tables(pdf_path, max_pages=None, ...)- Detect and normalize tables; returns[{"page", "index", "rows"}, ...]table_to_markdown(rows, header=True)- Convert a cell matrix to a GitHub-flavored Markdown tablenormalize_table_rows(rows)- Drop empty rows, collapse split headers, merge continuation rowsis_meaningful_table(rows)- Quality gate used to drop one-column / tiny fragments
FileManager
__init__(suppress_warnings=None)- IfTrue/False, sets library warning suppression for the processextract_files_recursive(archive_path, output_path)- Extract archive recursivelybatch_extract(archive_list, output_path, progress_callback=None)- Extract multiple archives with optional progress trackingmove_file(source, destination)- Move/rename file with conflict resolution and type safetydelete_folder(folder_path)- Delete folder and contentsdelete_if_empty(file_path)- Delete file if emptymove_files(folder_path)- Flatten directory structure and normalize filenames
FileValidator
is_empty(file_path)- Check if file is emptyis_archive(file_path)- Check if file is a supported archive formatis_parseable_document(file_path)- Known document extension (pdf, docx, …)is_zip_by_magic(file_path)- ZIP signature sniff (misnamed PDF-as-ZIP handling)detect_extension_from_magic(file_path)- Infer.pdf,.rtf,.docx,.xlsx,.pptxfrom content when the filename has no/wrong extension
ArchiveHandler
extract(file_path, destination, remove_source=True)- Extract archive with collision avoidance. Whenremove_source=True(default), deletes the archive after extraction; set toFalseto keep it.add_format(extension, handler)- Add support for new archive formats
TextCleaner
__init__(custom_stopwords=None)- Initialize with custom stopwords (defaults to Portuguese)clean_text(text, lowercase=False, remove_stopwords=False)- Normalize whitespace and dots, applyunidecode, optional lowercase and Portuguese stopword removalremove_text_noise(text)- Collapse repeated whitespace and strip runs of dots (..,...); does not transliterate accents (use when you need to keep UTF-8 as-is)remove_stopwords(text)- Remove stopwords from text
OCRProcessor
__init__(config)- Initialize OCR processor with OCRConfigextract_text_from_pdf(pdf_path)- Extract text from PDF using OCR
GoblinConfig
__init__(max_file_size=104857600, ocr=None)- Initialize configurationfrom_file(config_path)- Load configuration from JSON fileto_file(config_path)- Save configuration to JSON filedefault()- Create default configuration
OCRConfig
__init__(use_aws=False, aws_access_key=None, aws_secret_key=None, aws_region='us-east-1', tesseract_lang='por')- Initialize OCR configurationtesseract_lang: Language for Tesseract OCR ('por'for Portuguese,'eng'for English,'por+eng'for both)
Scripts de Teste
Run tests locally with pytest:
# Activate venv first
source .venv/bin/activate # or: .venv\Scripts\activate on Windows
# Run all tests
pytest tests/ -v
# Or
python -m pytest tests/ -v
Estrutura do Projeto
goblintools/
├── goblintools/ # Package
│ ├── __init__.py
│ ├── parser.py # TextExtractor
│ ├── table_extractor.py # PDF tables (pdfplumber)
│ ├── structured/ # StructuredExtractor (parallel API)
│ ├── file_handling.py # FileManager, ArchiveHandler, FileValidator
│ ├── text_cleaner.py # TextCleaner
│ ├── config.py # GoblinConfig, OCRConfig
│ ├── log_policy.py # configure()
│ ├── ocr_parser.py # OCRProcessor
│ └── retry.py # retry_with_backoff
├── scripts/ # dev_extract_tables.py, dev_structured_extract.py, ...
├── tests/ # Pytest tests
│ ├── conftest.py
│ ├── test_structured/
│ └── test_*.py
├── pytest.ini
├── pyproject.toml
└── requirements.txt
Troubleshooting
"Tesseract is not installed or it's not in your PATH"
Install Tesseract and the Portuguese language pack. See System Dependencies for OS-specific commands.
"AWS credentials not found; falling back to local Tesseract OCR"
You set use_aws=True but did not provide aws_access_key and aws_secret_key in OCRConfig. The library falls back to local Tesseract. To use AWS Textract, pass credentials explicitly in config.
"No parser available for file extension"
The file format is not supported, or the file has no extension and content could not be identified. PDFs, RTF, and Office Open XML (ZIP) are sniffed automatically; use extractor.add_parser('.ext', your_parser_func) for other types.
Archive extraction fails for RAR/7z
Install system tools: unrar and p7zip. See Archive Support.
Extracted PDF text is garbled — looks like /143 /120 /108 ... or (cid:143)(cid:16)..., or is readable-looking but not real words
The PDF's font maps character codes to custom glyph names with no working /ToUnicode CMap, so pypdf/pdfminer can't recover real characters (see Broken font encoding above). The library detects this automatically and retries with pdfplumber then OCR — pass ocr_handler=True (and use_aws=True with credentials, or install Tesseract locally) so the fallback has somewhere to go. Without an OCR handler, these pages come back unreadable; there is no way to decode them from the text layer alone.
Escopo e Limites
- In scope: Text extraction from documents, spreadsheets, presentations; optional native-PDF table extraction (pdfplumber → Markdown / row matrices); parallel
StructuredExtractor(PDF/XLSX/CSV/DOCX → HTMLfull.md+ quality); archive handling; OCR (Tesseract, AWS Textract); text cleaning (Portuguese-focused); file operations. - Out of scope: Real-time streaming, document conversion to other formats, indexing/search, web scraping. OCR requires Tesseract (local) or AWS credentials (cloud). Table extraction from pure scans (Textract TABLES / img2table) is not included yet.
Release highlights (0.9.3)
- Broken font encoding detection: PDFs whose font
/Encoding /Differencesmaps to non-standard glyph names with no/ToUnicodeCMap used to silently pass through as "successfully extracted" garbage (pypdf's raw/143-style tokens counted as meaningful text). New_looks_like_encoded_glyphsheuristic catches this — plus pdfminer's(cid:143)notation and a substitution-cipher variant (codes mapped into ASCII punctuation/digits, only detectable via overall letter density, since it has no fixed token shape) — and retries affected pages with pdfplumber, then per-page OCR whenocr_handleris configured. - OCR fallback no longer gated on
has_images: the whole-document OCR fallback used to only trigger when pypdf found an/ImageXObject on the page. Broken font encoding has nothing to do with embedded images (it affects native, non-scanned text), so the gate was dropped — OCR now triggers on any unreadable extraction result, image or not.
Earlier (0.8.0)
- StructuredExtractor: New parallel API (
goblintools.structured) for item-oriented tables from PDF, XLSX/XLSM, CSV, and DOCX. Renders MinerU-compatible HTML<table>full.mdand exposesok_for_itemsquality gate. Does not changeTextExtractordefaults or plain-text output. - Quality: Footer/note row drop, light cell cleanup, itemish header detection (ITEM/DESCRIÇÃO/QTD), qty/value parse rates.
Earlier (0.7.8)
- PDF tables: Opt-in
TextExtractor(extract_tables=True)embeds Markdown tables in extracted text;extract_tables_from_pdf/extract_pdf_tablesreturn structuredrows. Quality filters drop single-column text boxes; headers and continuation rows are normalized. - Dependency:
pdfplumberdeclared for table detection on native PDFs.
Earlier (0.7.6)
- PyPDF reliability: Runtime fixes for
IndirectObjectfont metrics and relatedextract_text()failures on real-world editais; compatible with pypdf versions that omitMAX_ARRAY_BASED_STREAM_OUTPUT_LENGTHonpypdf.filters. - PDF extraction flow: Read original PDF first, merge with an internal resave when needed, try multiple extraction modes, optional per-page OCR for gaps when
ocr_handler=True. - Python: Minimum version remains 3.9;
pypdf>=6.15.0is required.
License
MIT License
Release files for goblintools 0.9.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| goblintools-0.9.3.tar.gz | 77.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| goblintools-0.9.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 133.0 kB
Release files / goblintools-0.9.3.tar.gz
| Download URL | goblintools-0.9.3.tar.gz |
|---|---|
| Size | 77.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b05d74117424c5801fe6c841ba55a5776c4efdbbddeeb07facf518086103eb0a
|
|
BLAKE2b-256 checksum How to use checksums |
868466a9d319b82adcd39bed419f6c528957706e1ac387ccb07e3da3e9ade935
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.6
|
Release files / goblintools-0.9.3-py3-none-any.whl
| Download URL | goblintools-0.9.3-py3-none-any.whl |
|---|---|
| Size | 56.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
06139db72be46ee18c7a53fbc248f65fcc508c55c5f0427edeb7dc6ba820c721
|
|
BLAKE2b-256 checksum How to use checksums |
426a08212c178dae164a5b6cff99c40fa31cd1be88a753b51c681b9b5268f1e6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.6
|