README.pt-BR.md

Documentação em Português (Brasil)

English version

Visão geral

A pydf é uma biblioteca Python criada a partir do projeto original, mantendo a mesma ideia principal: ler PDFs de faturas, extrair número e data da fatura, gerar uma planilha Excel e, opcionalmente, persistir os dados em MySQL.

Esta versão também inclui uma CLI, exemplos comentados e workflows recomendados para GitHub Actions.

Comece por aqui

• README principal
• Guia da CLI
• Guia da API pública
• Arquitetura
• CI/CD e Releases
• Ambiente Python, venv e troubleshooting
• Exemplos

Instalação

pip install -e .

Com dependências de desenvolvimento:

pip install -e .[dev]

Formas de uso

1. Via CLI

pydf examples/pdf_invoices --output output/invoices.xlsx

2. Via Python

from pydf import InvoiceProcessor, ProcessorConfig

config = ProcessorConfig(
    input_dir="examples/pdf_invoices",
    output_excel="output/invoices.xlsx",
)

result = InvoiceProcessor(config).process()
print(result.output_excel)