# Easy Pomodoro CLI
<img src="src/media/images/pomodoro_logo.jpeg" alt="Image of clock by Picasso" width="200"/>
## Table of Contents
- [About](#about)
- [Getting Started](#getting_started)
- [Usage](#usage)
- [Test](#test)
## About <a name = "about"></a>
Small CLI application that implements the Pomodoro routine
## Getting Started <a name = "getting_started"></a>
The default pomodoros are 4 with a time range of 20 minutes each one.
After countdown there will be a chill out time to relax.
To install from PyPI
```
pip install epomodoro
```
To install manually cloning the repository
```
pip install --editable .
```
## Usage <a name = "usage"></a>
```
epomodoro start
```
Change default parameters
```
epomodoro start --length 20 --pomodoros 2 --chill 10
```
```
epomodoro start -l 20 -p 2 -c 10
```
<img src="src/media/images/example.png" alt="Execution example" width="275"/>
You can get the statistics of your pomodoros from last week if there is data
```
epomodoro statistic
```
<img src="src/media/images/example_statistic.png" alt="Execution statistic" width="275"/>
To clean the data store in ` ~/.config/epomodoro`
```
epomodoro clean
```
## Autocomplete for CLI
To add autocomplete in Bash shell
```
_EPOMODORO_COMPLETE=bash_source epomodoro > ~/.epomodoro-complete.bash
. ~/.epomodoro-complete.bash
```
To add autocomplete to CLI when press Tab for ZSH shell
```
_EPOMODORO_COMPLETE=zsh_source epomodoro > ~/.epomodoro-complete.zsh
. ~/.epomodoro-complete.zsh
```
## Test <a name= "test"></a>
See Makefile definition
To run test
```
make test
```
Raw data
{
"_id": null,
"home_page": "https://github.com/fernando24164/epomodoro",
"name": "epomodoro",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "pomodoro",
"author": "Fernando Cillero",
"author_email": "fernando24164@gmail.com",
"download_url": "",
"platform": null,
"description": "# Easy Pomodoro CLI\n\n<img src=\"src/media/images/pomodoro_logo.jpeg\" alt=\"Image of clock by Picasso\" width=\"200\"/>\n\n## Table of Contents\n\n- [About](#about)\n- [Getting Started](#getting_started)\n- [Usage](#usage)\n- [Test](#test)\n\n## About <a name = \"about\"></a>\n\nSmall CLI application that implements the Pomodoro routine\n\n## Getting Started <a name = \"getting_started\"></a>\n\nThe default pomodoros are 4 with a time range of 20 minutes each one.\nAfter countdown there will be a chill out time to relax.\n\nTo install from PyPI\n\n```\npip install epomodoro\n```\n\nTo install manually cloning the repository\n\n```\npip install --editable .\n```\n\n## Usage <a name = \"usage\"></a>\n\n```\nepomodoro start\n```\n\nChange default parameters\n\n```\nepomodoro start --length 20 --pomodoros 2 --chill 10\n```\n\n```\nepomodoro start -l 20 -p 2 -c 10\n```\n\n<img src=\"src/media/images/example.png\" alt=\"Execution example\" width=\"275\"/>\n\nYou can get the statistics of your pomodoros from last week if there is data\n\n```\nepomodoro statistic\n```\n\n<img src=\"src/media/images/example_statistic.png\" alt=\"Execution statistic\" width=\"275\"/>\n\nTo clean the data store in ` ~/.config/epomodoro`\n\n```\nepomodoro clean\n```\n\n## Autocomplete for CLI\n\nTo add autocomplete in Bash shell\n\n```\n_EPOMODORO_COMPLETE=bash_source epomodoro > ~/.epomodoro-complete.bash\n. ~/.epomodoro-complete.bash\n\n```\n\nTo add autocomplete to CLI when press Tab for ZSH shell\n\n```\n_EPOMODORO_COMPLETE=zsh_source epomodoro > ~/.epomodoro-complete.zsh\n. ~/.epomodoro-complete.zsh\n```\n\n## Test <a name= \"test\"></a>\n\nSee Makefile definition\n\nTo run test\n\n```\nmake test\n```\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Another pomodoro timer",
"version": "0.4.0",
"split_keywords": [
"pomodoro"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "53252a893d94f26e0c936ab4723904624615b1eda9fd52b6049f2997935c6b65",
"md5": "9d6318595484248a11a34c35c0319c31",
"sha256": "e3e2c8abd61a51b62ec1e2933f779ae30f3548c8e7ae5aaee9f26860991a249c"
},
"downloads": -1,
"filename": "epomodoro-0.4.0-py3.9.egg",
"has_sig": false,
"md5_digest": "9d6318595484248a11a34c35c0319c31",
"packagetype": "bdist_egg",
"python_version": "0.4.0",
"requires_python": ">=3.7",
"size": 2081,
"upload_time": "2023-01-05T17:13:24",
"upload_time_iso_8601": "2023-01-05T17:13:24.158028Z",
"url": "https://files.pythonhosted.org/packages/53/25/2a893d94f26e0c936ab4723904624615b1eda9fd52b6049f2997935c6b65/epomodoro-0.4.0-py3.9.egg",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-05 17:13:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "fernando24164",
"github_project": "epomodoro",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "epomodoro"
}
JSON
