diff --git a/README.md b/README.md index 84f1078..d42d6bc 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,41 @@ # mamutovo-stats-bot -Týdenní statistiky Mamutovo.cz – bot tootuje každé pondělí přehled aktivity instance z účtu [@novinky@mamutovo.cz](https://mamutovo.cz/@novinky). +Statistický bot pro Mamutovo.cz. Tootuje týdenní a měsíční přehledy aktivity instance z účtu @novinky@mamutovo.cz. ## Co tootuje - -- Počet nových uživatelů za týden -- Počet aktivních uživatelů -- Počet tootů za týden -- Top hashtagy +- Počet nových a aktivních uživatelů +- Počet interakcí a tootů za období +- Sdílená média (fotky, videa) +- Nejaktivnější hodina dne +- Populární hashtagy +- Top tooty období (podle boostů + oblíbených) +- Top odkazy období +- Nejdiskutovanější toot +- Top přispěvatel +- Nový účet +- Porovnání s předchozím obdobím - Tip týdne (rotující seznam) -## Jak funguje +## Soubory +- daily_top.py – denní sběr dat z timeline (cron denně) +- weekly_report.py – generuje a posílá report (cron týdně/měsíčně) +- data/*.json – denní data, mazána po 60 dnech -Python skript spouštěný cronem každé pondělí v 9:00. Používá Mastodon admin API. +## Jak funguje +Python 3, pouze standardní knihovny. daily_top.py běží denně a ukládá data do data/. weekly_report.py sestaví report z nasbíraných dat a pošle ho na @novinky. + +## Režimy weekly_report.py +- výchozí – týdenní přehled +- --monthly – měsíční přehled +- --dry-run – jen vypíše, neodešle ## Požadavky - -- Python 3 -- Admin token pro mamutovo.cz -- Proměnná prostředí `NOVINKY_TOKEN` v souboru `.env` +- Python 3.9+ (kvůli zoneinfo) +- .env s proměnnými: NOVINKY_TOKEN, STATS_TOKEN, INSTANCE_URL ## Nasazení +Server: archos@VPS +Cesta: /opt/mamutovo-stats-bot/ -Server: `archos@VPS server` -Cesta: `/opt/mamutovo-stats-bot/` +## Licence +MIT