Skip to main content

A simple cross-platform Pomodoro timer with desktop notifications

Project description

Pomodoro Timer

A simple cross-platform Pomodoro timer. Manage work and break cycles with notifications and sound alerts.

Features

  • ✅ Work/break cycles based on the Pomodoro Technique
  • ✅ Desktop notifications (Windows/macOS/Linux support)
  • ✅ Sound notifications
  • ✅ Confirmation prompt after long breaks (continue/quit)
  • ✅ Customizable time settings

Default Settings

  • Work time: 25 minutes
  • Short break: 5 minutes
  • Long break: 15 minutes (every 2 sessions)

Installation

Option 1: Install from PyPI (Recommended)

Requires Python 3.8 or higher.

pip install pomodoro-multiplatform

Then run:

pomodoro

Option 2: Install from Source

git clone https://github.com/Rito0421/pomodoro.git
cd pomodoro
pip install -r requirements.txt

The timer will work without the plyer library, but notifications will be limited to console output.

Usage

Basic Usage

If installed via pip:

pomodoro

If running from source (macOS/Linux):

chmod +x pomodoro.py
./pomodoro.py

If running from source (Windows):

python pomodoro.py

Customization

# Set 50 min work time and 10 min short break
pomodoro --work 50 --short 10

# Set 20 min long break every 4 sessions
pomodoro --long 20 --every 4

If running from source, replace pomodoro with ./pomodoro.py or python pomodoro.py.

Options

Option Default Description
--work 25 Work time (minutes)
--short 5 Short break time (minutes)
--long 15 Long break time (minutes)
--every 2 Number of sessions before long break

Stopping

Press Ctrl+C to stop at any time.

How It Works

  1. Work timer starts (default 25 minutes)
  2. Notification and sound alert when work ends
  3. Short break (default 5 minutes)
  4. After specified number of sessions, long break (default 15 minutes)
  5. After long break, choose to continue or quit (macOS: GUI dialog, Windows/Linux: console input)
  6. If continuing, return to step 1

Platform-Specific Features

Feature macOS Windows Linux
Notifications Notification Center (fallback without plyer) plyer required plyer required
Sound System sound Beep Beep/Terminal bell
Confirmation GUI dialog Console input Console input

Requirements

  • Python 3.6 or higher
  • (Recommended) plyer - Install with pip install plyer

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pomodoro_multiplatform-1.0.5.tar.gz (8.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pomodoro_multiplatform-1.0.5-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file pomodoro_multiplatform-1.0.5.tar.gz.

File metadata

  • Download URL: pomodoro_multiplatform-1.0.5.tar.gz
  • Upload date:
  • Size: 8.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pomodoro_multiplatform-1.0.5.tar.gz
Algorithm Hash digest
SHA256 2c8d082571bbe0deac92e3f352f2c9f545a14447da2fe0c2f5b3e0ac9428a897
MD5 0ea629af292356ec4be7f183dfef69d9
BLAKE2b-256 956447188f6a542ef4e4a3ee396e6a8a3aced0022af4c6e276affb907b48eeb6

See more details on using hashes here.

Provenance

The following attestation bundles were made for pomodoro_multiplatform-1.0.5.tar.gz:

Publisher: publish.yml on Rito0421/pomodoro

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pomodoro_multiplatform-1.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for pomodoro_multiplatform-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 5cb7600f6952927fd393b4833688b3437c06450009f3032184bf66e6a0598ebd
MD5 f75c9ed8b09b860b91650da6d8f55f4d
BLAKE2b-256 0f65899f3c2570c44d2f0b6891ce6662a80b0cc69bfb7208d04080a5362c65e7

See more details on using hashes here.

Provenance

The following attestation bundles were made for pomodoro_multiplatform-1.0.5-py3-none-any.whl:

Publisher: publish.yml on Rito0421/pomodoro

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page