Skip to content

hluk/xitomatl

Repository files navigation

Simple pomodoro timer app residing in tray.

Install and Run

There is no need to install the app. Single file executables are provided.

You can grab latest build artifacts from a successful GitHub action run.

Workflow Example

The application runs as tray icon and shows current task progress in minutes.

Initial stopped state (if autostart is not enabled): stopped

Focus task runs after tray icon is clicked: focus 25 minutes remainingfocus 1 minute remaining focus 0 minutes remaining focus 1 minute overtime

Break runs after tray icon is clicked again: break 5 minutes remainingbreak 1 minute remaining break 0 minutes remaining break 1 minute overtime

Another focus task runs after tray icon is clicked again: focus 25 minutes remaining

After few iterations large break runs: break 30 minutes remaining

The tasks, breaks and their meaning can be fully customized in the configuration file.

Controls

The behavior may depend on the desktop environment.

  • Left mouse button click - Starts next task (the first one if stopped)
  • Right mouse button click - Opens menu
  • Middle click - Stops and resets progress

Configuration File

The configuration file contains general settings and task definitions.

The default configuration file location:

  • Linux and macOS - ~/.config/xitomatl/xitomatl.ini
  • Windows - %APPDATA%\copyq

See xitomatl.ini for the default configuration.

Development

Qt 6 libraries must be installed on the system.

Clone repository and start the app with:

poetry run python -m ensurepip --upgrade
poetry install
poetry run xitomatl

Install pre-commit for local repository clone:

pre-commit install

Run all checks:

pre-commit run --all-files
poetry run pytest

About

Simple pomodoro timer app residing in tray

Resources

License

Stars

Watchers

Forks

Packages

No packages published