Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 

Repository files navigation

EyeRest

A lightweight desktop eye-rest reminder built with Python and Tkinter, designed to help long-term computer users take regular breaks without interrupting their workflow.

Features

  • Borderless Interface: Utilizes system window override settings (overrideredirect) to remove standard OS title bars, delivering a clean and non-intrusive UI widget.
  • Floating Mini Mode: Supports collapsing the main window into a lightweight floating icon in the lower-right corner for background operation without cluttering the workspace.
  • Dynamic Animation & Alerts: Features visual text zooming and background color pulse alerts during the final 10 seconds of a countdown in mini mode.
  • Smart Pause Handling: Automatically pauses the timer when your PC locks or enters sleep mode, displays the paused duration, and asks whether to reset after extended pauses.
  • Drag-and-Drop Navigation: Allows both the main window and mini window to be freely moved across the desktop.
  • Accurate Event Handling: Distinguishes between click and drag actions to prevent accidental UI toggles.
  • Pomodoro Workflow Cycle: Includes a 60-minute focus session followed by a 5-minute break.
  • Customizable Themes & Opacity: Supports Catppuccin, Dark Gold, and Pastel Pink themes with adjustable opacity.
  • Autostart Compatibility: Can be packaged as a standalone executable and launched automatically when Windows starts.

Architecture & Technology Stack

  • GUI Framework: Python tkinter
  • System Integration: pywin32
  • Threading & Event Loop: Tkinter after()
  • Compilation Tool: PyInstaller

Prerequisites

  • Python 3.8 or higher
  • Windows OS

Download

You can download the latest Windows executable from:

Releases: https://github.com/SeniorBugEngineer/eyerest/releases

No Python installation required.

Installation & Setup

1. Clone the Repository

git clone https://github.com/SeniorBugEngineer/eyerest.git
cd eyerest

2. Install Required Dependencies

Install pywin32 for Windows lock/sleep event integration.

pip install pywin32

Build Executable (.exe)

Install PyInstaller:

pip install pyinstaller

Build the executable:

python -m PyInstaller --noconsole --onefile timer.py

After the build completes, the executable will be generated in:

dist/
└── timer.exe

Launch Automatically When Windows Starts

To automatically launch the application whenever Windows starts:

  1. Press Win + R.
  2. Type:
shell:startup
  1. Press Enter.
  2. Copy timer.exe into the Startup folder.

The application will automatically launch each time you sign in to Windows.


Demo

https://youtu.be/Oxd0DReYIDY?si=xnzOT2eIFV8Yy7LG

About

A lightweight desktop eye-rest reminder built with Python and Tkinter, designed to help long-term computer users take regular breaks without interrupting their workflow.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages