Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/1Blademaster/timer-cli
https://github.com/1Blademaster/timer-cli
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/1Blademaster/timer-cli
- Owner: 1Blademaster
- License: apache-2.0
- Created: 2023-03-24T19:36:59.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-21T15:33:10.000Z (10 months ago)
- Last Synced: 2024-03-26T21:48:04.582Z (3 months ago)
- Language: Python
- Size: 679 KB
- Stars: 18
- Watchers: 3
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- cli-apps - Timer-CLI - A very simple countdown timer. (<a name="time-tracker"></a>Time trackers)
- awesome-cli-apps - Timer-CLI - A very simple countdown timer. (<a name="time-tracker"></a>Time trackers)
README
# Timer-CLI
A very simple Python CLI tool to start a countdown timer.
## 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.
```
```