A helpful cat which nags you from within the tmux statusbar... because she loves you! =^.^=
Project description
nagcat
A helpful cat which nags you from the tmux statusbar... because she loves you! (Cat name and pronoun can be customized.)
nagcat doesn't actively notify you at a specific time. If a reminder is set for 9 in the morning, she might not notice for a while; so it's not an alarm clock! nagcat will put a little =u.u=
in the statusbar sometime after your reminder is set to trigger, as a friendly nag! :)
Use nagcat pet
to dismiss the reminder. For a reminder of what the reminder is, say nagcat why
🐈
Written with pure Python 3.8+ for Linux or WSL, although it probably works anywhere with modern versions of Python, Bash, and tmux. Please submit an issue or pull request if you have any problems or suggestions for improvement.
Quick overview
- By default, nagcat will return
=^.^=
if you have no reminders pending - By default, nagcat will return
=u.u=
if you should drink water, after 14:00, until younagcat pet
her - Reminders are stored in a simple JSON file editable with
nagcat config
- Try
nagcat -h
for a full list of "commands" (nagcat likes to think of them as "suggestions") - Easily customize nagcat's name, pronoun, and appearance -- see
nagcat config -h
- To remove cat theming:
nagcat config -face '' -alert [\!]
Installation
-
pip install nagcat
to get the latest stable version from PyPI -
Use nagcat manually by running
nagcat
from a terminal -
To put nagcat output in tmux statusbar:
- Add
run-shell nagcat.tmux
to the bottom of.tmux.conf
- Add
#{nagcat}
to your tmuxstatus-right
orstatus-left
- Add
Example setup
~/.config/nagcat/reminders.json (safely edit with nagcat config
)
{
"09:00": "Time for breakfast",
"14:00": "You should drink water",
}
nagcat currently only supports 24-hour time and daily reminders.
~/.tmux.conf (nagcat
and nagcat.tmux
must be on $PATH)
set -g status-right '#{nagcat}'
run-shell nagcat.tmux
Updating
-
pip install --upgrade nagcat
should be sufficient! -
If something goes wrong, try a "factory reset":
nagcat config --reset
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file nagcat-1.0.0.tar.gz
.
File metadata
- Download URL: nagcat-1.0.0.tar.gz
- Upload date:
- Size: 8.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.10.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c2f64bfe7373f52f9d52d95130c4bf32a021127c7efff0b9895e3378a392ec3a |
|
MD5 | 971382b0f5de25e6720572f866b23f1d |
|
BLAKE2b-256 | 987863d735068d00ce37c48532ed868e723011d02c5464860233d0f73e9fb641 |
File details
Details for the file nagcat-1.0.0-py3-none-any.whl
.
File metadata
- Download URL: nagcat-1.0.0-py3-none-any.whl
- Upload date:
- Size: 9.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.10.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d60580c4a532c26fd4925a4e3215204a08853df413311a815513f6476a978bf |
|
MD5 | 8d22c2e1a03843b3df9185a920ce8c85 |
|
BLAKE2b-256 | 69a48a3f5526f7640f46eee7ee3a74542fbc28b1620527e636d9add54fefb71c |