daterem

Helps you keep track your plans and reminds you your daily things.

Table of Contents

• General Information
• Features
• Setup
• Usage
• Project Status
• Upcoming changes
• Contact
• License

General Information

This windows terminal app was made to help you with keeping track of your plans and remaind you about anything. Just with using a few commands you can create and manage reminders that will help you memorise anything you want so that you won't need to worry about missing out on your plans. You can create reminders that pop up once in the specified day or ones that will remind you a week and two days before. Reminders can also be annulal or set with specified year.

Why creating such project?
I undertook this project mainly to inprove my coding skills, learn something new and of course have some fun while coding!

Features

• Reminds you anything
• Easy to use

Setup

You can install daterem by downloading the package and adding it to your Path.

Usage

Creating new remineder

After you have installed the program you can create your first reminder by using:

daterem --new 01.01 "some awesome title" "some awesome description"

The command above creates new annual reminder for specified date, what is important both title (max 20 characters) and description need to be specified. In case you want to create one time reminder you just specify the year e.g. 01.01.2022.

To create weekly reminder set number [0 - 6] according to day counting from Sunday:

daterem --new 0 "some awesome title" "some awesome description"

To create everyday reminder just don't set the date:

daterem --new "some awesome title" "some awesome description"

View existing reminders

Now when you have your first reminder created you can see it by using --list option.

daterem --list

No.   Date           Title                    Description

1     01.01          some awesome title       some awesome description
2     01.01.2022     some awesome title       some awesome description
3     Sunday         some awesome title       some awesome description
4     Everyday       some awesome title       some awesome description

Check reminders for today

To see reminedrs scheduled for today just use daterem or:

daterem --check

[01.01.2022]

some awesome title       some awesome description
some awesome title       some awesome description
some awesome title       some awesome description
some awesome title       some awesome description

Deleting reminders

You can delete specified reminder by using:

daterem --delete 1

This commad deleted reminder that has number 1, now when you list all reminders you can see that the first one was deleted.

$ daterem --list
No.   Date           Title                    Description

1     01.01.2022     some awesome title       some awesome description
2     Sunday         some awesome title       some awesome description
3     Everyday       some awesome title       some awesome description

Outdated reminders

Outdated reminders aren't deleted automaticly so you have to do it yourself, esspecially when you have many reminders scheduled it can get quite messy and difficult to manage your reminders. Deleting every outdated reminder individually would be really problematic. So to remove all outdated reminders use:

daterem --delete-outdated

01.01.2022 - some awesome title - some awesome description
Deleted: 1 reminders

Of course this option applies to one time reminders only.

Additional reminders

You can create reminders that will additionally remind you week and two days before specifed date, when listing * indicates whether additional reminding is on. To create such reminder use -b option:

daterem -b --new 01.01 "some awesome title" "some awesome description"

$ daterem --list
No.   Date           Title                    Description

1     *01.01         some awesome title       some awesome description
2     Sunday         some awesome title       some awesome description
3     Everyday       some awesome title       some awesome description

Additional reminding can be added or deleted for existing reminders, just specify the number of the reminder:

daterem -b 1

Converting reminders

Some day you might want to change one time reminder to an annual reminder, then you can use -e option:

daterem -e 1

This option can also be used with --new, when used this way it forces the reminder to be annual:

daterem -e --new 01.01.2022 "some awesome title" "some awesome description"

Despite the year specified created reminder is annual. You can see it after using --list option.

$ daterem --list
No.   Date           Title                    Description

1     *01.01         some awesome title       some awesome description
2     01.01          some awesome title       some awesome description
3     Sunday         some awesome title       some awesome description
4     Everyday       some awesome title       some awesome description 

Project Status

Project is still in progress, I am adding new features frequently, if you have any propositions for new features or you found a bug you can contact me here.

Upcoming changes

Things that need improvement:

• -e option handling

Upcoming features:

• Reminding on startup
• Deleting multiple reminders

Contact

Created by @pawelrapacz

License

This project is open source and available under the GNU GPL License.