Source

todox.py /

Filename Size Date modified Message
55 B
17.6 KB
673 B
2.1 KB
5.8 KB
=======================
 ToDo Extractor Manual
=======================

:author: Marc 'BlackJack' Rintsch
:contact: marc@rintsch.de
:date: $Date$
:revision: $Rev$
:version: 0.1
:copyright: This document has been placed in the public domain.

.. meta::
   :description: 
   :keywords: 

.. contents::
.. sectnum::

Name
====

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


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.


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:

:directory names: `CVS` and `.svn`
:file names:      `*~`, `*.bak`, `*.bck` and `*.py[co]`


Requirements
============

The script requires Python_ 2.3 or higher.


.. Commandline Options
   ===================
   
   --version             show program's version number and exit
   -h, --help            show this help message and exit


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).


History
=======

0.1.0 : 2006-04-03
  Initial release.


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.


Bugs
====

None known yet.


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.

.. _Python: http://www.python.org/