https://github.com/imyizhang/pomodoropy

A simple command-line Pomodoro timer
https://github.com/imyizhang/pomodoropy

pomodoro pomodoro-timer terminal-app

Last synced: about 2 months ago
JSON representation

A simple command-line Pomodoro timer

• Host: GitHub
• URL: https://github.com/imyizhang/pomodoropy
• Owner: imyizhang
• License: mit
• Created: 2021-05-25T00:50:12.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-06-25T22:20:22.000Z (over 3 years ago)
• Last Synced: 2024-10-13T13:12:54.220Z (2 months ago)
• Topics: pomodoro, pomodoro-timer, terminal-app
• Language: Python
• Homepage: https://pypi.org/project/PomodoroPy/
• Size: 12.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PomodoroPy

PomodoroPy is

* a simple command-line Pomodoro timer

PomodoroPy supports to

* quickly set up a series of repeatable Pomodoros

* log the historical Pomodoros including corresponding tag, task, time interval, self-rating and comment

* start session with interactive mode, customizing a Pomodoro each round

## Quickstart

```bash

$ pomodoro -h

```

### Requirements

#### Desktop Notification

* Install [`terminal-notifier`](https://github.com/julienXX/terminal-notifier) for macOS, e.g.,

  ```bash

  $ brew install terminal-notifier

  ```

#### Voice Notification

* Choose voice notification sound with macOS built-in `say`

  ```bash

  $ say -v ?

  ```

### Install PomodoroPy

`pip` can handle all other package dependencies.

```bash

$ pip install pomodoropy

```