Skip to main content

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.

Metadata

Release files for flowtimer 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for flowtimer 0.1.0
File Size Uploaded
flowtimer-0.1.0.tar.gz 5.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for flowtimer 0.1.0
File Interpreter ABI Platform
flowtimer-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 11.8 kB

Release files / flowtimer-0.1.0.tar.gz

Download URL flowtimer-0.1.0.tar.gz
Size 5.3 kB
Tags Source
SHA-256 checksum
How to use checksums
281a170badb60ff4aac2128df71f79d29b6da15066977314bf524c41b5936b97
BLAKE2b-256 checksum
How to use checksums
f876c0a70d1a1cd4556798625e1d683c4641f2b62893ac13ac49320b48e919ae
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.8.10

Release files / flowtimer-0.1.0-py3-none-any.whl

Download URL flowtimer-0.1.0-py3-none-any.whl
Size 6.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c9c82e01a9744327c472ff01fb78a24721374b59c07630d328ea9f13d4ed3ea5
BLAKE2b-256 checksum
How to use checksums
95c4c7856fee4c28f0a7bfe9b8cc02bd07f2e92d8e2bfb1f33a53862eb9672bf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.8.10

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page