DTLaudit - User Guide
This guide explains how to use DTLaudit to quickly check the state of one project or a local project suite.
WindowsPythonRead-onlyGoal
DTLaudit provides an overview: which projects are Git repositories, which have README files, which have a GitHub release, which generated folders clutter the repository, and which files appear only in some projects.
Start
Graphical launch
When DTLaudit is launched without arguments, a window lets you choose the folder or project to analyze.
Command-line launch
The command line is useful when repeating the same audit.
python DTLaudit.py --suite "D:\Documents\Mes sites Web\outils"
Audit a Project Suite
- Choose the folder containing the projects.
- Run the audit in suite mode.
- Open the generated HTML report.
- Read the summary table first, then the per-project blocks.
Audit a Single Project
Project mode focuses on one folder. It is useful when a specific repository looks inconsistent or before publication.
python DTLaudit.py --project "D:\Documents\Mes sites Web\outils\GitHubMenu"
Read the Report
Summary table
Shows Git, GitHub, README, release, active branch and local changes for each project.
Observations
Highlights significant differences: large files, generated folders, missing documents or differences between projects.
File matrix
Helps identify files present in only one project or in a subset of projects.
GitHub Metadata
If GitHub CLI (gh) is installed and authenticated, DTLaudit enriches the report with GitHub information: repository visibility, latest release, open issues and pull requests.
If gh is not available, the local audit remains usable.
Practical Tips
- Run DTLaudit before a series of GitHub publications.
- Watch
build,distand Python cache folders. - Regularly compare README files, guides and manuals across projects.
- Use the HTML report as a quick control dashboard.