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

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 read patterns to exclude from .gitignore file (if present in the scan root)

-t, --tokens [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} - revist 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} - revist 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

Release files for todex 1.1.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.1.0
File	Size	Uploaded
todex-1.1.0.tar.gz	6.3 kB	Sep 20, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for todex 1.1.0
File	Interpreter	ABI	Platform	Reset
todex-1.1.0-py3-none-any.whl 7.8 kB Sep 20, 2026	Python 3	none	any	Details

Total release size: 14.1 kB

Release files / todex-1.1.0.tar.gz

Download URL	todex-1.1.0.tar.gz
Size	6.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`9eb4ed07795fe0baa7828491756bb28bb850037f184cef52f3a9a163240fbd0f`
BLAKE2b-256 checksum How to use checksums	`5a516b25e9553a85749dc01c09b74d36c878f960dcd670e8a3663258a437013d`
Upload date	Sep 20, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`uv/0.7.12`

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

Download URL	todex-1.1.0-py3-none-any.whl
Size	7.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`0d3e505cb2a24be3d607288b5448f645dc9ff0eaabefa0c2c51a73be2c7e4403`
BLAKE2b-256 checksum How to use checksums	`52372eae2dd89f30af5e285df007ef850f30fbfcda3425e72c2b97a727651e2c`
Upload date	Sep 20, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`uv/0.7.12`