Skip to main content

Pipeline Docker-first para scraping de reviews, geração de respostas e relatórios Telegram com API, dashboard, Redis/RQ, Selenium e n8n.

Wiki · Quickstart · API REST · Dashboard · Telegram · n8n · About

Por que este projeto existe

Este repositório organiza uma rotina operacional completa para reviews do Doctoralia. Em vez de tratar scraping como um script solto, ele une coleta, análise, geração de respostas, snapshots persistidos, histórico, observabilidade, autenticação do dashboard e distribuição por Telegram em uma mesma stack local.

O que você encontra aqui

Bloco O que faz
api Expõe endpoints sync e async, settings, health, metrics e notificações Telegram
worker Processa scraping, análise, geração e snapshots em background
dashboard Workspace visual para operação diária, histórico, relatórios, perfil do operador e scheduler
redis Fila RQ, métricas Redis-backed, agendamentos, locks e histórico
selenium Navegador remoto para scraping resiliente
n8n Orquestrações externas, callbacks e automações multi-sistema

Tour visual

Overview do dashboard Agendamentos Telegram do dashboard
Workspace operacional
Perfis, pendências, saúde da stack, relatórios e histórico de snapshots.
Scheduler Telegram
Recorrência, scraping novo, geração, anexos, health e histórico persistido.

Como a stack funciona

Workflow principal do projeto

Início rápido

Docker

cp .env.example .env
cp config/config.example.json config/config.json

docker compose up -d --build
docker compose ps

URLs locais esperadas:

  • API: http://localhost:8000/docs
  • Dashboard: http://localhost:5000 (redireciona para /login quando a auth estiver ativa)
  • Telegram scheduling: http://localhost:5000/notifications/telegram/schedule
  • n8n: http://localhost:5678 com Basic Auth configurada no .env
  • Selenium status: http://localhost:4444/status

Primeiro acesso ao dashboard:

  • usuário padrão: o campo user_profile.username em config/config.json (por padrão, admin)
  • senha inicial: a API_KEY enquanto o bootstrap estiver ativo e ainda não existir dashboard_password_hash
  • troca de senha: faça depois do login em http://localhost:5000/me

Desenvolvimento local

make venv
cp .env.example .env
cp config/config.example.json config/config.json

make api
make dashboard

Comandos úteis:

make run-url URL="https://www.doctoralia.com.br/medico/exemplo"
make run-full URL="https://www.doctoralia.com.br/medico/exemplo"
make test
make lint

Endpoints que importam

Método Endpoint Uso
POST /v1/scrape:run Scraping síncrono
POST /v1/jobs Cria job assíncrono
GET /v1/jobs/{job_id} Consulta job
GET /v1/ready Readiness com Redis, fila, PostgreSQL, Selenium e NLTK
GET /v1/metrics Métricas da API persistidas em Redis
GET /v1/auth/status Estado da autenticação do dashboard
POST /v1/auth/login Validação de credenciais do dashboard
POST /v1/auth/change-password Rotação da senha dedicada do dashboard
GET/POST/PUT/DELETE /v1/notifications/telegram/schedules CRUD do scheduler Telegram
POST /v1/notifications/telegram/schedules/{schedule_id}/run Disparo manual
GET /v1/notifications/telegram/history Histórico persistido
POST /v1/notifications/telegram/test Validação real do bot
POST /v1/hooks/n8n/scrape Webhook dedicado do n8n

Estado atual do projeto

Tema Situação
Stack Docker api, worker, dashboard, db/db-init, redis, selenium, n8n
Workspace web Operacional, autenticado e com scheduler Telegram integrado
Persistência Snapshots em data/, histórico/schedules em Redis e schema base em PostgreSQL
Métricas da API Redis-backed, multi-processo
n8n local preso em 127.0.0.1:5678, com auth e encryption key obrigatórias
Testes suíte cobrindo áreas críticas de API, dashboard, jobs, Redis e Telegram
Auth do dashboard login web, sessão assinada, bootstrap via API_KEY e rotação em /me

Redis em localhost:6379

Se você abrir http://localhost:6379 no navegador e receber ERR_EMPTY_RESPONSE, isso é esperado.

  • Redis está rodando.
  • O browser fala HTTP.
  • Redis não fala HTTP.

Validação correta:

docker compose exec -T redis redis-cli ping

Saída esperada:

PONG

Wiki do repositório

O README agora é só a entrada. A documentação foi reorganizada em formato de wiki dentro de docs/.

Página Para que serve
docs/Home.md Hub principal da wiki
docs/about.md Texto de vitrine, metadata e assets do repositório
docs/quickstart.md Setup rápido
docs/overview.md Arquitetura e responsabilidades
docs/dashboard-workspace.md Operação diária no dashboard
docs/telegram-notifications.md Scheduler Telegram completo
docs/api.md Referência da API
docs/n8n.md Workflows e integração externa
docs/operations.md Runbook e troubleshooting
docs/development.md Padrões de desenvolvimento
docs/deployment.md Guia de deploy
docs/templates.md Templates e mensagens

Assets visuais adicionados

Convenções técnicas

  • Imports internos padronizados em formato absoluto: from src...
  • Dependências gerenciadas por poetry
  • Formatação com black e isort
  • Testes com pytest

Limitações atuais

  • Rate limiting global da API REST ainda não existe como middleware completo.
  • O scheduler recorrente depende da API estar de pé.
  • A troca de senha do dashboard hoje valida apenas o mínimo de caracteres no backend; complexidade adicional ainda é recomendação de UX, não requisito de servidor.
  • Ainda há espaço para subir coverage em src/scraper.py, src/response_generator.py, src/telegram_notifier.py e src/dashboard/.

Licença

MIT

Release files for doctoralia-scrapper 2.5.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for doctoralia-scrapper 2.5.4
File Size Uploaded
doctoralia_scrapper-2.5.4.tar.gz 132.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for doctoralia-scrapper 2.5.4
File Interpreter ABI Platform
doctoralia_scrapper-2.5.4-py3-none-any.whl Python 3 none any Details

Total release size: 295.3 kB

Release files / doctoralia_scrapper-2.5.4.tar.gz

Download URL doctoralia_scrapper-2.5.4.tar.gz
Size 132.2 kB
Tags Source
SHA-256 checksum
How to use checksums
76978064e7fda04e6a927084bd032d00f49ba36590177f4a46986a12db130828
BLAKE2b-256 checksum
How to use checksums
58c071f9ab3116373d5f5148e9086ecd561ee2c457196d9546969e95dc3ce34a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release files / doctoralia_scrapper-2.5.4-py3-none-any.whl

Download URL doctoralia_scrapper-2.5.4-py3-none-any.whl
Size 163.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
61147ed0196aed68ae8dd05ddfc04342a905528d1bf4bea5f0f154a5dae02bb5
BLAKE2b-256 checksum
How to use checksums
38d2f0106c72312027c40aaaef3648a5a1447ea959e72f267c52c0e0e5c4f4d5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release history Release notifications | RSS feed

This release

2.5.4 This release

2 release files

2.5.3

2 release files

2.5.2

2 release files

2.5.1

2 release files

2.5.0

2 release files

2.4.3

2 release files

2.4.2

2 release files

2.4.1

2 release files

2.4.0

2 release files

2.3.1

2 release files

2.3.0

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.2.0

2 release files

1.1.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page