Codetidy

Small, focused tools for inspecting and tidying code repositories.

Install

python -m pip install -e .

For development:

python -m pip install -e '.[dev]'

Commands

• check-markdown-links PATH checks internal Markdown links.
• compare-repos SOURCE TARGET classifies matching and differing files.
• find-poor-names PATH reports questionable Python variable names.
• validate-docstrings PATH finds docstrings without a following blank line.
• validate-return-types PATH finds callables missing return annotations.

Run the tests with:

pytest