Skip to main content

Countdown timer for your terminal

Project description

termdown demo

usage: termdown [-h] [-a] [-b] [-B] [-c N] [-e] [-f FONT] [--font-charset CHARSET] [--font-size N] [-p TEXT]
                [-q N] [-s] [-t TEXT] [-T TITLE] [-W] [-v VOICE] [-o PATH] [--exec-cmd CMD] [--no-art]
                [--no-text-magic] [-z] [-Z TIME_FORMAT] [-D DATE_FORMAT] [--version]
                [timespec]

    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	Quit

positional arguments:
  timespec              TIME to countdown to. Example values: 10, '1h 5m 30s', '12:00', '2020-01-01', '2020-01-01 14:00 UTC'. If not given, operates in stopwatch mode.

options:
  -h, --help            show this help message and exit
  -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 https://www.ascii-art.site/FontList.html or provide a full path to an OTF/TTF file
  --font-charset CHARSET
                        Provide a string of characters of increasing visual density (e.g. " .oO#@") to render OTF/TTF pixels
  --font-size N         Set font size when using OTF/TTF
  -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 TITLE     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-art              Don't use ASCII art for display
  --no-text-magic       Don't try to replace non-ASCII characters (use with -t)
  -z, --time            Show current time instead of countdown/stopwatch
  -Z, --time-format TIME_FORMAT
                        Format for --time/--end (defaults to "%H:%M:%S", ignores --no-seconds)
  -D, --date-format DATE_FORMAT
                        Format for --end (defaults to "%Y-%m-%d")
  --version             Show version and exit
pip install termdown

PyPI version   Python 3.x   PyPI 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

termdown-2.0.0.tar.gz (24.3 kB view details)

Uploaded Source

Built Distribution

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

termdown-2.0.0-py3-none-any.whl (26.2 kB view details)

Uploaded Python 3

File details

Details for the file termdown-2.0.0.tar.gz.

File metadata

  • Download URL: termdown-2.0.0.tar.gz
  • Upload date:
  • Size: 24.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for termdown-2.0.0.tar.gz
Algorithm Hash digest
SHA256 88e93e7670063d375d8ca17d9be374c0fcc634f122a2fa7e5cc66dd601a4884e
MD5 a1e266048b3ee00e31be008c1e8168d0
BLAKE2b-256 6ba2d2cd7ac43a878ee386ba2415784ef86873961fe996bfd1ca335bda07068d

See more details on using hashes here.

File details

Details for the file termdown-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: termdown-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 26.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for termdown-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 23d0d3c70765345dfe7e8a79e76c7b19d2ff2950bb7948ba080b4362fe29cac4
MD5 33042af62212ceb1d35a0784e3ebb070
BLAKE2b-256 dc24f066317a4722e9e9f383f65268adbc63421fb35347a7897fc7ed550f487f

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