todotxt-machine 1.0.1

An interactive terminal based todo.txt file editor with an interface similar to mutt

todotxt-machine
===============

todotxt-machine is an interactive terminal based todo.txt file editor
with an interface similar to `mutt <http://www.mutt.org/>`__.

Screenshots
-----------

View your todos in a list with helpful syntax highlighting:

|screenshot1.png|

Sort in ascending or descending order, or keep things unsorted:

|screenshot3.png|

Filter contexts and projects:

|screenshot2.png|

And some quotes for when you have nothing left to do:

|screenshot\_quote1.png|

|screenshot\_quote2.png|

Requirements
------------

Python 2.7.5 or Python 3.3.2 with readline support. todotxt-machine
outputs raw `terminal control
sequences <http://invisible-island.net/xterm/ctlseqs/ctlseqs.html>`__ to
draw it's interface and does not rely on modules like
`curses <http://docs.python.org/3.3/library/curses.html>`__ or
`urwid <http://excess.org/urwid/>`__.

Command Line Options
--------------------

::

usage: todotxt-machine.py [-h] [-f FILE] [--readline-editing-mode {emacs,vi}]

Interactive terminal interface for todo.txt files.

optional arguments:
-h, --help show this help message and exit
-f FILE, --file FILE path to your todo.txt file
default:~/Dropbox/todo/todo.txt
--readline-editing-mode {emacs,vi}
set readline editing-mode

Key Bindings
------------

General
~~~~~~~

::

? - display this help message
q, ctrl-c - quit

Movement
~~~~~~~~

::

j, down - move selection down
k, up - move selection up
g, page up - move selection to the top item
G, page down - move selection to the bottom item

Filtering & Sorting
~~~~~~~~~~~~~~~~~~~

::

p - select the next project
P - select the previous project
c - select the next context
C - select the previous context
s - switch sorting method

Manipulating Todo Items
~~~~~~~~~~~~~~~~~~~~~~~

::

x - complete / un-complete selected todo item
n - add a new todo to the end of the list
o - add a todo after the selected todo
O - add a todo before the selected todo
enter, A, e - edit the selected todo
D - delete the selected todo

While Editing a Todo
~~~~~~~~~~~~~~~~~~~~

::

ctrl-c - cancel editing a todo
tab - tab complete @contexts and +Projects

.. |screenshot1.png| image:: https://raw.github.com/AnthonyDiGirolamo/todotxt-machine/master/screenshots/screenshot1.png
:target: https://raw.github.com/AnthonyDiGirolamo/todotxt-machine/master/screenshots/screenshot1.png
.. |screenshot3.png| image:: https://raw.github.com/AnthonyDiGirolamo/todotxt-machine/master/screenshots/screenshot3.png
:target: https://raw.github.com/AnthonyDiGirolamo/todotxt-machine/master/screenshots/screenshot3.png
.. |screenshot2.png| image:: https://raw.github.com/AnthonyDiGirolamo/todotxt-machine/master/screenshots/screenshot2.png
:target: https://raw.github.com/AnthonyDiGirolamo/todotxt-machine/master/screenshots/screenshot2.png
.. |screenshot\_quote1.png| image:: https://raw.github.com/AnthonyDiGirolamo/todotxt-machine/master/screenshots/screenshot_quote1.png
:target: https://raw.github.com/AnthonyDiGirolamo/todotxt-machine/master/screenshots/screenshot_quote1.png
.. |screenshot\_quote2.png| image:: https://raw.github.com/AnthonyDiGirolamo/todotxt-machine/master/screenshots/screenshot_quote2.png
:target: https://raw.github.com/AnthonyDiGirolamo/todotxt-machine/master/screenshots/screenshot_quote2.png