Skip to content

FLchs/cursedtodo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CursedTodo

GitHub Actions Workflow Status GitHub Release GitHub License CI PyPI - Downloads

CursedTodo is a minimalist, terminal base todo manager storing tasks as .ics files for storage. It can be used with vdirsyncer for CalDAV synchronization. Efforts are made to support most of RFC-5545 and to be compatible with most other projects. It has been tested with vdirsyncer, Nextcloud Tasks and Tasks.org.

Built in Python using the Curses library Cursedtodo has only one direct dependency: ics.

Demo

demo of cursedtodo

Quick look at Cursedtodo in action.

Roadmap

Short term

  • Basic todo list (ordered by priority, show/hide completed)
  • Todo creation, modification, and deletion
  • Arch aur package
  • Other distributions packages
  • Keymaps customization
  • Category filtering
  • Basic CLI for adding todos

Long term

  • Subtasks and linked todos
  • Search

Will not be implemented

  • Mouse support
  • Windows support (PR accepted)

Usage

pip install cursedtodo

Cursedtodo will generate a config.toml files in $XDG_CONFIG_HOME/cursedtodo/ at first start. Keybinds are based on Vim hjkl for movement.

Here is an example config.toml:

[[calendars]]
name= "Default"
path = "~/.local/share/cursedtodos/calendar/default" # should be something like ~/.local/share/vdirsyncer/calendar/work if you are using vdirsyncer
color = "green"
default = false

# UI configuration
[ui]
window_name = "Todos"
show_footer_keybindings = true
select_first = true
rounded_borders = true
date_format = "%m/%d/%y %H:%M:%S"
category_colors = true
confirm_mark_as_done = true

[keybindings]
# general
up = "k"
down = "j"
new = "n"
delete = "x"
edit = "e"
# todo list
mark_as_done = " "
show_completed = "c"
change_order = "o"

# Columns configuration
[[columns]]
property = "calendar.name"
width = 10

[[columns]]
property = "summary"
width = 30

[[columns]]
property = "priority"
width = 15

[[columns]]
property = "due"
width = 25

[[columns]]
property = "categories"
width = 30

Important

Cursedtodo is still in early development, expect some bugs and possibly breaking changes to the config file. Please backup your data regularly.

Contributing

We welcome contributions! If you find a bug, have a feature request, or want to improve the project, feel free to open an issue or submit a pull request.

For discussions and suggestions, check out the [issues][https://github.com/FLchs/cursedtodo/issues] page.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Alternatives

Projects with similar goals:

  • Todoman - CLI-based todo manager using .ics
  • Calcurse Terminal-based calendar with a simple built-in todo list
  • Calcure A personal calendar and task manager that supports .ics imports (but not currently support write or export)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages