Go to file
Krzysztof kuhy Rudnicki 8ed2082854 Document the durable-clone editable-install requirement
A one-off `pip install "diet_guard @ git+..."` from a scratch
directory was used during the original cutover; that's a non-editable
snapshot that a later git push silently never reaches. Document the
correct deployment convention (install.sh from a durable ~/diet-guard
clone) so this doesn't drift again.
2026-06-22 12:54:10 +02:00
.github/workflows Extract diet_guard from testsAndMisc as a standalone repo 2026-06-22 12:18:39 +02:00
diet_guard Extract diet_guard from testsAndMisc as a standalone repo 2026-06-22 12:18:39 +02:00
docs Extract diet_guard from testsAndMisc as a standalone repo 2026-06-22 12:18:39 +02:00
scripts Extract diet_guard from testsAndMisc as a standalone repo 2026-06-22 12:18:39 +02:00
.gitignore Extract diet_guard from testsAndMisc as a standalone repo 2026-06-22 12:18:39 +02:00
.pre-commit-config.yaml Extract diet_guard from testsAndMisc as a standalone repo 2026-06-22 12:18:39 +02:00
CLAUDE.md Document the durable-clone editable-install requirement 2026-06-22 12:54:10 +02:00
diet-guard-gate.service Extract diet_guard from testsAndMisc as a standalone repo 2026-06-22 12:18:39 +02:00
diet-guard-gate.timer Extract diet_guard from testsAndMisc as a standalone repo 2026-06-22 12:18:39 +02:00
install.sh Extract diet_guard from testsAndMisc as a standalone repo 2026-06-22 12:18:39 +02:00
pyproject.toml Extract diet_guard from testsAndMisc as a standalone repo 2026-06-22 12:18:39 +02:00
README.md Extract diet_guard from testsAndMisc as a standalone repo 2026-06-22 12:18:39 +02:00
requirements.txt Extract diet_guard from testsAndMisc as a standalone repo 2026-06-22 12:18:39 +02:00

diet_guard

A log-to-unlock gate: locks the desktop until a meal is logged once a meal slot (08:00 / 12:00 / 16:00 / 20:00) has elapsed without one, and tracks a sealed daily calorie/macro budget.

Install

bash install.sh

This installs the package + dependencies into system Python's user site-packages (the systemd service runs /usr/bin/python directly, not a venv — see CLAUDE.md), installs the systemd user timer, seals your daily budget, and locks the budget file immutable.

Usage

python -m diet_guard init          # one-time: compute and seal today's budget
python -m diet_guard gate --demo   # test the lock window (safe, closeable)

The timer runs the gate automatically every ~30 minutes; no manual invocation is needed once installed.

Development

python -m venv .venv && .venv/bin/pip install -r requirements.txt
.venv/bin/pre-commit install && .venv/bin/pre-commit install --hook-type pre-push
.venv/bin/python -m pytest diet_guard/tests/ --cov=diet_guard --cov-branch --cov-fail-under=100

See CLAUDE.md for scheduling details and production deployment gotchas, and docs/design.md for the original feature spec.