RabbitPDF 0.1.0

A small Python toolkit to create, view, and OCR PDF files.

RabbitPDF

RabbitPDF is a small Python library for PDF workflows:

• create PDFs from text, lines, or images;
• open PDFs in the local browser/default viewer;
• run OCR on PDF pages and return plain text.

Version 0.1.0 is intentionally compact and friendly for scripts, CLIs, and small apps.

Install

pip install RabbitPDF

For OCR support:

pip install "RabbitPDF[ocr]"

OCR also needs the Tesseract binary installed on the machine.

Quick Start

from rabbitpdf import PDFCreator, PDFViewer, ocr_pdf

PDFCreator(title="Invoice").create_from_text(
    "Hello from RabbitPDF!",
    "hello.pdf",
)

PDFViewer("hello.pdf").open()

text = ocr_pdf("scanned.pdf", lang="por+eng")
print(text)

CLI

Create a PDF:

rabbitpdf create hello.pdf --text "Hello from RabbitPDF"

If the console script is not on your PATH, use:

python -m rabbitpdf create hello.pdf --text "Hello from RabbitPDF"

Create a PDF from a text file:

rabbitpdf create output.pdf --text-file input.txt --title "My Document"

Create a PDF from images:

rabbitpdf create album.pdf --images page-1.png page-2.jpg --page-size A4

Open a PDF:

rabbitpdf view output.pdf

Run OCR:

rabbitpdf ocr scanned.pdf --lang por+eng --output scanned.txt

Build for PyPI

python -m pip install -e ".[dev]"
python -m pytest
python -m build
twine check dist/*
twine upload dist/*

Notes

• PDFCreator uses ReportLab.
• PDFViewer delegates rendering to the local browser/default PDF viewer.
• ocr_pdf() uses PyMuPDF to render pages and pytesseract to read text.
• Tesseract language packs must be installed separately, for example Portuguese (por) and English (eng).