Timmy Agent
|
425a87bcce
|
feat(scripts): add readme_generator — auto-generate README from codebase
Test / pytest (pull_request) Failing after 8s
Adds scripts/readme_generator.py — a tool that scans Python codebases,
extracts module docstrings, entry points (argparse main), and directory
structure to generate a standard README.md with: description, installation,
usage, scripts list.
Acceptance for #97:
- Reads codebase structure (AST-based Python file scanner)
- Generates README sections (Description, Installation, Usage, Scripts, Directory)
- Updates existing README (replaces on run — idempotent)
- 1 per run (single repo per invocation)
Usage:
python3 scripts/readme_generator.py # generate in-place
python3 scripts/readme_generator.py --dry-run # preview stats
python3 scripts/readme_generator.py --dir /path
Closes #97
|
2026-04-26 00:20:11 -04:00 |
|