use interrogate to assess docstring coverage

Author: drbenvincent

.pre-commit-config.yaml

@@ -29,3 +29,7 @@ repos:
       rev: 3.9.2
       hooks:
           - id: flake8
+    - repo: https://github.com/econchick/interrogate
+      rev: 1.5.0
+      hooks:
+          - id: interrogate

README.md

@@ -6,6 +6,7 @@
 ![GitHub Repo stars](https://img.shields.io/github/stars/pymc-labs/causalpy?style=social)
 ![Read the Docs](https://img.shields.io/readthedocs/causalpy)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/causalpy)
+![Interrogate](img/interrogate_badge.svg)
 
 A Python package focussing on causal inference in quasi-experimental settings. The package allows for sophisticated Bayesian model fitting methods to be used in addition to traditional OLS.
 

img/interrogate_badge.svg

@@ -14,3 +14,26 @@ markers = [
     "integration: mark as an integration test.",
     "slow: mark test as slow.",
     ]
+
+[tool.interrogate]
+ignore-init-method = true
+ignore-init-module = false
+ignore-magic = false
+ignore-semiprivate = false
+ignore-private = false
+ignore-property-decorators = false
+ignore-module = false
+ignore-nested-functions = false
+ignore-nested-classes = true
+ignore-setters = false
+fail-under = 80
+exclude = ["setup.py", "docs", "build"]
+ignore-regex = ["^get$", "^mock_.*", ".*BaseClass.*"]
+# possible values: 0 (minimal output), 1 (-v), 2 (-vv)
+verbose = 1
+quiet = false
+whitelist-regex = []
+color = true
+omit-covered-files = false
+generate-badge = "img"
+badge-format = "svg"

pyproject.toml

@@ -1,3 +1,4 @@
 pathlib
 pre-commit
 twine
+interrogate