Skip to main content

Add config for interrogate

ID
1ce232c
date
2024-08-24 09:14:40+00:00
author
Alex Chan <alex@alexwlchan.net>
parent
5caf656
message
Add config for `interrogate`

For https://github.com/alexwlchan/alexwlchan/issues/18
changed files
4 files, 20 additions

Changed files

.github/workflows/test.yml (616) → .github/workflows/test.yml (673)

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index 754e0a6..afd767e 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -29,6 +29,9 @@ jobs:
         ruff check .
         ruff format --check .
 
+    - name: Check docstrings
+      run: interrogate -vv
+
     - name: Check types
       run: mypy src tests
     - name: Run tests

dev_requirements.in (44) → dev_requirements.in (56)

diff --git a/dev_requirements.in b/dev_requirements.in
index 4198c39..1d9fecc 100644
--- a/dev_requirements.in
+++ b/dev_requirements.in
@@ -1,6 +1,7 @@
 -e file:.
 
 build
+interrogate
 mypy
 pytest-cov
 ruff

dev_requirements.txt (1669) → dev_requirements.txt (1901)

diff --git a/dev_requirements.txt b/dev_requirements.txt
index 4e2a18c..c9563e3 100644
--- a/dev_requirements.txt
+++ b/dev_requirements.txt
@@ -2,12 +2,18 @@
 #    uv pip compile dev_requirements.in --output-file dev_requirements.txt
 -e file:.
     # via -r dev_requirements.in
+attrs==24.2.0
+    # via interrogate
 build==1.2.1
     # via -r dev_requirements.in
 certifi==2024.7.4
     # via requests
 charset-normalizer==3.3.2
     # via requests
+click==8.1.7
+    # via interrogate
+colorama==0.4.6
+    # via interrogate
 coverage==7.6.1
     # via pytest-cov
 docutils==0.21.2
@@ -18,6 +24,8 @@ importlib-metadata==8.2.0
     # via twine
 iniconfig==2.0.0
     # via pytest
+interrogate==1.7.0
+    # via -r dev_requirements.in
 jaraco-classes==3.4.0
     # via keyring
 jaraco-context==5.3.0
@@ -48,6 +56,8 @@ pkginfo==1.10.0
     # via twine
 pluggy==1.5.0
     # via pytest
+py==1.11.0
+    # via interrogate
 pygments==2.18.0
     # via
     #   readme-renderer
@@ -72,6 +82,8 @@ rich==13.7.1
     # via twine
 ruff==0.6.1
     # via -r dev_requirements.in
+tabulate==0.9.0
+    # via interrogate
 twine==5.1.1
     # via -r dev_requirements.in
 typing-extensions==4.12.2

pyproject.toml (1189) → pyproject.toml (1252)

diff --git a/pyproject.toml b/pyproject.toml
index 19b123b..d3aecf0 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -51,3 +51,7 @@ filterwarnings = ["error"]
 [tool.mypy]
 mypy_path = "src"
 strict = true
+
+[tool.interrogate]
+fail_under = 100
+omit-covered-files = true