tomato-clock


Nametomato-clock JSON
Version 0.1.2 PyPI version JSON
download
home_pagehttps://github.com/coolcode/tomato-clock
SummaryTomato Clock is a straightforward command-line Pomodoro application.
upload_time2024-02-04 06:25:48
maintainer
docs_urlNone
authorBruce Lee
requires_python
licenseMIT
keywords pomodoro tomato tomato-timer terminal terminal-app pomodoro-timer
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # 🍅 Tomato Clock

[![Publish to PyPI](https://github.com/coolcode/tomato-clock/actions/workflows/package.yml/badge.svg)](https://github.com/coolcode/tomato-clock/actions/workflows/package.yml)
[![PyPI tomato-clock](https://badge.fury.io/py/tomato-clock.svg)](https://pypi.python.org/pypi/tomato-clock/)

Tomato Clock is a straightforward command-line Pomodoro application.

- [Pomodoro Technique](https://en.wikipedia.org/wiki/Pomodoro_Technique)
- [į•ŠčŒ„å·Ĩä―œæģ•](https://zh.wikipedia.org/zh-cn/%E7%95%AA%E8%8C%84%E5%B7%A5%E4%BD%9C%E6%B3%95)

## Installation

[Install python](https://www.python.org)

- Install via pip:

```sh
pip install tomato-clock
```

- Install via source code:

```sh
git clone https://github.com/coolcode/tomato-clock.git
cd tomato-clock
chmod +x tomato.py 
```

## How to use

- if you install via pip

```sh
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

```sh
./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

```sh
🍅 tomato 25 minutes. Ctrl+C to exit
 🍅🍅---------------------------------------------- [8%] 23:04 ⏰ 
```

## Desktop Notification

- MacOS

```sh
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="300"/>

- Ubuntu

`notify-send`

<img src="https://github.com/coolcode/tomato-clock/blob/master/img/screenshot-ubuntu.png?raw=true" alt="ubuntu-notification" width="300"/>


## Voice Notifications

Tomato Clock uses `say`(text-to-speech) for voice notifications.

- 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)

```sh
sudo apt-get install gnustep-gui-runtime
```

- Windows

Check this one: https://github.com/SeanBracksDev/tomato-clock

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/coolcode/tomato-clock",
    "name": "tomato-clock",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "pomodoro tomato tomato-timer terminal terminal-app pomodoro-timer",
    "author": "Bruce Lee",
    "author_email": "bruce.meerkat@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/60/94/41076144dc1c32c33fab6f01a9a5ddee4d8e6f660ecd9d083c09af445609/tomato-clock-0.1.2.tar.gz",
    "platform": "any",
    "description": "# \ud83c\udf45 Tomato Clock\n\n[![Publish to PyPI](https://github.com/coolcode/tomato-clock/actions/workflows/package.yml/badge.svg)](https://github.com/coolcode/tomato-clock/actions/workflows/package.yml)\n[![PyPI tomato-clock](https://badge.fury.io/py/tomato-clock.svg)](https://pypi.python.org/pypi/tomato-clock/)\n\nTomato Clock is a straightforward command-line Pomodoro application.\n\n- [Pomodoro Technique](https://en.wikipedia.org/wiki/Pomodoro_Technique)\n- [\u756a\u8304\u5de5\u4f5c\u6cd5](https://zh.wikipedia.org/zh-cn/%E7%95%AA%E8%8C%84%E5%B7%A5%E4%BD%9C%E6%B3%95)\n\n## Installation\n\n[Install python](https://www.python.org)\n\n- Install via pip:\n\n```sh\npip install tomato-clock\n```\n\n- Install via source code:\n\n```sh\ngit clone https://github.com/coolcode/tomato-clock.git\ncd tomato-clock\nchmod +x tomato.py \n```\n\n## How to use\n\n- if you install via pip\n\n```sh\ntomato         # start a 25 minutes tomato clock + 5 minutes break\ntomato -t      # start a 25 minutes tomato clock\ntomato -t <n>  # start a <n> minutes tomato clock\ntomato -b      # take a 5 minutes break\ntomato -b <n>  # take a <n> minutes break\ntomato -h      # help\n```\n\n- if you install via source code\n\n```sh\n./tomato.py         # start a 25 minutes tomato clock + 5 minutes break\n./tomato.py -t      # start a 25 minutes tomato clock\n./tomato.py -t <n>  # start a <n> minutes tomato clock\n./tomato.py -b      # take a 5 minutes break\n./tomato.py -b <n>  # take a <n> minutes break\n./tomato.py -h      # help\n```\n\n## Terminal Output\n\n```sh\n\ud83c\udf45 tomato 25 minutes. Ctrl+C to exit\n \ud83c\udf45\ud83c\udf45---------------------------------------------- [8%] 23:04 \u23f0 \n```\n\n## Desktop Notification\n\n- MacOS\n\n```sh\nbrew install terminal-notifier \n```\n\n`terminal-notifier` actually is a cross-platform desktop notifier, please refer to \u279c [terminal-notifier](https://github.com/julienXX/terminal-notifier#download)\n\n<img src=\"https://github.com/coolcode/tomato-clock/blob/master/img/screenshot-macos.png?raw=true\" alt=\"terminal-notifier\" width=\"300\"/>\n\n- Ubuntu\n\n`notify-send`\n\n<img src=\"https://github.com/coolcode/tomato-clock/blob/master/img/screenshot-ubuntu.png?raw=true\" alt=\"ubuntu-notification\" width=\"300\"/>\n\n\n## Voice Notifications\n\nTomato Clock uses `say`(text-to-speech) for voice notifications.\n\n- MacOS\n\nMacOS already has `say`. see [here](https://ss64.com/osx/say.html) or [more detail](https://gist.github.com/mculp/4b95752e25c456d425c6)  \n\n- Ubuntu\n\nSee this link: [say](http://manpages.ubuntu.com/manpages/trusty/man1/say.1.html)\n\n```sh\nsudo apt-get install gnustep-gui-runtime\n```\n\n- Windows\n\nCheck this one: https://github.com/SeanBracksDev/tomato-clock\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Tomato Clock is a straightforward command-line Pomodoro application.",
    "version": "0.1.2",
    "project_urls": {
        "Homepage": "https://github.com/coolcode/tomato-clock"
    },
    "split_keywords": [
        "pomodoro",
        "tomato",
        "tomato-timer",
        "terminal",
        "terminal-app",
        "pomodoro-timer"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bfe5c6294f3ac899c1321ebca3d3872d19b12e5b4c500309231d5fc1841f322c",
                "md5": "e4b5467f353b3df9c6f31abbbdcc60dd",
                "sha256": "7f0bc69459f21a0f57b06fe954a500318b08caed84f86faf69d01af46cdeffd4"
            },
            "downloads": -1,
            "filename": "tomato_clock-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e4b5467f353b3df9c6f31abbbdcc60dd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 4906,
            "upload_time": "2024-02-04T06:25:47",
            "upload_time_iso_8601": "2024-02-04T06:25:47.340490Z",
            "url": "https://files.pythonhosted.org/packages/bf/e5/c6294f3ac899c1321ebca3d3872d19b12e5b4c500309231d5fc1841f322c/tomato_clock-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "609441076144dc1c32c33fab6f01a9a5ddee4d8e6f660ecd9d083c09af445609",
                "md5": "0a740ea69e8598186d14f6bc29a07be0",
                "sha256": "006368375f7fe8610c8305a22eb43d377c828af44e358e590bf5598dc06382ab"
            },
            "downloads": -1,
            "filename": "tomato-clock-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "0a740ea69e8598186d14f6bc29a07be0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4498,
            "upload_time": "2024-02-04T06:25:48",
            "upload_time_iso_8601": "2024-02-04T06:25:48.884239Z",
            "url": "https://files.pythonhosted.org/packages/60/94/41076144dc1c32c33fab6f01a9a5ddee4d8e6f660ecd9d083c09af445609/tomato-clock-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-04 06:25:48",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "coolcode",
    "github_project": "tomato-clock",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "tomato-clock"
}
Bruce Lee
Elapsed time: 0.39663s