PDF TO SHEET

Converta PDFs em planilhas de forma fácil e rápida!

Índice

• Visão Geral
• Demonstração
• Funcionalidades
• Começando
  • Pré-requisitos
  • Instalação
  • Executando
  • Como Usar
• Roadmap
• Contribuindo
• Licença

---

🔮 Visão Geral

O PDF to Sheet simplifica a conversão de relatorios PDF (Xpert) para formatos de planilha de forma fácil. Sua interface amigável permite o upload e processamento sem complicações, gerando saídas estruturadas para fácil manipulação dos dados. Ideal para profissionais que lidam com tarefas manuais de extração de dados, este projeto agiliza o processo de conversão, aumentando a produtividade e eficiência.

---

🎥 Demonstração

Veja abaixo uma demonstração do projeto em ação:

☄️ Funcionalidades

	Funcionalidade	Resumo
⚙️	Arquitetura	Utiliza FastAPI para APIs, Pydantic para validação e Docker para implantação.
🧩	Modularidade	Padrão MVC com módulos específicos para APIs, manipulação de arquivos e processamento.
⚡️	Desempenho	Conversão rápida com PyPDF2 e Pandas para otimização de processamento de dados.
🛡️	Segurança	Middleware CORS, validação de tipos de arquivo e boas práticas para proteger dados.
🌐	Interface Web Intuitiva	Interface simples para upload e análise de arquivos.
🔄	Extração e Conversão	Extração de dados específicos de PDFs e exportação para CSV e Excel.
📦	Dependências	Uso de pip e Docker para ambientes consistentes e instalação de bibliotecas.
🚀	Escalabilidade	Planejado para crescimento com FastAPI assíncrono e escalonamento via Docker.

---

🛸 Começando

📋 Pré-requisitos

Antes de começar com pdf-to-sheet, certifique-se de que seu ambiente de execução atende aos seguintes requisitos:

• Linguagem de Programação: Python 3.10+
• Gerenciador de Pacotes: Pip
• Tempo de Execução de Contêiner: Docker (Opicional)

⚙️ Instalação

Instale pdf-to-sheet usando um dos seguintes métodos:

Construir a partir do código-fonte:

1. Clone o repositório pdf-to-sheet:

   ❯ git clone https://github.com/DevDeividMoura/pdf-to-sheet

2. Navegue até o diretório do projeto:

   ❯ cd pdf-to-sheet

3. Instale as dependências do projeto:

   Usando pip  

   ❯ pip install -r requirements.txt

   Usando docker  

   ❯ docker compose --build

🚀 Executando

Execute pdf-to-sheet usando o seguinte comando no terminal:

❯ chmod +x ./start.sh

❯ ./start.sh

Usando docker  

❯ docker compose up -d

---

🤖 Como Usar

💻 Via Interface Web

• Acesse a Interface Web no navegador.
• Faça o upload do arquivo PDF desejado.
• Visualize os dados extraídos diretamente na interface.
• Exporte os dados para CSV ou Excel com um clique.

</> Via API

1. Envie um arquivo PDF para o endpoint /api/upload utilizando uma ferramenta como Postman ou curl:

   curl -X POST http://localhost:8080/api/v1/upload-pdf/ \
       -F "file=@seu-relatorio.pdf"

2. O retorno será um JSON com os dados extraídos:

   {
       "success": true,
       "message": "Data extracted successfully",
       "data": [
           {
               "Data": "01/01/2024",
               "Posto": "Auto Posto",
               "Total": "230,28",
               "Placa": "STRADA (ABC-1234)",
               "Odômetro": "118466"
           },
           ...
       ]
   }

---

🏎️💨 Roadmap

• Tarefa 1: Suporte para múltiplos formatos de relatórios.
• Tarefa 2: Validação e tratamento de erros avançados.
• Tarefa 3: Melhorias na interface web.

---

🔰 Contribuindo

• 💬 Participe das Discussões: Compartilhe suas ideias, forneça feedback ou faça perguntas.
• 🐛 Reportar Problemas: Submeta bugs encontrados ou registre solicitações de funcionalidades para o projeto pdf-to-sheet.
• 💡 Enviar Pull Requests: Revise PRs abertas e envie seus próprios PRs.

---

🎗 Licença

Lançado sob a Licença MIT.