A command line script for periodic reminders of events via email
Table of Contents
When it could be useful:
- It could be useful to periodically check in, on your progress on something
- For tracking weekly or monthly goals.
- Or just as reminder for certain events on particular date or periodically(like someone's birthday)
To set up the project follow these steps.
-
Set environment variables:
- EMAIL (of Gmail account)
- PASSWORD
-
This gmail account email and password are used for sending email.
-
Clone the repo
git clone https://github.com/yashrathi-git/evem
-
Navigate into the project directory
-
Install package
pip install --editable .
-
Now
evem
will be accessible from anywhere, in file system. -
Run this command to initialize it:
evem init
-
For sending emails on particular date, it have to be run on startup. I think everyone starts their computer or laptop atleast once everyday. So when it starts Evem will check for if it needs to send any mail(reminders) and if yes send it in background and terminate.
-
Add the following command to run on startup:
evem remind
- First run
For
evem event new
remind-on
it excepts input in certian syntax:Example:period = (year,month,day), repeat = (*|int)
period = (0,1,0), repeat = 10 # means to remind every month for 10 times period = (0,0,14), repeat = * # means to remind every 14 days (forever) period = (1,0,0), repeat = 1 # means remind after 1 year (1 time only)
- Now it will create a
description.md
file inmarkdown
folder. It will print the file path. Add description to this file(supports markdown, syntax highlighting, table etc.) and save it. - Now run to add the new event:
evem event new --commit
This will check if any reminders needs to be sent today and send it via email if needed.
evem remind
evem event list #List all events with ID for event
evem event list --oneline
evem request <id> # Send mail for particular ID.
evem delete <id> # Delete event based on provided ID
evem edit <id> --markdown # Edit markdown from event of that ID
evem edit <id> --title "New Title!"
evem edit --help # For full list of available options
Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch
- Commit your Changes
- Push to the Branch
- Open a Pull Request
Distributed under the Unlicense License. See LICENSE
for more information.