No description

Python 87.3%
HTML 12.1%
Dockerfile 0.3%
Nix 0.2%
Shell 0.1%

Find a file

xAndy 0c1a9a1890 chore(perf): stabilize query benchmark clock		2026-04-29 08:48:43 +00:00
.idea	add jetbrains .idea folder	2023-05-06 17:05:42 +02:00
.woodpecker	ci(qa): rename benchmark command in pipeline as well	2026-04-29 00:56:02 +02:00
scripts	chore: move benchmark command into its own app	2026-04-29 00:02:25 +02:00
shiftregister	chore(perf): stabilize query benchmark clock	2026-04-29 08:48:43 +00:00
storage	Store 'celerybeat-schedule' in a subdirectory	2022-04-26 17:36:08 +02:00
.dockerignore	build: export requirements.txt from uv	2026-04-21 22:32:27 +02:00
.editorconfig	build: export requirements.txt from uv	2026-04-21 22:32:27 +02:00
.env.example	add telegram messaging backend	2026-04-22 12:18:32 +00:00
.gitignore	chore(perf): stabilize query benchmark clock	2026-04-29 08:48:43 +00:00
compose.yaml	chore(deps): update rabbitmq docker tag to v4.3.0	2026-04-23 18:00:38 +00:00
Dockerfile	chore(deps): update ghcr.io/astral-sh/uv docker tag to v0.11.8	2026-04-28 10:17:13 +00:00
entrypoint.sh	move html import into subcommand	2022-04-29 00:20:50 +02:00
flake.lock	add nix dev env	2026-02-14 16:45:26 +00:00
flake.nix	Merge remote-tracking branch 'upstream/main'	2026-04-21 19:54:50 +00:00
LICENSE	Add LICENSE	2022-05-10 13:21:24 +02:00
manage.py	style: format code with black	2026-04-19 20:59:41 +02:00
pyproject.toml	expand test coverage for key user flows	2026-04-22 15:52:06 +00:00
README.md	docs: revert ci badges while per-workflow badges are not yet released [CI SKIP]	2026-04-23 13:21:15 +02:00
renovate.json	chore(renovate.json): force-enable semantic commits	2026-04-28 12:15:57 +02:00
texts.md	docs: add another SMS text	2025-05-17 19:38:22 +02:00
uv.lock	expand test coverage for key user flows	2026-04-22 15:52:06 +00:00

README.md

shiftregister

staging	production

project setup

make sure python >= 3.12 and uv are installed on your system
cp .env.example .env
sed -i '/^ENVIRONMENT=/c ENVIRONMENT=development' .env
uv run manage.py migrate
uv run manage.py createsuperuser
start development server with uv run manage.py runserver
start message queue with docker compose up -d broker result-backend
start runner with uv run celery -A shiftregister worker -B -l INFO
add calendars at http://127.0.0.1:8000/admin/importer/calendar/add/
change event state to 'event is running' at http://127.0.0.1:8000/admin/dynamic_preferences/globalpreferencemodel/3/change/

telegram setup

set TELEGRAM_SETTINGS=bot_token=... in .env
for local development without a public URL, use polling:
TELEGRAM_INBOUND_BACKEND=shiftregister.messaging.backends.telegram.polling.Receiver
TELEGRAM_OUTBOUND_BACKEND=shiftregister.messaging.backends.telegram.bot.Sender
if the bot previously used webhooks, clear them with uv run manage.py clear_telegram_webhook
register command hints with uv run manage.py set_telegram_commands

For production webhook mode:

set TELEGRAM_INBOUND_BACKEND=shiftregister.messaging.backends.telegram.bot.Receiver
set TELEGRAM_OUTBOUND_BACKEND=shiftregister.messaging.backends.telegram.bot.Sender
set TELEGRAM_WEBHOOK_SECRET=...
register command hints with uv run manage.py set_telegram_commands
register the webhook with uv run manage.py set_telegram_webhook "https://your-domain/messages/inbound/telegram?secret=$TELEGRAM_WEBHOOK_SECRET"