Overview
A little program to remind you of upcoming events / unfinished tasks.
Put them into ~/.zshrc
or ~/.bashrc
or whatever you want, and it will stop you from
putting off important shit.
Pickled (i.e., serialized) todo list objects are saved in ~/.local/share/py-todo/todo.dat by default.
Dependencies
- python 3.6 (pathlib, pickle)
Supported Platforms
- Linux
- OSX (tested on 10.14 Mojave)
Installation
- Arch Linux - AUR (Submitted by RewoundVHS)
yay -S py-todo
- Manual Installation (Linux)
$ git clone https://github.com/aesophor/py-todo.git
$ cd py-todo && sudo cp todo /usr/bin/todo
- Manual Installation (OSX)
$ git clone https://github.com/aesophor/py-todo.git
$ cd py-todo && cp todo /usr/local/bin/
Usage
$ todo # List all items.
$ todo -a # Add an item. (with Title / Expiry Date prompt)
$ todo -a <title> <expiry_date> # Add an item. (without Title / Expiry Date prompt)
$ todo -e <index> # Edit an item. (with Title / Expiry Date prompt)
$ todo -e <index> <title> <expiry_date> # Edit an item. (without Title / Expiry Date prompt)
$ todo -r <indices> # Remove one or more items.
$ todo -h # Display help message.
$ todo -v # Display version info.
$ todo -org <filename> # Adds TODOs from Emacs org mode
Configuration (Optional)
~/.config/py-todo/config
color = true / false
detail_mode = true / false
week_start_day = Sun / Mon
Detail Mode
Discrete Mathematics Exam (Next Wednesday; 5 days left) # detail_mode = true
Discrete Mathematics Exam (5 days left) # detail_mode = false
Contributors
Special thanks to all the contributors!
- RewoundVHS - AUR Package Maintainer, Color Mode
- Steampunkery - Added -e --edit
- christophergeiger3 - Reformatted code
- patatman - Improved -a --add. Tested py-todo on MacOS
- Arsukeey - Added Detail Mode (e.g., Next Wednesday)
- MMarinov97 - Added compatibility with emacs org file
- diplozoon - Reformatted code
- luvhalvorson - Updated README.md
License
Available under the MIT License