Skip to main content

An interactive terminal based todo.txt file editor

Project description

todd is an interactive console TODO-list manager with VI key bindings.

It provides a minimalistic interface with a view on your todo list, following in the spirit of spirit of ranger and mutt.

The file format conforms to todo.txt. This means you have full control over your data and can choose to store it locally or in the cloud (like Dropbox). You can use different applications to access your tasks on your desktop or mobile devices.

Thanks to the creator and contributors of todotxt-machine for providing the basis for this project.

Features

  • View your tasks in a column formatted list with relative due dates
  • Switch context (only view tasks that you can work on)
  • Sort by due date or priority
  • Search/filter
  • Edit in plain text with tab completion or adjust priority and due
  • Due dates can be set with
    • weekday name (mo, tu, …)
    • offset (2d in two days, 3m in three moths, 1y in a year)
    • a fixed date (YYYY-MM-DD)

Installation

Supports Python 3.6 on Linux or macOS.

Using pip

pip3 install todd

(Or pip install todd if Python 3 is the default for your system.)

Manually

Download or clone this repo and run the todd.py script.

git clone https://github.com/laktak/todd
cd todd
pip3 install -r requirements.txt
./todd.py

Command Line Options

todd

Usage:
  todd [--config FILE] [TODOFILE] [DONEFILE]
  todd (-h | --help)
  todd --version
  todd --show-default-bindings

Options:
  -c FILE --config=FILE               Path to your todd configuraton file [default: ~/.toddrc]
  -h --help                           Show this screen.
  --version                           Show version.
  --show-default-bindings             Show default keybindings in config parser format

Config File

You can tell todd to use the same todo.txt file whenever it starts up by adding a file entry to the ~/.toddrc file. If you want to archive done tasks, you can specify a done.txt file using an archive entry. You can also set you preferred colorscheme or even define new themes.

Here is a short example:

[settings]
file = ~/todo.txt
archive = ~/done.txt
enable-word-wrap = True
colorscheme = myawesometheme

Color Schemes

Here is a config file with a complete colorscheme definition:

[settings]
file = ~/todo.txt
colorscheme = myawesometheme

[colorscheme-myawesometheme]
plain=h250
...

You can add colorschemes by adding sections with names that start with colorscheme-. Then under the [settings] section you can say which colorscheme you want to use.

The format for a color definitions is:

name=[foreground],[background]

Foreground and background colors are follow the 256 color formats defined by urwid. You can see all the colors defined here.

Key Bindings

See active key bindings with h or ? in todd.

You can customize any key binding by adding a setting to the [keys] section of your config file ~/.toddrc.

For a list of the default key bindings run:

todd --show-default-bindings

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for todd, version 0.0.7
Filename, size File type Python version Upload date Hashes
Filename, size todd-0.0.7.tar.gz (20.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page