Metadata-Version: 2.1
Name: stimer
Version: 0.2.1
Summary: stimer stands for "simpletimer" and is a command line timer that features short "fuzzy" syntax and basic output.
Home-page: https://github.com/deynh/stimer
Author: Nicholas DeYarman
Author-email: ndeyarman@tutanota.com
License: UNKNOWN
Description: # stimer
        stimer stands for "simpletimer" and is a command line timer that features short "fuzzy" syntax and basic output.  
        ![](https://i.ibb.co/Bgr7hkD/stimer.gif)
        ## Features:
        * Two "loosely-parsed" formats for specifying timer duration:
        	* "hms" format: #h#m#s
        	* "clock" format: ##:##:##  
        	See [duration examples](#duration-examples)
        * "DOWN" (timer) mode and "UP" (stopwatch) mode
        * Alert sound (system sound) for timer end with option to disable
        * Progress bar output with option to disable
        * Decimal precision output determined by timer duration with the option to override
        * Save and load timers
        ## Installation:
        `pip install stimer`
        
        A config file is created at `$HOME/.config/stimer/stimer.conf`
        ## Usage:
        `stimer --help`:
        ```
        	usage: stimer [OPTIONS]... DURATION
        
        	positional arguments:
        	  DURATION                Duration of timer in "hms" format or "clock" format.
        	                              hms format -> #h#m#s
        	                              clock format -> ##:##:##
        	                          See "--help-duration"
        
        	optional arguments:
        	  -h, --help              show this help message and exit
        	  -u, --up                count up (stopwatch mode), duration not required
        	  -U, --down              count down (timer mode), default; useful to override saved timers
        	  -a, --no-sound          no alert sound
        	  -A, --sound             alert sound, default; useful to override saved timers
        	  -o, --simple            simple output with no progress bar
        	  -O, --full              full output, default; useful to override saved timers
        	  -p N, --precision N     N {0, 1, 2...} decimal precision; default dependent on DURATION
        	  -s, --save              save timer
        	  -S, --save-only         save timer and do not run
        	  -r NAME, --remove NAME  remove saved timer
        	  -l, --list              list saved timers
        	  -n NAME, --name NAME    name timer when saving
        	  -t NAME, --timer NAME   run timer
        	  --version               output version information and exit
        ```
        ### Duration examples:
        `stimer 20`  
        starts a timer for 20 seconds
        
        `stimer 4h3s`  
        4 hours and 3 seconds
        
        `stimer 1.5h`  
        1 hour and 30 minutes
        
        `stimer 3h105.4m8s`  
        4 hours 45 minutes and 32 seconds
        
        `stimer 04:03`  
        4 minutes and 3 seconds
        
        `stimer 4:3`  
        4 minutes and 3 seconds
        
        `stimer 5:00:6.5`  
        5 hours and 6.5 seconds
        
        `stimer 5::6.5`  
        5 hours and 6.5 seconds
        
        `stimer 5.5::`  
        5 hours and 30 minutes
        
        `stimer :45:`  
        45 minutes
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
