Skip to main content

CLI coffee cooldown timer with a shrinking ASCII bar.

Project description

decafe-timer

PyPI - Version PyPI - Python Version

A lightweight CLI cooldown timer for coffee breaks and caffeine tracking. It was created for people who worry about taking too much caffeine and becoming dependent on it.

decafe-timer screenshot

Installation

pipx install decafe-timer

Usage

The CLI follows a simple story:

  1. Provide a duration to set a timer. You can use single durations (2h, 15m30s, 0:45:00) or a remaining/total pair like 3h/5h (spaces around / are allowed, and mixed formats like 3h/4:50:00 work too).
  2. Once the timer expires, snapshots show [You may drink coffee now.].
  3. clear removes the stored timer so idle displays show ---.
  4. --run keeps the display updating until the cooldown expires; without it, a snapshot is printed once.
  5. Style flags customize the ASCII layout.
    • --one-line uses HH:MM:SS ✕ ✕ ✕ ….
    • --graph-only prints just the bar.
    • --bar-style swaps the bar characters (greek-cross default, counting-rod, or blocks for the previous look).
  6. Color output is controlled separately.
    • ANSI is auto-enabled on TTYs.
    • --color=always forces ANSI on; --color=never forces it off (applies to both live and snapshot output).
decafe-timer 45m          # start a new timer, print one snapshot
decafe-timer 3h/5h        # start with 3h remaining out of a 5h total
decafe-timer              # resume the latest timer, one snapshot
decafe-timer --run 45m    # start a new timer and watch it count down
decafe-timer --run        # resume the live UI for an active timer
decafe-timer --run --one-line 10m  # live ASCII updates on one line
decafe-timer --bar-style blocks   # use the classic block bar
decafe-timer --bar-style counting-rod  # use the counting rod bar
decafe-timer --graph-only # snapshot with the ASCII bar only
decafe-timer clear        # clear the current timer (shows ---)
decafe-timer --version    # show the current version

License

decafe-timer is distributed under the terms of 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

decafe_timer-0.6.0.tar.gz (1.7 MB view details)

Uploaded Source

Built Distribution

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

decafe_timer-0.6.0-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

Details for the file decafe_timer-0.6.0.tar.gz.

File metadata

  • Download URL: decafe_timer-0.6.0.tar.gz
  • Upload date:
  • Size: 1.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.16.2 cpython/3.12.3 HTTPX/0.28.1

File hashes

Hashes for decafe_timer-0.6.0.tar.gz
Algorithm Hash digest
SHA256 acb88cca32f340c22a64bd3bbb0ea81f7899a66eb287b1ac49f748f92986d333
MD5 7c0e5a638d0658b51868371791c8cdfe
BLAKE2b-256 bb269313b0a7474e4a212f0d886ce0b51433720e999cd1413e8f2ec1fd81df6b

See more details on using hashes here.

File details

Details for the file decafe_timer-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: decafe_timer-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 10.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.16.2 cpython/3.12.3 HTTPX/0.28.1

File hashes

Hashes for decafe_timer-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 24f748d75b33a5ebe3aa063f3b4a84af03f49631e368637e4696892e7c501db1
MD5 114b9b06d2cb5ced740daa57e4c5a75e
BLAKE2b-256 e8609372d72013c0059297a5df140229caa72358c64556c201850edaea075471

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