Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trehn/termdown
Countdown timer and stopwatch in your terminal
https://github.com/trehn/termdown
countdown python stopwatch terminal timer
Last synced: 3 days ago
JSON representation
Countdown timer and stopwatch in your terminal
- Host: GitHub
- URL: https://github.com/trehn/termdown
- Owner: trehn
- License: gpl-3.0
- Created: 2014-05-27T07:12:40.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-07-22T00:01:39.000Z (6 months ago)
- Last Synced: 2025-01-01T16:41:05.285Z (10 days ago)
- Topics: countdown, python, stopwatch, terminal, timer
- Language: Python
- Homepage:
- Size: 269 KB
- Stars: 1,376
- Watchers: 17
- Forks: 112
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
- awesome-list - termdown
- starred-awesome - termdown - Countdown timer and stopwatch in your terminal (Python)
README
![termdown demo](/termdown.gif?raw=true)
```
Usage: termdown [OPTIONS] [TIME]Starts a countdown to TIME. Example values for TIME:
10, '1h 5m 30s', '12:00', '2020-01-01', '2020-01-01 14:00 UTC'.If TIME is not given, termdown will operate in stopwatch mode
and count forward.Hotkeys:
E Show end time (countdown mode only)
L Lap (stopwatch mode only)
R Reset
SPACE Pause (will delay absolute TIME)
+ Plus (will add 10 seconds)
- Minus (will subtract 10 seconds)
Q QuitOptions:
-a, --alt-format Use colon-separated time format
-b, --blink Flash terminal at end of countdown
-B, --no-bell Don't ring terminal bell at end of countdown
-c, --critical N Draw final N seconds in red and announce them
individually with --voice or --exec-cmd
(defaults to 3)-e, --end Display target datetime of unpaused countdown
-f, --font FONT Choose from
http://www.figlet.org/examples.html-p, --voice-prefix TEXT Add TEXT to the beginning of --voice and
--exec annunciations (except per-second ones)-q, --quit-after N Quit N seconds after countdown (use with -b or
-t) or terminate stopwatch after N seconds-s, --no-seconds Don't show seconds (except for last minute of
countdown and first minute of stopwatch)-t, --text TEXT Text to display at end of countdown
-T, --title TEXT Text to display on top of countdown/stopwatch
-W, --no-window-title Don't update terminal title with
remaining/elapsed time-v, --voice VOICE Spoken countdown (at fixed intervals with per-
second annunciations starting at --critical;
requires `espeak` on Linux or `say` on macOS;
choose VOICE from `say -v '?'` or `espeak
--voices`)-o, --outfile PATH File to write current remaining/elapsed time
to--exec-cmd CMD Runs CMD every second. '{0}' and '{1}' in CMD
will be replaced with the remaining/elapsed
number of seconds and a more sparse
annunciation as in --voice, respectively. For
example, to get a callout at five seconds
only, use: --exec-cmd "if [ '{0}' == '5' ];
then say -v Alex {1}; fi"--no-figlet Don't use ASCII art for display
--no-figlet-y-offset INTEGER Vertical offset within the terminal (only for
--no-figlet)--no-text-magic Don't try to replace non-ASCII characters (use
with -t)--version Show version and exit
-z, --time Show current time instead of
countdown/stopwatch-Z, --time-format TEXT Format for --time/--end (defaults to
"%H:%M:%S", ignores --no-seconds)-D, --date-format TEXT Format for --end (defaults to "%Y-%m-%d")
--help Show this message and exit.
``````
pip install termdown
```------------------------------------------------------------------------
![PyPI version](http://img.shields.io/pypi/v/termdown.svg) ![Python 3.x](http://img.shields.io/badge/Python-3.x-green.svg) ![PyPI license](http://img.shields.io/badge/License-GPLv3-red.svg)