Skip to content

Latest commit

 

History

History
executable file
·
124 lines (76 loc) · 4.03 KB

README.md

File metadata and controls

executable file
·
124 lines (76 loc) · 4.03 KB
Raw

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

  1. Add to list of TPM plugins:

    • set -g @plugin 'tassaron/nagcat'

  2. Hit prefix + I to download the plugin

  3. 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

  2. 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. 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)