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 timer for caffeine clearance and intake tracking. It was created for people who want to pace caffeine and avoid overuse.

Note: The command structure changed significantly in 0.9.0.

decafe-timer screenshot

Installation

pipx install decafe-timer

Usage

The model is intentionally simple:

  • Memory (mem) is the bar's maximum length and the default intake size.
  • Remaining time is treated as the amount of caffeine still in your body.
  • intake adds to the remaining amount; the bar shrinks as it clears.
  • If you intake again before it reaches zero, remaining can exceed mem and the bar shows >>.

Basics

decafe-timer              # show a snapshot if active; otherwise show ---
decafe-timer mem 3h       # set bar memory (default intake size)
decafe-timer mem          # show current bar memory
decafe-timer intake 45m   # add intake time (starts a new timer if none)
decafe-timer intake       # add the memory amount
decafe-timer +5h          # short form for intake 5h
decafe-timer clear        # clear the current timer (shows ---)
decafe-timer run          # resume the live UI for an active timer
decafe-timer config       # show memory + bar style + layout

Options

decafe-timer --layout one-line        # use the single-line ASCII layout (temporary)
decafe-timer --layout graph-only      # snapshot with the ASCII bar only (temporary)
decafe-timer --one-line               # legacy alias for --layout one-line (temporary)
decafe-timer --graph-only             # legacy alias for --layout graph-only (temporary)
decafe-timer --bar-style blocks        # use the classic block bar (temporary)
decafe-timer --bar-style counting-rod  # use the counting rod bar (temporary)
decafe-timer --color=always    # force ANSI colors on
decafe-timer --color=never     # force ANSI colors off
decafe-timer --version         # show the current version

Configuration

decafe-timer config --bar-style blocks       # save the default bar style
decafe-timer config --layout one-line        # save the default layout
decafe-timer config --layout graph-only      # save the default layout
decafe-timer config --one-line               # legacy layout setter (saves default)
decafe-timer config --graph-only             # legacy layout setter (saves default)

Notes

  • run, intake, mem, config, and clear are mutually exclusive in the same invocation.
  • intake extends the remaining time without changing the bar scale.
  • If the timer is expired, intake starts a new timer from now.
  • mem defaults to 3h when not yet set.
  • --bar-style and --layout are temporary unless used with config.
  • When the remaining time exceeds the bar scale, a >> suffix is shown at the end of the bar.
  • decafe-timer shows status without changing state; decafe-timer 45m is invalid.

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.9.0.tar.gz (2.6 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.9.0-py3-none-any.whl (13.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for decafe_timer-0.9.0.tar.gz
Algorithm Hash digest
SHA256 7bf5c863546e04c0268b8afb3203e81295e2c6db8d6ab0139288080f087d38d7
MD5 b397200d78f0b5b5d09f1c16465ea460
BLAKE2b-256 4d9c891eb237ef1224124360d5e91dec1558828ffe682c7d25d27276a311c04a

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for decafe_timer-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2669c97d57bf5ec553df166927b2d3ad39c01e9757d03fb306016ca04a9cd8d6
MD5 6a445a5c913c2647d950fd1a54c90205
BLAKE2b-256 880d71c48f70fa558c22f894bc4253e7390c81ecd67547523b9df23c0dd81176

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