Skip to main content

A terminal Pomodoro timer with productivity stats

Project description

FlowTimer 🍅⏰

License: MIT Python Version

中文 | English

A minimalist command-line Pomodoro timer with productivity stats, built for developers who love the terminal.

Features ✨

  • ⏱️ Customizable intervals: flowtimer work 45 --break 10
  • 🎨 Beautiful terminal UI: Progress bars with rich library
  • 🔔 Cross-platform notifications: System alerts + sound
  • 📊 Daily stats: Track your focus time via flowtimer stats
  • ⏯️ Pause/Resume: Press Ctrl+P anytime

Installation 📦

pip install flowtimer

Quick Start 🚀

# Start a default session (25min work + 5min break)
flowtimer start

# Customize time (45min work, 10min break)
flowtimer start --work 45 --break 10

# Show today's stats
flowtimer stats

# Play a custom sound on finish
flowtimer start --sound-alert ~/ding.mp3

Configuration ⚙️

Create ~/.flowtimerrc to set defaults:

[settings]
work = 25
break = 5
sound_alert = /path/to/sound.mp3

Contributing 🤝

Issues and PRs are welcome!

  • Code Style: Follow PEP8
  • Testing: Add pytest unit tests
  • Docs: Update English or Chinese documentation

License 📄

Licensed under the MIT License.

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

flowtimer-0.1.0.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

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

flowtimer-0.1.0-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

Details for the file flowtimer-0.1.0.tar.gz.

File metadata

  • Download URL: flowtimer-0.1.0.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.10

File hashes

Hashes for flowtimer-0.1.0.tar.gz
Algorithm Hash digest
SHA256 281a170badb60ff4aac2128df71f79d29b6da15066977314bf524c41b5936b97
MD5 03fa02b355bcdb3b769dadab1ffb3164
BLAKE2b-256 f876c0a70d1a1cd4556798625e1d683c4641f2b62893ac13ac49320b48e919ae

See more details on using hashes here.

File details

Details for the file flowtimer-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: flowtimer-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.10

File hashes

Hashes for flowtimer-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c9c82e01a9744327c472ff01fb78a24721374b59c07630d328ea9f13d4ed3ea5
MD5 6f0cc5fd77aff997cc78c45fa077cca4
BLAKE2b-256 95c4c7856fee4c28f0a7bfe9b8cc02bd07f2e92d8e2bfb1f33a53862eb9672bf

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