Metadata-Version: 2.1
Name: epomodoro
Version: 0.1.0
Summary: Another pomodoro timer
Home-page: https://github.com/fernando24164/epomodoro
Author: Fernando Cillero
Author-email: fernando24164@gmail.com
License: UNKNOWN
Keywords: pomodoro
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# 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 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"/>

## Test <a name= "test"></a>

See Makefile definition

To run test
```
make test
```


