Skip to main content

A simple CLI tool for starting a countdown timer.

Project description

Timer-CLI

A very simple Python CLI tool to start a countdown timer.

Example sreenshot

Installation

Easily install timer-cli using pip:

  pip install timer-cli

Usage

$ timer [options] duration

How to specify a duration

Syntax for a duration is __h__m__s where the hour, minute and second values are all optional.

Duration examples

  • 2mins 30secs - 2m30s
  • 10hrs 5secs - 10h5s
  • 1hr 25mins 45secs - 1h25m45s

Options

--no-bell

Supplying the --no-bell flag will stop the terminal from "ringing the bell" (making a sound) once the timer has finished.

-m, --message

Use this flag to specify a message to display under the timer. Make sure to surround your string with quotation marks.

$ timer 1h30m -m "Review the pull requests"

Contributing

Contributions are always welcome!

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  • Fork the Project
  • Create your Feature Branch (git checkout -b feature/AmazingFeature)
  • Commit your Changes (git commit -m 'Add some AmazingFeature')
  • Push to the Branch (git push origin feature/AmazingFeature)
  • Open a Pull Request

License

This code is distributed under the Apache-2.0 license. See LICENSE for more information.


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

timer_cli-0.1.2.tar.gz (7.5 kB view hashes)

Uploaded Source

Built Distribution

timer_cli-0.1.2-py3-none-any.whl (8.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page