Metadata-Version: 2.1
Name: pi-clock
Version: 1.0.3
Summary: Set alarms, stopwatches and timers from the terminal.
Home-page: https://github.com/jordanpatterson1939/pi-clock
Author: Jordan Patterson
Author-email: jordanpatterson1939@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3
Description-Content-Type: text/markdown
Requires-Dist: playsound
Requires-Dist: getkey

# pi-clock
Set alarms, create timers or stopwatches right from your terminal.

![Piclock Demo](demo/demo.gif)

## Installation
```bash
pip3 install pi-clock
```

## Usage
**Setting an alarm**
```bash
 piclock -a
```

**Creating a timer**
```bash
piclock -t
```

**Creating a new stopwatch**
```bash
piclock -s
```

**Interactive mode**
```bash
 piclock -i
```

**Command Line Arguments**
```text
usage: piclock [-h] [-i] [-t] [-a] [-s]

optional arguments:
-h, --help          shows this help message and exit
-i, --interactive   Interactive mode
-t, --timer         Set a new timer
-a, --alarm         Set a new alarm
-s. --stopwatch     Start a new stopwatch
```

Todo:
- [ ] Allow alarms to run in the background while in intercative mode.


