Repository files navigation

A powerful yet easy-to-use todo TUI

• Simple, intuitive interface
• Mouse support: click & scroll
• Easy task search
• Customizable: theme, sorting, and more
• Common Keyboard shortcuts support for editing
• Vim-like commands available for convenience

• Install:pip install todoism
• Run:todoism ortodo
• Update:pip install todoism --upgrade
• Use: Invoke help message using command:help to see commonly used operations and commands

When you first start todoism, you'll be prompted to record key combinations for text navigation.

• CTRL + LEFT: Move cursor one word left when editing text
• CTRL + RIGHT: Move cursor one word right when editing text
• CTRL + SHIFT + LEFT: Select text from cursor position to one word left
• CTRL + SHIFT + RIGHT: Select text from cursor position to one word right
• ALT + LEFT:
  • Move cursor to the beginning of the text
  • Jump to top task/category
• ALT + RIGHT:
  • Move cursor to the end of the text
  • Jump to bottom task/category

• Run with docker in dev mode with test files (run inproject root):

  1. Build docker image:docker build -t ubuntu-todoism .
  2. Run./test/todocker.sh
  • Add--profile to enable profiling

• Or runpython -m todoism --dev directly (for using debugger)

  • Add--profile to enable profiling

Flag--dev and--profile are not available in PyPI installation

• Automated integration test (Experimental):

  1. Installwmctrl with your package manager (for auto window focus)
  2. Runpython test/integration.py inproject root
  • Add--profile to enable profiling
  3. Read the instructions printed in the terminal carefully

• Normal Configuration and data files are located in~/.todoism/. Test ones are intest/.todoism

Issues and PRs are welcome! Todoism is built from scratch with curses library. Please refer to the cursesdocs andhow-to to get started.