Skip to content

Releases: PurpleSwtr/docstr-health

v0.1.2

Choose a tag to compare

@PurpleSwtr PurpleSwtr released this 10 Jul 10:00

[0.1.2] - 2026-07-10

Bug Fixes

  • Fix the type hinting bug with support for versions 3.11-3.12

v0.1.1

Choose a tag to compare

@PurpleSwtr PurpleSwtr released this 10 Jul 08:25

[0.1.1] - 2026-07-10

Bug Fixes

  • Fix FileNotFoundError on first run by ensuring ~/.cache/docstr-health/logs/ exists before logger initialization

v0.1.0

Choose a tag to compare

@PurpleSwtr PurpleSwtr released this 09 Jul 02:52

[0.1.0] - 2026-07-09

Features

  • Core docstring parsing engine with quality grading (bad → good → special → epic)
  • CLI with argparse supporting local, Git, and PyPI targets
  • Rich terminal UI with color-coded output, panels, and tables
  • Remote Git repository scanning with caching
  • PyPI package scanning (via pip or uv)
  • Progress bar display during scanning
  • Configuration via config.toml (symbols, colors, keyword levels)
  • Multiple docstring requirement levels
  • Module-level statistics with per-status breakdown
  • Async function detection and support
  • PEP 257 section awareness (Args, Returns, Raises, etc.)
  • Custom exception classes
  • Cache and no-cache modes for remote sources
  • Skipped modules tracking with error display

Flags

  • --repo-url — scan remote Git repositories
  • --pypi-package — scan PyPI packages
  • --cache-dir — custom cache directory
  • --no-cache — disable caching
  • --compact — summary-only output
  • --doc-modules — include module __doc__
  • --ignore-tests — skip test files
  • --version — show version

Infrastructure

  • Project scaffolding with pyproject.toml (uv-based build)
  • Type checking with mypy, linting with ruff