Licitaíba - Extrator de Licitações do Diário Oficial da Paraíba

Logo do projeto Licitaíba

O projeto "Licitaíba" é uma iniciativa destinada a automatizar a coleta e o acompanhamento de informações relacionadas a licitações públicas no estado da Paraíba, Brasil.

Bandeira da Paraíba

---

👨‍🔧 Tutorial para executar o Projeto "Licitaíba"

Este é um guia passo a passo para ajudar você a executar o projeto em sua máquina. Primeiramente você precisa entender como o projeto funciona. Cada script é rodado por agendamento de forma automática de segunda a sexta, seguindo uma ordem que deve ser respeitada, tudo isso ocorre pelo git actions.

• Repositório front-end
• Documentação
• Post mortem

⚠️ Pré-requisitos

• Python v3.10.12 ou superior

1. ⏬ Clonar o Repositório

Para começar, abra o terminal e clone o repositório do GitHub em um diretório local da seguinte maneira:

git clone https://github.com/unb-mds/2023-2-Squad04.git

2. 🚢 Navegar até a pasta "src" 🗂️

Vamos entrar na pasta "src" do projeto usando o terminal. Certifique-se de estar na raiz do repositório clonado:

cd 2023-2-Squad04/src

3. 💻 Baixar pdfs de acordo com a última data resgistrada no pdf_downloader_last_date.txt

Nesse passo, o script de download sempre começa após a data posterior registrada no arquivo txt, ao concluir os downloads, o conteúdo do arquivo é atualizado com a data do último PDF baixado. O script está agendado para rodar às 08:00h., usando o seguinte comando:

python3 pdf_downloader.py

4. 📑 Listar o diretório src/pdfs/ e gravar em um txt todos os pdfs baixados

Essa é a segunda ação programada no repositório que ira ocorrer às 08:10hrs, usando o seguinte comando:

python3 list_dir.py

5. 📖 Extração das licitações dos pdfs baixados no passo anterior

Seguindo a ordem, essa é a terceira ação programada que ocorrerá às 08:20hrs, usando o seguinte comando:

python3 readpdf.py

6. 🌐 Contar a quantidade de licitações em cada municipio em todo os dados extraídos no arquivo json gerado pelo readpdf

Quarta ação programada que ocorrerá às 08:30hrs, usando o seguinte comando:

python3 counter.py

7. 🗑️ Remoção dos Pdfs baixados

Quinto e último comando programado no repositório, que será acionado às 18:30hrs, usando o seguinte comando:

python3 remove_pdf.py

---

🤝 Colaboradores

Carlos-kadu

DaniloCTM

show-dawn

Julio1099

patyhelenaa

rayenealmeida

aqela-batata-alt

📝 Licença

The MIT License (MIT)