Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 1.31 KB

README.md

File metadata and controls

59 lines (36 loc) · 1.31 KB

Reminders

Reminds about events stored in YAML that are past date.

I'm writing this because this is an important use case for me (and for everyone else) and I'm tired of dealing with the usual productivity app and yet another UI.

Installation

Via Python

pip install reminders

or

pip install git+https://github.com/danisztls/reminders

NOTE: Preferably use pipx instead of pip.

Arch Linux

Check package on AUR.

Configuration

It expects a configuration file at $XDG_CONFIG_HOME/reminders/config.yaml such as:

paths:
  - "~/reminders.yml"

It supports multiple reminders file with the following structure:

- name: ""
  desc: "Notify when next date is past."
  next: 2024-01-30

- name: "Task B"
  desc: "Notify when last date + frequency relative delta is past."
  last: 2024-01-01
  freq: 1m

freq support these units: d (day), w (week), m (month), y (year).

Usage

Just run:

reminders

It can be run periodically in the background so notifications are sent in due time.

It doesn't write to the configuration file so the user have to manually edit it after the task is done.

Currently it supports one method of notiying which is GNOME libnotify.