Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aesophor/py-todo
📋 Lightweight reminder / todo-list in cli
https://github.com/aesophor/py-todo
cli python todo todolist
Last synced: about 2 months ago
JSON representation
📋 Lightweight reminder / todo-list in cli
- Host: GitHub
- URL: https://github.com/aesophor/py-todo
- Owner: aesophor
- License: mit
- Created: 2018-10-21T15:39:02.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-09-25T01:43:33.000Z (over 2 years ago)
- Last Synced: 2023-11-07T20:05:48.235Z (about 1 year ago)
- Topics: cli, python, todo, todolist
- Language: Python
- Homepage: https://www.reddit.com/r/unixporn/comments/9qy35q/oc_pytodo_a_lightweight_reminder_in_cli/
- Size: 149 KB
- Stars: 106
- Watchers: 8
- Forks: 22
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
PY-TODO
## 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.5 (sys, re, pickle, pathlib, datetime)
## Supported Platforms
* Linux
* OSX (tested on 10.14 Mojave)
## Installation
* Debian / Ubuntu / Mint - [Get latest deb](https://github.com/aesophor/py-todo/releases)
```
sudo dpkg -i py-todo_1.3.3-3_all.deb
```
* Arch Linux - [AUR](https://aur.archlinux.org/packages/py-todo) (Maintained by [RewoundVHS](https://github.com/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 # Add an item. (without Title / Expiry Date prompt)
$ todo -e # Edit an item. (with Title / Expiry Date prompt)
$ todo -e # Edit an item. (without Title / Expiry Date prompt)
$ todo -l --list # List all items.
$ todo -m --move # Move an item from index to new index.
$ todo -r # Remove one or more items.
$ todo -s --sort # Sort items by their remaining days
$ todo -h # Display help message.
$ todo -v # Display version info.
$ todo -org # Adds TODOs from Emacs org mode
```
## Configuration (Optional)
The default config location is `~/.config/py-todo/config`
```
[PY-TODO]
color = true / false
detail_mode = true / false
week_start_day = Sun
show_time = true
```
## 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! (In lexicographical order)
* [Arsukeey](https://github.com/Arsukeey) - Added Detail Mode (e.g., Next Wednesday)
* [christophergeiger3](https://github.com/christophergeiger3) - Reformatted code
* [diplozoon](https://github.com/diplozoon) - Reformatted code
* [jcstill](https://github.com/jcstill) - Add support for past due tasks
* [jonaylor89](https://github.com/jonaylor89) - More robust config parsing
* [luvhalvorson](https://github.com/luvhalvorson) - Updated README.md
* [MMarinov97](https://github.com/MMarinov97) - Added compatibility with emacs org file
* [patatman](https://github.com/patatman) - Improved -a --add. Tested py-todo on MacOS
* [RewoundVHS](https://github.com/RewoundVHS) - AUR Package Maintainer, Color Mode
* [Steampunkery](https://github.com/Steampunkery) - Added -e --edit, -m --move, refactoring
## License
Available under the [MIT License](https://github.com/aesophor/py-todo/blob/master/LICENSE)