{"categories":[{"label":"Python Modules","url":"https://skillfed.io/packages/category/software-development-libraries-python-modules/7"},{"label":"Quality Assurance","url":"https://skillfed.io/packages/category/software-development-quality-assurance"},{"label":"Documentation","url":"https://skillfed.io/packages/category/software-development-documentation"}],"enrichment":{"capability":"Interrogate scans a Python codebase to measure and report docstring coverage across modules, classes, functions, and methods, helping identify undocumented code.","skillfed_tags":["documentation-quality","ci-cd-integration","code-metrics"],"use_cases":["Enforce minimum docstring coverage thresholds in CI/CD pipelines to prevent undocumented code from being merged.","Audit an unfamiliar codebase to assess documentation quality as part of code review or onboarding.","Generate and display docstring coverage badges in project README or documentation sites.","Track documentation coverage trends over time by running interrogate in regular builds.","Identify specific undocumented functions and classes with verbose output for targeted documentation efforts."],"what_it_does":"Interrogate is a command-line tool that analyzes Python source code to measure how thoroughly it is documented with docstrings. It scans modules, classes, functions, and methods to identify which have docstrings and which do not, then reports coverage as a percentage. The tool is designed to integrate into CI/CD pipelines to enforce documentation standards on new code and to assess code quality and maintainability in existing projects.\n\nThe package depends on click for CLI handling, colorama for colored output, tabulate for formatted reporting, attrs for data structures, py for filesystem utilities, and tomli for configuration parsing. It can generate SVG coverage badges by default, with optional PNG output available through an extras install (though PNG generation requires additional system libraries). The tool supports configuration via pyproject.toml or setup.cfg files.","worth_installing":"Yes. Interrogate is a lightweight, actively maintained tool with no known vulnerabilities, permissive licensing, and low install friction. It solves a real problem\u2014measuring and enforcing docstring coverage\u2014with a straightforward CLI and CI/CD integration. Install it if you want to track or enforce documentation standards in your Python projects."},"id":"interrogate","links":{"html":"https://skillfed.io/packages/interrogate","md":"https://skillfed.io/packages/interrogate.md","pypi":"https://pypi.org/project/interrogate/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2024-04-07","license_spdx":null,"license_treatment":"permissive","name":"interrogate","python_support":"supports_current","summary":"Interrogate a codebase for docstring coverage."},"popularity":{"monthly_downloads":1536469,"position":3797,"tier":"top_5000"},"security":{"n_vulnerabilities":0},"version":"1.7.0"}