Skip to content

Commit 1e8ff3d

Browse files
committed
docs(scrappers): comandos e cron de notificação semanal/mensal no README
1 parent ecf4fea commit 1e8ff3d

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

mamute_scrappers/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,33 @@ python -m mamute_scrappers.scripts.create_users
9090
Esse comando é um backfill manual. A sincronização contínua Ghost -> projetos é
9191
recebida pela API em `POST /api/webhooks/ghost/members`.
9292

93+
### Relatórios por e-mail (notificação)
94+
95+
Execute na **raiz** do repositório (`mamute-politico`). Configure `DATABASE_URL` e
96+
as variáveis `SMTP_*` em `mamute_scrappers/.env` (veja `.env.example`). Em produção,
97+
cada projeto só recebe o relatório se o tier tiver a periodicidade em
98+
`tiers.detalhes.periodicidade_email` (ex.: `["week"]` ou `["month"]`).
99+
100+
Documentação completa: [`scripts/notificacao/README.md`](scripts/notificacao/README.md).
101+
102+
```bash
103+
# Listar destinatários elegíveis (sem enviar)
104+
python -m mamute_scrappers.scripts.notificacao --periodicidade week --list-only
105+
python -m mamute_scrappers.scripts.notificacao --periodicidade month --list-only
106+
107+
# Relatório semanal — todos os projetos com "week" no tier
108+
python -m mamute_scrappers.scripts.notificacao --periodicidade week
109+
110+
# Relatório mensal — todos os projetos com "month" no tier
111+
python -m mamute_scrappers.scripts.notificacao --periodicidade month
112+
```
113+
114+
Teste de um projeto (HTML em `mamute_scrappers/scripts/notificacao/output/`):
115+
116+
```bash
117+
python -m mamute_scrappers.scripts.notificacao --periodicidade week --projeto-id 1 --dry-run
118+
```
119+
93120
## Cronjobs recomendados
94121

95122
Exemplo de configuração para atualização contínua de projetos, trâmites e dados auxiliares:
@@ -122,6 +149,12 @@ LOG_DIR=mamute-politico/mamute_scrappers/.logs
122149
123150
# Parlamentares da Câmara (diário às 05h30)
124151
30 5 * * * cd $PROJECT_ROOT && $PYTHON_BIN -m mamute_scrappers.camara_crawler.parliamentarian >> $LOG_DIR/crawlers/camara_parliamentarians.log 2>&1
152+
153+
# Relatórios por e-mail — semanal (segundas 08:00)
154+
0 8 * * 1 cd $PROJECT_ROOT && $PYTHON_BIN -m mamute_scrappers.scripts.notificacao --periodicidade week >> $LOG_DIR/notificacao/week.log 2>&1
155+
156+
# Relatórios por e-mail — mensal (dia 1, 08:00)
157+
0 8 1 * * cd $PROJECT_ROOT && $PYTHON_BIN -m mamute_scrappers.scripts.notificacao --periodicidade month >> $LOG_DIR/notificacao/month.log 2>&1
125158
```
126159

127160
## Observações

0 commit comments

Comments
 (0)