Skip to main content

todd

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

Metadata

Release files for todd 0.0.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for todd 0.0.7
File Size Uploaded
todd-0.0.7.tar.gz 20.7 kB Details

Release files / todd-0.0.7.tar.gz

Download URL todd-0.0.7.tar.gz
Size 20.7 kB
Tags Source
SHA-256 checksum
How to use checksums
c8636bc33ad2759807db69b84324ff488bd12a02692237c96c3582ea88a5a016
BLAKE2b-256 checksum
How to use checksums
619bb68ab59c82c9853bf4c2fee491a5d51fcc2a9c6a2c3c421d7d3ff7e57388
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.9.1 pkginfo/1.4.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.19.4 CPython/3.7.2

Release history Release notifications | RSS feed

This release

0.0.7 This release

1 release file

0.0.6

1 release file

0.0.5

1 release file

0.0.4

1 release file

0.0.3

1 release file

0.0.2

1 release file

0.0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page