Quality Artifacts¶
What are these files?
Reports that guard broader code quality: dependencies, docstring coverage, licensing, and dead code.
- deptry: unused / missing / transitive imports
- interrogate: docstring coverage (full table + offenders)
- REUSE: license & SPDX compliance
- vulture: likely dead code
Files & what they’re for
-
deptry.log — Dependency hygiene (unused/missing/transitive).
- Good: No missing deps; minimal unused/transitive. — missing: 0, unused: 0, transitive: 0
- How to use: Remove unused deps; add direct deps for imported transitive modules.
-
interrogate.full.txt — Docstring coverage summary.
- Good: ≥ target coverage; PASSED. — coverage ~100.0%
- How to use: Add concise docstrings where missing; enforce threshold in CI.
-
interrogate.offenders.txt — Files/symbols missing required docstrings.
- Good: Empty or tiny list. — offenders: 1
- How to use: Open listed files and add minimal docstrings.
-
reuse.log — REUSE compliance (license metadata).
- Good: Compliant with 0 errors. — compliant
- How to use: Ensure SPDX headers/REUSE metadata per file; add/maintain
REUSE.toml
.
-
vulture.log — Dead-code finder.
- Good: No actionable dead code. — suspected items: 0
- How to use: Delete true dead code; whitelist false positives.
-
_passed — Suite sentinel.
- Good: Present with OK marker. — OK
- How to use: All checks green.
deptry.log¶
About this report & how to act on it
What it is: Dependency hygiene (unused/missing/transitive). What good looks like: No missing deps; minimal unused/transitive.
interrogate.full.txt¶
About this report & how to act on it
What it is: Docstring coverage summary. What good looks like: ≥ target coverage; PASSED.
interrogate.offenders.txt¶
About this report & how to act on it
What it is: Files/symbols missing required docstrings. What good looks like: Empty or tiny list.
reuse.log¶
About this report & how to act on it
What it is: REUSE compliance (license metadata). What good looks like: Compliant with 0 errors.
vulture.log¶
About this report & how to act on it
What it is: Dead-code finder. What good looks like: No actionable dead code.
_passed¶
About this report & how to act on it
What it is: Suite sentinel. What good looks like: Present with OK marker.