Skip to content
SigmaVirus24 edited this page May 25, 2012 · 2 revisions

Environment Variables and Configuration Options

Variable Values
TODO_DIR /path/to/dir
TODOTXT_CFG_FILE $TODO_DIR/config
TODO_FILE $TODO_DIR/todo.txt
DONE_FILE $TODO_DIR/done.txt
TMP_FILE $TODO_DIR/file.txt
REPORT_FILE $TODO_DIR/file.txt
TODO_ACTIONS_DIR /path/to/dir
ACTIONS "list,of,addons
TODOTXT_DEFAULT_ACTION command
PLAIN 0, 1, False, True
NO_PRI 0, 1, False, True
PRE_DATE 0, 1, False, True
INVERT 0, 1, False, True
HIDE_PROJ 0, 1, False, True
HIDE_CONT 0, 1, False, True
HIDE_DATE 0, 1, False, True
LEGACY 0, 1, False, True
USE_GIT 0, 1, False, True
PRI_[A-X] colors

Explanations

  • TODO_DIR tells the script where to look the files related to your todo set-up.
  • TODOTXT_CFG_FILE is the location of your configuration file. It defaults to the value above.
  • TODO_FILE is the location of the actual text file holding your precious todos. It defaults to the value above.
  • DONE_FILE is where the script will place items you mark as done. Again, it defaults to the above value
  • TMP_FILE is not used by todo.py but is a hold-over from todo.sh.
  • REPORT_FILE is not yet used by todo.py but we will add that feature if enough anyone requests it.
  • TODO_ACTIONS_DIR is where you can store the addons for both todo.py and todo.sh. This may contain both shell scripts and python modules.
  • ACTIONS this is a listing of actions specifically written for todo.py in python.
  • TODOTXT_DEFAULT_ACTION is the default action of the script. This allows you to just invoke todo.py with no arguments and it will perform the action automattically. This defaults to list.
  • PLAIN will force the script to print without the ANSI color codes if set to True or 1.
  • NO_PRI strips the todos of priority before printing them if set to True or 1.
  • PRE_DATE will force the script to place the creation date at the beginning of a new todo if set to True or 1.
  • INVERT will invert the colors used if set to True or 1.
  • HIDE_PROJ will strip all projects from the todos before printing if set to True or 1.
  • HIDE_CONT will strip all contexts from the todos before printing if set to True or 1.
  • HIDE_DATE will strip all dates from the todos before printing if set to True or 1.
  • LEGACY will sort the todos a second time to display them exactly as todo.sh sorted them (alphabetically after priority) when set to True or 1.
  • USE_GIT will tell the script to use the git bindings provided by GitPython to manage TODO_DIR as a git repository when set to True or 1.
  • PRI_[A-X] lets you set the default coloring for any of the priorities. Those which aren't set, default to nothing.

Colors

  • $BLUE
  • $BROWN
  • $LIGHT_PURPLE
  • $LIGHT_GREY
  • $PURPLE
  • $YELLOW
  • $LIGHT_RED
  • $LIGHT_CYAN
  • $BLACK
  • $LIGHT_GREEN
  • $CYAN
  • $GREEN
  • $LIGHT_BLUE
  • $DARK_GREY
  • $WHITE
  • $RED

Clone this wiki locally