No description
Find a file
2025-06-17 11:58:51 +02:00
src/pomodoro_timer fix: audio only taken at the end 2025-06-17 11:58:51 +02:00
.gitignore init 2025-06-17 11:54:47 +02:00
LICENSE init 2025-06-17 11:54:47 +02:00
pyproject.toml init 2025-06-17 11:54:47 +02:00
README.md init 2025-06-17 11:54:47 +02:00

🍅 tpom - Pomodoro Timer CLI

A simple and elegant Pomodoro timer for the command line, built with Python.

Features

  • Clean countdown display
  • 🔔 Gentle alarm sound notification
  • 🚫 Easy cancellation with Ctrl+C
  • 🎵 Custom sound file support
  • 📦 Easy installation via pip
  • 🔇 Silent operation if sound unavailable (no grating fallbacks)

Installation

From PyPI (when published)

pip install tpom

From source

git clone https://github.com/yourusername/tpom.git
cd tpom
pip install -e .

Usage

Basic usage

tpom
# You'll be prompted to enter the duration in minutes

Specify duration directly

tpom --minutes 25

Use custom sound file

tpom --minutes 25 --sound-file /path/to/your/sound.mp3

Get help

tpom --help

Development

Setup development environment

git clone https://github.com/yourusername/tpom.git
cd tpom
pip install -e ".[dev]"

Run tests

pytest

Format code

black src/

Lint code

flake8 src/
mypy src/

License

MIT License - see LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.