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

-c, --concise display only token messages e.g. '#TODO{5}: 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 the path

-s, --stdout output result to stdout

--tee output result to stdout and save to file

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

Usage of LLMs

Todex's application code is written by hand. LLMs are used to maintain the test suite and optimize certain parts of the code base.

Metadata

Release files for todex 2.0.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 2.0.0
File	Size	Uploaded	Provenance
todex-2.0.0.tar.gz	7.3 kB	Oct 18, 2026	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for todex 2.0.0
File	Interpreter	ABI	Platform	Reset
todex-2.0.0-py3-none-any.whl 9.0 kB Oct 18, 2026 Without provenance	Python 3	none	any	Details

Total release size: 16.3 kB

Release files / todex-2.0.0.tar.gz

Download URL	todex-2.0.0.tar.gz
Size	7.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`3ec9c35cb66dbd729dde8f597ba2157364228990c29fe7ef25d60df9059a6e52`
BLAKE2b-256 checksum How to use checksums	`46684ca10be2e15591832a4d60563438bca826431eb80ed9a7429d263f1ef555`
Upload date	Oct 18, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`uv/0.7.12`

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

Download URL	todex-2.0.0-py3-none-any.whl
Size	9.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`8124a6c1e5d75f2447ebcdc6c0a59ae18c0f4de5b62990aa6c45ac7b260dabaf`
BLAKE2b-256 checksum How to use checksums	`efe680dd4d887fb76843a92b15d43bb490849ac4bc2879a1e5cd41937bd9372e`
Upload date	Oct 18, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`uv/0.7.12`

Security for todex 2.0.0

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.