Skip to main content

A simple and elegant Pomodoro timer for the command line

Project description

🍅 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.

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

tpom-1.0.0.tar.gz (412.0 kB view details)

Uploaded Source

Built Distribution

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

tpom-1.0.0-py3-none-any.whl (412.0 kB view details)

Uploaded Python 3

File details

Details for the file tpom-1.0.0.tar.gz.

File metadata

  • Download URL: tpom-1.0.0.tar.gz
  • Upload date:
  • Size: 412.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for tpom-1.0.0.tar.gz
Algorithm Hash digest
SHA256 bf654893d2131d003d6e5bbe8e121e81d5b24178188f9ca085b2b1fea0596402
MD5 84f1af68b598ea37d9467cf22f51b19b
BLAKE2b-256 b5bac3302afa24c112f8ea5959136fd07d6cf21c1dc5b4beaccb2e48122e059e

See more details on using hashes here.

File details

Details for the file tpom-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: tpom-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 412.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for tpom-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e7e9bee827dcce727d5bd475d1bf595bf4a7610265f7532b918a274e4e97f99a
MD5 a28ab147fba54c6fac6eb516ca084a82
BLAKE2b-256 bba86ac195fabcf42e45ea825c2447d90fbced1bd45dcba811719590a722a1cd

See more details on using hashes here.

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