https://github.com/davep/textual-countdown

A visual countdown timer for Textual applications
https://github.com/davep/textual-countdown

countdown python python3 terminal textual textual-framework timer widget

Last synced: about 2 months ago
JSON representation

A visual countdown timer for Textual applications

• Host: GitHub
• URL: https://github.com/davep/textual-countdown
• Owner: davep
• License: mit
• Created: 2024-01-11T22:31:27.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-04T21:19:28.000Z (over 1 year ago)
• Last Synced: 2025-01-20T06:59:22.681Z (10 months ago)
• Topics: countdown, python, python3, terminal, textual, textual-framework, timer, widget
• Language: Python
• Homepage: https://pypi.org/project/textual-countdown/
• Size: 466 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# textual-countdown

![Textual Countdown demo](https://raw.githubusercontent.com/davep/textual-countdown/main/docs/source/textual-countdown.gif)

[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/davep/textual-countdown/style-and-lint.yaml)](https://github.com/davep/textual-countdown/actions)

[![GitHub commits since latest release](https://img.shields.io/github/commits-since/davep/textual-countdown/latest)](https://github.com/davep/textual-countdown/commits/main/)

[![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/davep/textual-countdown)](https://github.com/davep/textual-countdown/issues)

[![GitHub Release Date](https://img.shields.io/github/release-date/davep/textual-countdown)](https://github.com/davep/textual-countdown/releases)

[![PyPI - License](https://img.shields.io/pypi/l/textual-countdown)](https://github.com/davep/textual-countdown/blob/main/LICENSE)

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/textual-countdown)](https://github.com/davep/textual-countdown/blob/main/pyproject.toml)

[![PyPI - Version](https://img.shields.io/pypi/v/textual-countdown)](https://pypi.org/project/textual-countdown/)

## Introduction

This library provides a simple visual countdown widget, designed to subtly

let the user know that a period of time is passing; essentially a simple

"wait some time" progress bar.

Uses could be as a non-intrusive countdown in some sort of quiz application,

or a cool-down display in an application that's waiting to hit a busy API

endpoint again.

## Installing

The package can be installed with `pip` or related tools, for example:

```sh

$ pip install textual-countdown

```

## Demo

Once installed, you can try a demo of the library with:

```sh

$ python -m textual_countdown

```

Please see [the main documentation for the

library](https://textual-countdown.davep.dev/) for details on how to use it.

## TODO

See [the TODO tag in

issues](https://github.com/davep/textual-countdown/issues?q=is%3Aissue+is%3Aopen+label%3ATODO)

to see what I'm planning.

[//]: # (README.md ends here)