Skip to content

aios2005/checabordero

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📊 ChecaBordero API

Uma API desenvolvida com FastAPI para consultar e baixar os borderôs (boletim financeiro) dos jogos da Federação de Futebol do Piauí (FFP), sem precisar acessar manualmente o site oficial.


🚀 Propósito

Facilitar o acesso aos dados de competições organizadas pela FFP, como:

  • Lista de competições
  • Tabelas e fases
  • Partidas (com data, placar, times)
  • Download do borderô em PDF
  • Extração de informações do PDF (em breve)

🔧 Tecnologias Utilizadas


📂 Estrutura dos Arquivos

  • main.py → Arquivo principal da API (endpoints)
  • scraper.py → Módulo que faz o scraping de dados e baixa PDFs
  • coletar_partidas.py → Script auxiliar que coleta partidas via Playwright
  • requirements.txt → Dependências do projeto

📌 Endpoints Disponíveis

Rota Método Descrição
/ GET Verifica se a API está ativa
/competicoes GET Lista os campeonatos disponíveis
/tabelas?idcampeonato=... GET Mostra as fases da competição
/partidas?idcampeonato=...&id_fase=... GET Lista as partidas da fase
/bordero?id_partida=... GET Baixa o PDF do borderô da partida

⚙️ Como Executar

  1. Clone o repositório:

    git clone https://github.com/AntonioIvoDeOliveiraSouza/checabordero.git
    cd checa-bordero
  2. Crie e ative um ambiente virtual:

python -m venv venv
source venv/bin/activate  # Linux/macOS
.\venv\Scripts\activate   # Windows
  1. Instale as dependências:
pip install -r requirements.txt
  1. Execute a API:
uvicorn main:app --reload
  1. Acesse a documentação interativa:
http://localhost:8000/docs

A API pode ser acessada pela documentação no FastAPI acima, ou pelo próprio terminal, onde verá a documentação abaixo:

COMANDOS

  1. Para iniciar o projeto:
python scraper.py
  1. Para acessar os campeonatos disponíveis:
python scraper.py get_campeonato
  1. Para acessar as fases do campeonato:
python scraper.py get_tabelas <id_campeonato>
  1. Para acessar as partidas do campeonato:
python coletar_partidas.py coletar_partidas <id_campeonato> <id_fase>
  1. Para acessar os borderôs em pdf dos jogos:
python scraper.py get_bordero <id_partida>
  1. Para ler os dados dos borderôs no próprio terminal e criar txt:
python scraper.py extract_bordero <id_partida>

About

API desenvolvida com o propósito de obter dados de futebol // API developed which main purpose is gather football data

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages