todex
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.
|
||||||||||||
-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 ...] |
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 |
1 maintainer
Metadata
1 maintainer
Release files for todex 1.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| todex-1.1.4.tar.gz | 6.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| todex-1.1.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 14.1 kB
Release files / todex-1.1.4.tar.gz
| Download URL | todex-1.1.4.tar.gz |
|---|---|
| Size | 6.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0e81deb723ce6ee5f3c21b0950b59323484ff44dc85f410feb019d671fc538bd
|
|
BLAKE2b-256 checksum How to use checksums |
f455b3d52062b78c807d27f8611621201f6d9abd756c0266141a42104216fb5f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.7.12
|
Release files / todex-1.1.4-py3-none-any.whl
| Download URL | todex-1.1.4-py3-none-any.whl |
|---|---|
| Size | 7.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
80e35e04ab0392aab5df3a9446127ab8ebc82c8065c300e959bc09738a1dc934
|
|
BLAKE2b-256 checksum How to use checksums |
4789ec24195f4a0deb9beb5bf6ff900661e0358e2e834b0456e88dc820f61b42
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.7.12
|
