Skip to content

Releases: san-ghun/ywfm

v1.4.2

16 Dec 14:53
Compare
Choose a tag to compare

New Features

  • Visual feedback: Add a progress bar option to show the progress of the reminder.
  • User input on installation: Ask the user for permission to install dependencies.

1.0.0 initial release

10 Dec 21:30
Compare
Choose a tag to compare

1.0.0 initial release

"Do something today that your future self will thank you for."

A simple Python3-based reminder tool for macOS and Linux that uses native notification systems to alert the user after a specified time. It also supports opening URLs and executing commands when the timer ends.

Features

  • Cross-platform: Works on macOS (using terminal-notifier) and Linux (using notify-send).
  • Customizable notifications: Add a title, subtitle, URL to open, and a command to execute.
  • Timer support: Specify the delay using a human-readable format like 1h10m15s.
  • Background execution: Option to run the reminder as a background process.

Usage

ywfm --title <string> --subtitle <string> --open <URL> --command <string> --timer <string> [--background]

Options

Option Description
--title Required: Title for the reminder notification.
--subtitle Optional: Subtitle for the notification.
--open Optional: URL to open when the notification is triggered.
--command Optional: Command to execute after the timer ends.
--timer Optional: Timer duration, default 15m (e.g., 1h10m15s, 10s).
--background Optional: Run the reminder as a background process.

How It Works

  1. Timer: The program calculates the delay based on the provided timer option and runs until triggered.
  2. Notifications:
    • macOS: Uses terminal-notifier to display notifications and open URLs.
    • Linux: Uses notify-send to display notifications and xdg-open to open URLs.
  3. Custom Commands: Executes shell commands as specified in the --command option.

License

This project is licensed under the MIT License.

Author

Sanghun Park