Metadata-Version: 2.1
Name: tomato-clock
Version: 0.0.10
Summary: Tomato Clock is a simple command line pomodoro app
Home-page: https://github.com/coolcode/tomato-clock
Author: Bruce Lee
Author-email: bruce.meerkat@gmail.com
License: MIT
Description: # 🍅 Tomato Clock
        ![Python package](https://github.com/coolcode/tomato-clock/workflows/Python%20package/badge.svg?branch=master)
        
        
        Tomato Clock is a simple command line pomodoro app.
        
        Pomodoro 番茄工作法 https://en.wikipedia.org/wiki/Pomodoro_Technique
        
        ## Installation
        
        Install python from https://www.python.org/
        
        - Install via pip:
        ```
        $ pip install tomato-clock
        ```
        
        - Install via source code:
        ```
        $ git clone https://github.com/coolcode/tomato-clock.git
        $ cd tomato-clock
        $ chmod +x tomato.py 
        ```
        
        ## How to use
        
        - if you install via pip
        
        ```
        
        $ tomato         # start a 25 minutes tomato clock + 5 minutes break
        $ tomato -t      # start a 25 minutes tomato clock
        $ tomato -t <n>  # start a <n> minutes tomato clock
        $ tomato -b      # take a 5 minutes break
        $ tomato -b <n>  # take a <n> minutes break
        $ tomato -h      # help
        ```
        
        - if you install via source code
        ```
        $ ./tomato.py         # start a 25 minutes tomato clock + 5 minutes break
        $ ./tomato.py -t      # start a 25 minutes tomato clock
        $ ./tomato.py -t <n>  # start a <n> minutes tomato clock
        $ ./tomato.py -b      # take a 5 minutes break
        $ ./tomato.py -b <n>  # take a <n> minutes break
        $ ./tomato.py -h      # help
        ```
        
        ## Terminal Output
        ```
        🍅 tomato 25 minutes. Ctrl+C to exit
         🍅🍅---------------------------------------------- [8%] 23:4 ⏰ 
        ```
        
        ## Desktop Notification
        
        - MacOS
        
        ```
        $ brew install terminal-notifier 
        ```
        
        `terminal-notifier` actually is a cross-platform desktop notifier, please refer to ➜ [terminal-notifier](https://github.com/julienXX/terminal-notifier#download)
        
        <img src="https://github.com/coolcode/tomato-clock/blob/master/img/screenshot-macos.png?raw=true" alt="terminal-notifier" width="200"/>
        
        - Ubuntu
        
        `notify-send`
        
        <img src="https://github.com/coolcode/tomato-clock/blob/master/img/screenshot-ubuntu.png?raw=true" alt="ubuntu-notification" width="200"/>
        
        
        
        ## Voice Notification
        We use `say`(text-to-speech) for voice notification 
        
        - MacOS
        
        MacOS already has `say`. see [here](https://ss64.com/osx/say.html) or [more detail](https://gist.github.com/mculp/4b95752e25c456d425c6)  
        
        - Ubuntu
        
        see this link: [say](http://manpages.ubuntu.com/manpages/trusty/man1/say.1.html)
        ```
        sudo apt-get install gnustep-gui-runtime
        ```
        
        
        ## Package & Publish
        ```
        pip install setuptools wheel twine
        rm -rf dist && python setup.py sdist bdist_wheel
        twine upload dist/*
        ```
        
        
Keywords: pomodoro tomato tomato-timer terminal terminal-app pomodoro-timer
Platform: any
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development
Classifier: Topic :: Scientific/Engineering
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Description-Content-Type: text/markdown
