https://github.com/fernando24164/epomodoro

Pomodo CLI
https://github.com/fernando24164/epomodoro

cli pomodoro pomodoro-timer python

Last synced: about 1 month ago
JSON representation

Pomodo CLI

• Host: GitHub
• URL: https://github.com/fernando24164/epomodoro
• Owner: fernando24164
• License: mit
• Created: 2022-12-25T23:15:21.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T13:38:47.000Z (almost 2 years ago)
• Last Synced: 2024-11-11T06:44:47.303Z (about 2 months ago)
• Topics: cli, pomodoro, pomodoro-timer, python
• Language: Python
• Homepage:
• Size: 513 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Easy Pomodoro CLI

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/epomodoro)[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md)



## Table of Contents

- [About](#about)

- [Getting Started](#getting_started)

- [Usage](#usage)

- [Test](#test)

## About 

Small CLI application that implements the Pomodoro routine

## Getting Started 

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 

```

epomodoro start

```

Change default parameters

```

epomodoro start --length 20 --pomodoros 2 --chill 10

```

```

epomodoro start -l 20 -p 2 -c 10

```



You can get the statistics of your pomodoros from last week if there is data

```

epomodoro statistic

```



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 

See Makefile definition

To run test

```

make test

```