Rename project to signal-cal-bot

- package src/signal-cal-bot -> src/signal_cal_bot
- distribution and CLI entry point: signal-cal-bot
- env vars CALBOT_* -> SIGNAL_CAL_BOT_*
- database file, container names, user agents and logs renamed
- docs and compose updated
This commit is contained in:
2026-11-18 16:45:54 +00:00
parent 751fa518e6
commit 2b32c1a7f2
23 changed files with 55 additions and 55 deletions
+9 -9
View File
@@ -1,4 +1,4 @@
# calbot — iCalendar → Signal
# signal-cal-bot — iCalendar → Signal
Polls an iCalendar feed and posts events to a Signal group, with the event's
poster image attached. Built for [MCR Commons](https://commonscalendar.uk) (The
@@ -76,7 +76,7 @@ mkdir -p signal-data data cache
docker compose up -d signal-api
```
Open <http://localhost:8080/v1/qrcodelink?device_name=calbot> and scan it from
Open <http://localhost:8080/v1/qrcodelink?device_name=signal-cal-bot> and scan it from
**Signal → Settings → Linked devices**.
> Linking as a secondary device means the bot posts **as your own number**.
@@ -104,8 +104,8 @@ https.
### 3. Verify, preview, run
```bash
docker compose run --rm bot python -m calbot --check # config + account
docker compose run --rm bot python -m calbot --dump # rendered posts, no sending
docker compose run --rm bot python -m signal_cal_bot --check # config + account
docker compose run --rm bot python -m signal_cal_bot --dump # rendered posts, no sending
docker compose up -d bot
docker compose logs -f bot
```
@@ -114,10 +114,10 @@ docker compose logs -f bot
| Command | Purpose |
|---|---|
| `calbot --config config.toml` | Run the loop |
| `calbot --once` | Run a single tick and exit |
| `calbot --dump` | Print rendered posts for the feed; uses a temporary DB, sends nothing |
| `calbot --check` | Validate config and confirm the Signal account is linked |
| `signal-cal-bot --config config.toml` | Run the loop |
| `signal-cal-bot --once` | Run a single tick and exit |
| `signal-cal-bot --dump` | Print rendered posts for the feed; uses a temporary DB, sends nothing |
| `signal-cal-bot --check` | Validate config and confirm the Signal account is linked |
All commands accept `--log-level` (or `LOG_LEVEL`).
@@ -163,7 +163,7 @@ All commands accept `--log-level` (or `LOG_LEVEL`).
| Follow logs | `docker compose logs -f bot` |
| Apply config changes | edit `config.toml`, then `docker compose restart bot` |
| Update code | `git pull && docker compose up -d --build` |
| Reset duplicate/seen state | stop bot, delete `data/calbot.sqlite3`, start (re-seeds silently) |
| Reset duplicate/seen state | stop bot, delete `data/signal-cal-bot.sqlite3`, start (re-seeds silently) |
| Clear image cache | `rm -rf cache/images` |
| Back up | `signal-data/` (linked-device keys) and `config.toml` |