Skip to content

Latest commit

 

History

History
 
 

README.md

Scripts Utilitários

Scripts auxiliares para desenvolvimento, testes e manutenção do projeto PyBoleto.

📜 Scripts Disponíveis

Testes

test_all_examples.py

Testa todos os exemplos JSON da API automaticamente:

python scripts/test_all_examples.py
  • Testa todos os arquivos em examples/json/
  • Valida respostas da API
  • Gera relatório de sucesso/falha

test_multiplos_boletos.py

Testa especificamente a geração de múltiplos boletos:

python scripts/test_multiplos_boletos.py
  • Testa carnês duplos
  • Testa formato normal com múltiplos boletos
  • Valida PDFs gerados

quick_test.sh

Script rápido para executar testes básicos:

./scripts/quick_test.sh
  • Executa testes unitários principais
  • Verifica sintaxe Python
  • Validação rápida

Utilitários

regenerate_expected_xml.py

Regenera arquivos XML esperados para testes:

python scripts/regenerate_expected_xml.py
  • Atualiza arquivos XML de referência
  • Usado após mudanças nos bancos
  • Ver: docs-guides/GENERATE_EXPECTED_FILES.md

decode_pdf_base64.py

Decodifica PDF de base64 e salva em arquivo:

python scripts/decode_pdf_base64.py <base64_string> output.pdf
  • Útil para debugging da API
  • Converte resposta base64 em PDF visualizável

clean.sh

Limpa arquivos temporários e cache:

./scripts/clean.sh
  • Remove __pycache__
  • Remove *.pyc
  • Remove .pytest_cache
  • Remove arquivos temporários

Outros

boleto_sicoob_skippers.html

Arquivo HTML com exemplo visual de boleto Sicoob da empresa Skippers

  • Referência visual
  • Usado para comparação

🚀 Uso Comum

Desenvolvimento

# Limpar cache antes de testes
./scripts/clean.sh

# Executar testes rápidos
./scripts/quick_test.sh

# Testar todos exemplos
python scripts/test_all_examples.py

Manutenção

# Regenerar XMLs após mudanças
python scripts/regenerate_expected_xml.py

# Verificar PDF gerado
python scripts/decode_pdf_base64.py "JVBERi0xLjMKJ..." test.pdf

📝 Notas

  • Scripts Python assumem que você está no diretório raiz do projeto
  • Scripts shell (.sh) devem ser executados com permissão de execução: chmod +x script.sh
  • Alguns scripts requerem a API rodando (test_all_examples.py)

🔗 Documentação Relacionada

  • Testes: ../tests/
  • Exemplos: ../examples/
  • Guias: ../docs-guides/GENERATE_EXPECTED_FILES.md
  • API: ../api/README.md

💡 Adicionar Novos Scripts

Ao adicionar novos scripts utilitários:

  1. Coloque-os neste diretório
  2. Adicione descrição neste README
  3. Adicione comentários no código
  4. Se for shell script, torne executável: chmod +x script.sh