/countdown-cli

Full-screen countdown timer, centered in the terminal window

Primary LanguagePythonMIT LicenseMIT

countdown-cli

PyPI Status Python Version License

Read the documentation at https://countdown-cli.readthedocs.io/ Tests Codecov

pre-commit Black

This project is based on a Python Morsels exercise for a command-line countdown timer. If you're working on that exercise right now, please don't look at the source code for this. 😉

an adorable snake taking a bite out of a cookie with the words Python Morsels next to it (Python Morsels logo)

Features

  • Full-screen countdown timer, centered in the terminal window
  • Command-line interface for Linux/Mac/Windows

32:53 shown in large letters in center of an xterm window (black background with white text)

14:57 shown in large letters in center of terminal window (light background with darker text)

Requirements

  • Python 3.7+

Installation

You can install countdown-cli via pip from PyPI:

$ python3 -m pip install countdown-cli

Usage

Please see the Command-line Reference for details.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, countdown-cli is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from @cjolowicz's Hypermodern Python Cookiecutter template.