RabbitPDF 0.2.0

Uma biblioteca Python para criar, compor, visualizar, manipular e aplicar OCR em PDFs.

RabbitPDF

RabbitPDF é uma biblioteca Python para criar, compor, visualizar, manipular e aplicar OCR em arquivos PDF.

Versão atual: 0.2.0.

English README

Recursos

• Criar PDFs simples a partir de texto, linhas ou imagens.
• Compor documentos ricos com cabeçalho, rodapé, tabelas, imagens, marca d'água, numeração de páginas e estilos de texto.
• Ajustar fonte, tamanho, entrelinha, margens independentes, espaçamentos, bordas e padding de tabelas.
• Juntar, extrair, dividir, criptografar, descriptografar e marcar PDFs existentes.
• Abrir PDFs no visualizador local ou em uma página HTML simples.
• Executar OCR em PDFs digitalizados com dependências opcionais.
• Usar por API Python ou pela CLI rabbitpdf.

Instalação

pip install RabbitPDF

Para OCR:

pip install "RabbitPDF[ocr]"

O OCR também exige o binário do Tesseract instalado no sistema.

Começo Rápido

from rabbitpdf import PDFCreator, PDFViewer

PDFCreator(title="Exemplo").create_from_text(
    "Olá, RabbitPDF!",
    "hello.pdf",
)

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

Documento Avançado

from reportlab.lib.units import cm

from rabbitpdf import DocumentTheme, RabbitDocument, TableOptions, TextStyle

(
    RabbitDocument(
        title="Relatório",
        page_size="A4",
        left_margin=2.5 * cm,
        right_margin=2.5 * cm,
        top_margin=2.0 * cm,
        bottom_margin=2.0 * cm,
        theme=DocumentTheme(font_size=11, leading=14),
    )
    .add_paragraph("RELATÓRIO", bold=True, underline=True, align="center")
    .add_spacer(16)
    .add_table(
        [
            ["Item", "Valor"],
            ["Subtotal", "R$ 100,00"],
            ["Total", "R$ 100,00"],
        ],
        options=TableOptions(
            repeat_header=True,
            padding=6,
            cell_style=TextStyle(font_size=10, leading=12, space_after=0),
        ),
    )
    .build("relatorio.pdf")
)

CLI

Criar PDF com texto:

rabbitpdf create hello.pdf --text "Olá, RabbitPDF"

Criar PDF a partir de imagens:

rabbitpdf create album.pdf --images pagina-1.png pagina-2.jpg

Juntar PDFs:

rabbitpdf merge final.pdf capa.pdf conteudo.pdf anexos.pdf

Extrair páginas:

rabbitpdf extract relatorio.pdf resumo.pdf --pages "1,3-5,-1"

Adicionar marca d'água:

rabbitpdf watermark entrada.pdf saida.pdf --text "CONFIDENCIAL"

Se o executável não estiver no PATH, use:

python -m rabbitpdf --help

Exemplos

Os exemplos ficam em examples:

• hello_document.py: documento visual com cabeçalho, texto, imagem placeholder e rodapé.
• relatorio_tabela.py: relatório com tabela estilizada.
• parecer_documental.py: parecer documental com fonte 11, tabela chave/valor, textos ricos e espaçamento calibrado.
• operacoes_pdf.py: criação, merge, marca d'água, extração e split de PDFs.

Execute qualquer exemplo com:

python examples/parecer_documental.py

Documentação

• Introdução
• Documentos avançados
• Operações em PDFs
• CLI
• Exemplos
• Referência da API
• Publicação

Desenvolvimento

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

Também é possível rodar testes diretamente:

python tests/test_document.py
python tests/test_examples.py

Publicação

O workflow de publicação está em:

.github/workflows/publish.yml

No PyPI Trusted Publishing, informe o nome do workflow:

publish.yml