pomodoroprompt/README.md

64 lines
1.6 KiB
Markdown

# Pomodoro Prompt
"What'd you do?" and "What're you gonna do?" dialog prompts that both pre-fill with whatever you put in for the last of either prompt at the end and start of every pomodoro work session, respectively.
## Requirements
* Python 3
* [pip](https://packaging.python.org/guides/installing-using-linux-tools/) for Python3
NOTE: Instructions are written with the assumption that the command `python` points to the python3 interpreter. If `python --version` reports a 2.x version, you should substitute `python3` in the commands using `python` below.
## Installation
```
mkdir -p ~/Projects/agaric/python
git clone git@gitlab.com:agaric/python/pomodoroprompt.git
cd pomodoroprompt
python -m pip install --user -r requirements.txt
```
## Usage
```
cd ~/Projects/agaric/pomodoroprompt/
python pomodoroprompt.py
```
See the `logs/` folder for daily, one-pomodoro-at-a-time time logs.
### For more convenient command prompt:
Create file ``~/.local/bin/pomodoroprompt` with contents:
```bash
#!/bin/bash
# Helper to call our pomodoro script. We actually skip the & so we can end it
# with ctrl+c
python ~/Projects/agaric/python/pomodoroprompt/pomodoroprompt.py
```
Now you can start it with `pomodoroprompt` on the command line from any directory.
## Desired improvements
Too many to write down. Suggest your own:
https://gitlab.com/agaric/pomodoroprompt/-/issues
## Troubleshooting
If you run `python pomodoroprompt.py` and get:
```
File "pomodoroprompt.py", line 85
print('\r', str_minutes(to_go), sep='', end='')
^
SyntaxError: invalid syntax
```
You need to specify Python 3: `python3 pomodoroprompt.py`