Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mehdidc/pomodoro
simple command line pomodoro app with visualization of statistics
https://github.com/mehdidc/pomodoro
pomodoro pomodoro-clock pomodoro-technique productivity python
Last synced: 3 days ago
JSON representation
simple command line pomodoro app with visualization of statistics
- Host: GitHub
- URL: https://github.com/mehdidc/pomodoro
- Owner: mehdidc
- License: mit
- Created: 2017-05-09T13:57:04.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-01-23T22:13:23.000Z (almost 4 years ago)
- Last Synced: 2024-11-06T18:17:23.098Z (5 days ago)
- Topics: pomodoro, pomodoro-clock, pomodoro-technique, productivity, python
- Language: Python
- Size: 196 KB
- Stars: 558
- Watchers: 12
- Forks: 60
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pomodoro
Simple command line pomodoro app with visualization of statistics.
The Pomodoro technique is a time management technique for improving productivity.
Check
for more details.
The code is based on:
## How to install ?
```bash
pip install pomodoro-cli
```
OR
```bash
git clone https://github.com/mehdidc/pomodoro
cd pomodoro
pip install -r requirements.txt
python setup.py install
```
## How to use it?
```bash
pomodoro 60 5
```
will run pomodoro cycles of 60mins of work and 5mins of rest.
By default an alarm sound will be played at the end of pomodoros.
**Warning** : alarm needs either mpg123 (https://www.mpg123.de/) or
ffplay(https://ffmpeg.org/ffplay.html) to be installed.
it can be disabled using:
```bash
pomodoro 60 5 --alarm=False
```
Instead of an alarm, you might rather want to receive a message box each time you finish a pomodoro.
To do that, you can do:
```bash
pomodoro 60 5 --notif=True --alarm=False
```
**Warning** : notif needs pyqt5 (https://pypi.python.org/pypi/PyQt5/5.8.2)
Enable display of a command line countdown timer as follows:
```bash
pomodoro 60 5 --timer=True
```
## Statistics
each time a pomodoro is performed, its recorded on a small text database in your HOME/.pomodoro. To visualize the statistics of your pomodoros, you can use pomostat. Here are some examples:
```bash
pomostat overall
pomostat week
pomostat thisweek
pomostat lastweek
pomostat week --weekof='2018-01-01'
pomostat stats
pomostat weeks
pomostat today
pomostat yesterday
```
Check ```pomostat --help``` for more information.
Here is an example of graph with ```pomostat thisweek```:
