Usage

CLI

filename-ingest

Removes a plaintext value from all file names in a directory.

usage: python -m filename_ingest [-h] [--dry-run] directory plaintext

positional arguments:
  directory    Directory to process
  plaintext    Text to remove from file names (case-insensitive, surrounding separators removed)

options:
  --dry-run    Preview changes without renaming
  -h, --help   Show this help message and exit

Example

python -m filename_ingest ./reports draft --dry-run

filename-ingest-archive

Packages renamed files and test artifacts into a timestamped zip.

usage: filename-ingest-archive [-h] [--output-dir OUTPUT_DIR] directory

positional arguments:
  directory              Directory of renamed files to include

options:
  --output-dir PATH      Where to write the zip (default: current directory)
  -h, --help             Show this help message and exit

Example

filename-ingest-archive ./reports --output-dir ./archives

Environment Variables

Variable	Default	Description
TMP_FILES_DIR	tmp-test-files	Directory of test files used during pytest
VERSION	(fetched from GitHub API)	Version string stamped into test artifacts
GH_PAT	(none)	GitHub personal access token for cloning private test file repo
CI	(none)	Set by CI environments; disables local archive generation in pytest