1   Name

todox.py -- extract todo items from source files.

2   Synopsis

todox.py path(s)

Search files in path(s) for todo items. Paths may point to individual files or directories. The latter will be processed recursivly.

3   Description

A small tool to extract todo items from source files. The files are searched for the words TODO, FIXME and XXX followed by a space, tab or colon character. The line from the word onwards will be displayed with filename and line number on stdout.

Some common directory and file names used by version control systems or for backup files are excluded from the search. These names are currently:

4   Requirements

The script requires Python 2.3 or higher.

5   Examples

Search all todo items in a given file:

$ todox.py todox.py
todox.py:3:todo: Add copyright info and write documentation.
todox.py:152:todo: The exclude parameters should be part of the class.
Found 2 item(s).

6   History

0.1.0 : 2006-04-03

Initial release.

7   ToDo

• Add command line options for directories and files to exclude.
• Command line option to add patterns for todo items.
• Display the list graphically and allow the launch of a text editor.
• Select a random item from the list.

8   Bugs

None known yet.

9   Copyright

Copyright 2006 Marc 'BlackJack' Rintsch <marc@rintsch.de>

This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.