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 details)

Uploaded Source

Built Distribution

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

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

Uploaded Python 3

File details

Details for the file timer_cli-0.1.2.tar.gz.

File metadata

  • Download URL: timer_cli-0.1.2.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.1 CPython/3.11.2 Linux/5.15.0-1034-azure

File hashes

Hashes for timer_cli-0.1.2.tar.gz
Algorithm Hash digest
SHA256 77362d39586cb70b7ee647ce4b298a5114b3e51ea992a6917f05ad52268d692f
MD5 afe069a72f4d71138c63512788cc0dac
BLAKE2b-256 659888b60183e6cef159b3463d2d290591ff55ef169676bf5c55dc2634929c27

See more details on using hashes here.

File details

Details for the file timer_cli-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: timer_cli-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 8.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.1 CPython/3.11.2 Linux/5.15.0-1034-azure

File hashes

Hashes for timer_cli-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ffe25d7a8301eb0c253eef92b9da5e812b6471bf6ef5c2a1eb46304419df5a0e
MD5 a486f1a1d74c0ff3b68c1290c6fd58f1
BLAKE2b-256 b9c228ebf34baed730752b99a77bcf4921e490fd29de9dc3b6b0a83ae564fcaa

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