Metadata-Version: 2.1
Name: timer-cli
Version: 0.1.2
Summary: A simple CLI tool for starting a countdown timer.
Home-page: https://github.com/1Blademaster/timer-cli
License: Apache-2.0
Author: Kush Makkapati
Author-email: kush.makkapati@icloud.com
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: art (>=5.9,<6.0)
Requires-Dist: click (>=8.1.3,<9.0.0)
Requires-Dist: rich (>=13.3.2,<14.0.0)
Project-URL: Repository, https://github.com/1Blademaster/timer-cli
Description-Content-Type: text/markdown

# Timer-CLI

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

![Example sreenshot](https://raw.githubusercontent.com/1Blademaster/timer-cli/main/images/screenshot.png)

## Installation

Easily install timer-cli using pip:

```bash
  pip install timer-cli
```

## Usage

```bash
$ 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.

```bash
$ 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](https://choosealicense.com/licenses/apache-2.0/) license. See `LICENSE` for more information.

```

```

