todex

Python 3.X

Peak mud digger and TODO extractor

pipx install todex

todex <PATH> [OPTIONS...]

You can also invoke todex using the shorter alias tdx.

Which What

PATH path to file or dir to process

-h, --help show this help message and exit

-x, --exclude PATTERN [PATTERN ...]

git-like patterns to skip (paths, names, or globs together with default .* / __), e.g.

bar.py any file named bar.py
/bar.py only top-level
foo/bar.py path under the scan root
vendor/ directory and its contents
**/.pyc nested matches
!fizz.md re-include after a broader exclude

-H, --include-hidden do not apply default excludes for hidden names (.* / __*)

-g, --use-gitignore use exclude patterns from .gitignore (if present in scan root) when traversing dirs

-t, --tokens TOKEN [TOKEN ...] list of tokens to search for (together with default TODO, FIXME)
e.g. WARN, REVISIT.
If the token is followed by {lines-count} e.g. #FIXME{3}
the extractor will include multiline snippet with the length specified between the curly braces:

#FIXME{3} - revisit after release
if self.foo == "bar":
return f"fizz{buzz}"

-i, --ignore-default use only -t tokens (skip default TODO, FIXME)

-f, --full-path display absolute dir/file path

-s, --short display only token messages e.g. '#FIXME{3} - revisit after release' - ignore longer snippets

-r, --recursive traverse given dir path recursively

-m, --max-depth N maximum depth of dir traversal - used with -r/--recursive flag

-d, --debug enable debug mode

-o, --out OUT path to output file, if existing dir is passed instead - TODO out file will be saved inside

-v, --version show program's version number and exit

Metadata

Release files for todex 1.2.0

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

Source distribution (sdist)

Source distribution for todex 1.2.0
File	Size	Uploaded
todex-1.2.0.tar.gz	6.7 kB	Oct 13, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for todex 1.2.0
File	Interpreter	ABI	Platform	Reset
todex-1.2.0-py3-none-any.whl 8.3 kB Oct 13, 2026	Python 3	none	any	Details

Total release size: 15.0 kB

Release files / todex-1.2.0.tar.gz

Download URL	todex-1.2.0.tar.gz
Size	6.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`9d20dee336600584145d7ceffe1667d819555f6bb8fa0354a4bd56a3e00dc5c9`
BLAKE2b-256 checksum How to use checksums	`c8e375bfbcd472e423a42cd58c0a6797e026f2d94723d07fce708c26a3aeebe4`
Upload date	Oct 13, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`uv/0.7.12`

Release files / todex-1.2.0-py3-none-any.whl

Download URL	todex-1.2.0-py3-none-any.whl
Size	8.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`3ecf8f69996990c6959bb8db7128368f3bb9972f39f1ed664b1a8c5be7c18125`
BLAKE2b-256 checksum How to use checksums	`1cab33cc5852da5ad30f5338c2a86cf05efbf2ab78737f9cc3c5b9cf19ba1c08`
Upload date	Oct 13, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`uv/0.7.12`