Metadata-Version: 2.4
Name: decafe-timer
Version: 0.7.0
Summary: CLI coffee cooldown timer with a shrinking ASCII bar.
Project-URL: Issues, https://github.com/tos-kamiya/decafe-timer/issues
Project-URL: Source, https://github.com/tos-kamiya/decafe-timer
Author-email: Toshihiro Kamiya <kamiya@mbj.nifty.com>
License-Expression: MIT
License-File: LICENSE.txt
Keywords: cli,coffee,productivity,timer
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.10
Requires-Dist: appdirs
Provides-Extra: dev
Requires-Dist: pytest; extra == 'dev'
Description-Content-Type: text/markdown

# decafe-timer

[![PyPI - Version](https://img.shields.io/pypi/v/decafe-timer.svg)](https://pypi.org/project/decafe-timer)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/decafe-timer.svg)](https://pypi.org/project/decafe-timer)

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](https://raw.githubusercontent.com/tos-kamiya/decafe-timer/main/images/shot1.png)

## Installation

```console
pipx install decafe-timer
```

## Usage

### Basics

```console
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 clear        # clear the current timer (shows ---)
```

### Options

```console
decafe-timer --one-line        # use the single-line ASCII layout
decafe-timer --graph-only      # snapshot with the ASCII bar only
decafe-timer --bar-style blocks        # use the classic block bar
decafe-timer --bar-style counting-rod  # use the counting rod bar
decafe-timer --color=always    # force ANSI colors on
decafe-timer --color=never     # force ANSI colors off
decafe-timer --run 45m         # alias for `run` (start live countdown)
decafe-timer --run             # alias for `run` (resume live countdown)
decafe-timer --clear           # alias for `clear` (shows ---)
decafe-timer 0                 # clear using a zero duration
decafe-timer --version         # show the current version
```

## License

`decafe-timer` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
