https://github.com/tassaron/nagcat
Reminders in tmux statusbar. A helpful cat who nags you... because she loves you! =^.^= Install with Tmux Plugin Manager or with Pip
https://github.com/tassaron/nagcat
cat reminders tmux tmux-plugins
Last synced: 3 months ago
JSON representation
Reminders in tmux statusbar. A helpful cat who nags you... because she loves you! =^.^= Install with Tmux Plugin Manager or with Pip
- Host: GitHub
- URL: https://github.com/tassaron/nagcat
- Owner: tassaron
- License: mit
- Created: 2022-05-12T03:37:25.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-03T12:42:48.000Z (about 4 years ago)
- Last Synced: 2025-09-21T02:56:48.746Z (9 months ago)
- Topics: cat, reminders, tmux, tmux-plugins
- Language: Python
- Homepage: https://pypi.org/project/nagcat/
- Size: 80.1 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nagcat
A helpful cat which nags you from the tmux statusbar... because she loves you!
nagcat doesn't actively notify you like an alarm clock. It's a simple command that returns `=^.^=` if you have no reminders, or `=u.u=` if you have overdue reminders.
Use `prefix` + P or `nagcat pet` to calm nagcat and dismiss the current nag (overdue reminder).
For a reminder of what the latest reminder is, use `prefix` + W or say `nagcat why` 🐈
You may use the included `nagcat.tmux` plugin for tmux, or simply use nagcat on its own!
Install with **Tmux Plugin Manager** or using **Pip**. Requires **Python 3.6** or higher.
# Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm)
1. Add to list of TPM plugins:
* `set -g @plugin 'tassaron/nagcat'`
1. Hit `prefix` + I to download the plugin
1. Add to tmux statusbar by editing `.tmux.conf`:
* `set -g status-right '#{nagcat}'`
## Updating with Tmux Plugin Manager
* Use TPM update command: `prefix` + U
## Make an alias to use `nagcat` command
* Add to bottom of `.bashrc`:
```
alias nagcat="python $HOME/.tmux/plugins/nagcat/src/nagcat.py"
```
* Replace `python` with `python3` on some Linux distros (Debian, Ubuntu)
# Installation from PyPI
1. Install using Pip:
* `pip install nagcat`
1. Add to tmux statusbar by editing `.tmux.conf`:
* `set -g status-right '#{nagcat}'`
* `run-shell nagcat.tmux`
## Updating with Pip
* `pip install --upgrade nagcat`
## Which Installation Method to Use?
On most operating systems, installing with Pip will automatically put the `nagcat` command in the $PATH. Other than convenience and personal preference, there is no difference between the installation methods. You can install both ways on the same system, but you will have to update two versions of the program so it's not recommended.
# Editing Reminders:
## ~/.config/nagcat/reminders.json
```
{
"09:00": "Time for breakfast",
"14:00": "You should drink water"
}
```
* Safely edit this JSON file with `nagcat config`
* If `$EDITOR` is not set in your shell, set nagcat's preferred text editor using `nagcat config -e path/to/editor`
* If you edit `reminders.json` manually and make a mistake, nagcat might stop working. Delete the invalid file to fix this.
* nagcat only supports daily reminders and 24-hour time
* The default reminder is "Drink water" at 14:00
* JSON looks like a Python dictionary, but does **not** allow extra commas.
# Customization
## Tmux Hotkeys
* `prefix` + W: Runs `nagcat why` and shows output
* `prefix` + P: Runs `nagcat pet` to dismiss current reminders
* Change hotkeys from default W & P to _e.g.,_ e & r:
```
set -g @nagcat_why e
set -g @nagcat_pet r
```
## Appearance
* Make it _your_ nagcat — see `nagcat config -h` for details
* Change appearance (face/alert), name, pronoun
* *E.g.,* how to remove cat theming: `nagcat config -face '' -alert '!!!'`
## Use in a Graphical Environment
You may also use nagcat in a graphical environment using something like *e.g.* [the Command Output widget for KDE Plasma](https://store.kde.org/p/1166510). To output your reminder text into a graphical pop-up window, try one of these commands:
* `zenity --info --text="$(nagcat why)" --no-markup --no-wrap`
* `kdialog --msgbox "$(nagcat why)"`
# Development
## Reporting bugs
Please include some details when reporting bugs, such as:
* Your OS
* `nagcat --version`
* `bash --version`
* `python --version` (or `python3`)
* `tmux -V`
* If you're using TPM, pip, a venv, some combination of these, etc.
## Running tests
* Clone this repo, create a fresh Python virtual environment and install the package using `pip install .`
* Install pytest using `pip install pytest`
* Run tests using `pytest` command in the repo root directory
* If submitting a pull request, please run the `black` automatic code formatter (`pip install black`)