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.4.tar.gz (7.9 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.4-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pomodoro_multiplatform-1.0.4.tar.gz
  • Upload date:
  • Size: 7.9 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.4.tar.gz
Algorithm Hash digest
SHA256 a3b873821e69eba6a06d0895433e7a4d21632965f27dbf4eb87c7f34c680fca5
MD5 f6ade08a7af7003f5f00ec3601fef8e7
BLAKE2b-256 3162f9fbbba69e22283db735963caf0dab8fbc37e4055d424049b5d33d23fa4b

See more details on using hashes here.

Provenance

The following attestation bundles were made for pomodoro_multiplatform-1.0.4.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.4-py3-none-any.whl.

File metadata

File hashes

Hashes for pomodoro_multiplatform-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 5f1af47cde4a582c6f98753dcfc86c586f3f08900d7c48199c8eb8622542f339
MD5 a0c61641f87254b2d802d7a9edbe1804
BLAKE2b-256 90eb259265c27755374db692a33be7f47fb2c2286acc0760d5ee3003682b5dc0

See more details on using hashes here.

Provenance

The following attestation bundles were made for pomodoro_multiplatform-1.0.4-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