Skip to content

Repository files navigation

RstEye

Desktop break reminder for Ubuntu and macOS.

Install

python3 -m venv .venv
source .venv/bin/activate
python -m pip install -e .
rsteye

Run it from a logged-in graphical desktop session.

Configuration

Set these environment variables before starting:

export POPUP_INTERVAL=60  # minutes between reminders
export POPUP_DURATION=60  # seconds for each break

The app also reads .env from ~/.config/rsteye/ on Ubuntu or ~/Library/Application Support/RstEye/ on macOS.

Build

Install the build dependency:

python -m pip install -e '.[build]'

Validate the bundled assets:

python scripts/validate_resources.py

Build the Ubuntu binary:

python -m PyInstaller --clean --noconfirm --name rsteye --onefile --windowed \
  --paths src \
  --add-data "src/rsteye/resources/med.gif:rsteye/resources" \
  --add-data "src/rsteye/resources/rsteye.png:rsteye/resources" \
  --hidden-import=PIL.ImageTk \
  --additional-hooks-dir=packaging/pyinstaller/hooks app.py

Build the macOS app by running the same command with --onedir, the macOS icon, and --osx-bundle-identifier com.rsteye.rsteye.

About

An App to Promote Digital Breaks

Topics

Resources

Stars

6 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages