add interrogate to inspect docstrings

.pre-commit-config.yaml

@@ -1,4 +1,12 @@
 repos:
+
+- repo: https://github.com/econchick/interrogate
+  rev: 1.2.0
+  hooks:
+    - id: interrogate
+      exclude: ^(docs|setup.py|tests)
+      args: [--config=pyproject.toml]
+
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v3.1.0
   hooks:
@@ -25,7 +33,7 @@ repos:
   hooks:
   - id: isort
     additional_dependencies: [toml]
-    args: [--project=mymodule, --multi-line=3, --lines-after-imports=2, --lines-between-types=1, --trailing-comma, --force-grid-wrap=0, --use-parentheses, --line-width=88]
+    args: [--project=ioos_pkg_skeleton, --multi-line=3, --lines-after-imports=2, --lines-between-types=1, --trailing-comma, --force-grid-wrap=0, --use-parentheses, --line-width=88]
 
 - repo: https://github.com/asottile/seed-isort-config
   rev: v2.1.1

ioos_pkg_skeleton/__init__.py

@@ -1,3 +1,7 @@
+"""
+ioos_pkg_skeleton is not a reak package, just a set of best practices examples.
+"""
+
 from ioos_pkg_skeleton.ioos_pkg_skeleton import meaning_of_life, meaning_of_life_url
 
 

pyproject.toml

@@ -1,3 +1,16 @@
 [build-system]
 requires = ["setuptools>=42", "wheel", "setuptools_scm[toml]>=3.4"]
 build-backend = "setuptools.build_meta"
+
+[tool.interrogate]
+ignore-init-method = true
+ignore-init-module = false
+ignore-magic = false
+ignore-semiprivate = false
+ignore-private = false
+ignore-module = false
+fail-under = 95
+exclude = ["setup.py", "docs", "tests"]
+verbose = 1
+quiet = false
+color = true

requirements-dev.txt

@@ -6,6 +6,7 @@ flake8-builtins
 flake8-comprehensions
 flake8-mutable
 flake8-print
+interrogate
 isort
 nbsphinx
 pre-commit