Package: pydocstring-coverage
Python docstring coverageNOTE: This is fully the work of others. I made some changes (badge generation,
pre-commit hooks, etc) and wanted it to be pip installable. - @danielsuo.If the health of your documentation is in dire straits,docstr-coveragewill see you now.docstr-coverageis a simple tool that lets you measure your Python source code'sdocstringcoverage. It can show you which of your functions,
classes, methods, and modules don't have docstrings. It also provide statistics about overall docstring coverage for individual
files, and for your entire project.Source:https://github.com/HunterMcGushion/docstr_coverageDocumentation:https://docstr-coverage.readthedocs.ioExample>>> HunterMcGushion$ docstr-coverage /docstr_coverage/

File: "docstr_coverage/setup.py"
 - No module docstring
 - No docstring for `readme`
 Needed: 2; Found: 0; Missing: 2; Coverage: 0.0%

File: "docstr_coverage/docstr_coverage/__init__.py"
 - No module docstring
 Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "docstr_coverage/docstr_coverage/coverage.py"
 - No docstring for `DocStringCoverageVisitor.__init__`
 Needed: 11; Found: 10; Missing: 1; Coverage: 90.9%


Overall statistics for 3 files:
Docstrings needed: 14; Docstrings found: 10; Docstrings missing: 4
Total docstring coverage: 71.4%;  Grade: Very goodHow Do I Use It?Command-line ToolGeneral usage is:docstr-coverage <path to dir or module> [options]To test a single module, namedsome_module.py, run:$ docstr-coverage some_module.pyTo test a directory (recursively), just supply the directorysome_project/srcinstead:$ docstr-coverage some_project/srcOptions:--skipmagic, -m- Ignore all magic methods (like__init__, and__str__)--skipfiledoc, -f- Ignore module docstrings (at the top of files)--exclude=<regex>, -e <regex>- Filepath pattern to exclude from analysisTo exclude the contents of a virtual environmentenvand yourtestsdirectory, run:$ docstr-coverage some_project/ -e "env/*|tests/*"--verbose=<level>, -v <level>- Set verbosity level (0-3)0 - Silence1 - Print overall statistics2 - Also print individual statistics for each file3 - Also print missing docstrings (function names, class names, etc.)--docstr-ignore-file=, -d- Filepath containing list of patterns to ignore. Patterns are (file-pattern, name-pattern) pairsFile content example:SomeFile method_to_ignore1 method_to_ignore2 method_to_ignore3
FileWhereWeWantToIgnoreAllSpecialMethods __.+__
.* method_to_ignore_in_all_files
a_very_important_view_file ^get$ ^set$ ^post$
detect_.* get_val.*Package in Your ProjectYou can also usedocstr-coverageas a part of your project by importing it thusly:fromdocstr_coverageimportget_docstring_coveragemy_coverage=get_docstring_coverage(['some_dir/file_0.py','some_dir/file_1.py'])Arguments:Required arg:filenames<list of string filenames>Optional kwargs:skip_magic<bool>,skip_file_docstring<bool>,verbose<int (0-3)>For more info onget_docstring_coverageand its parameters, please see itsdocumentationResults:get_docstring_coveragereturns two dicts: 1) stats for each file, and 2) total stats.
For more info, please see theget_docstring_coveragedocumentationWhy Should I Use It?Thorough documentation is important to help others (and even yourself) understand your codeAs a developer, improve your code's maintainability for when you need to make updates and fix bugsAs a user, instantly know how easy it's going to be to understand a new libraryIf its documentation coverage is low, you may need to figure a lot out for yourselfInstallationpip install docstr-coverageIf you like being on the cutting-edge, and you want all the latest developments, run:pip install git+https://github.com/HunterMcGushion/docstr_coverage.gitSpecial ThanksThank you to Alexey "DataGreed" Strelkov, and James Harlow for doing all the hard work.docstr-coveragesimply revives and brings their efforts to Python 3. See 'THANKS.txt' for more information.