Merge pull request #23 from codeforIATI/add-mypy

lint: Add mypy

.github/workflows/lint.yml

@@ -17,3 +17,5 @@ jobs:
       run: black --check iatidata/
     - name: Check flake8
       run: flake8 iatidata/
+    - name: Check types with mypy
+      run: mypy iatidata/

README.md

@@ -54,12 +54,12 @@ python -m pytest iatidata/
 Linting:
 
 ```
-isort iatidata
-black iatidata
-flake8 iatidata
+isort iatidata/
+black iatidata/
+flake8 iatidata/
+mypy iatidata/
 ```
 
-
 ### Web front-end
 
 Install Node JS 20. e.g. on Ubuntu:

requirements_dev.in

@@ -4,3 +4,6 @@ pytest
 black
 isort
 flake8
+mypy
+types-requests
+lxml-stubs

requirements_dev.txt

@@ -92,10 +92,16 @@ lxml==5.1.0
     # via
     #   -r requirements.txt
     #   iatikit
+lxml-stubs==0.5.1
+    # via -r requirements_dev.in
 mccabe==0.7.0
     # via flake8
+mypy==1.8.0
+    # via -r requirements_dev.in
 mypy-extensions==1.0.0
-    # via black
+    # via
+    #   black
+    #   mypy
 packaging==23.2
     # via
     #   -r requirements.txt
@@ -158,13 +164,19 @@ sqlalchemy==1.4.51
 tomli==2.0.1
     # via
     #   black
+    #   mypy
     #   pytest
+types-requests==2.31.0.20240125
+    # via -r requirements_dev.in
 typing-extensions==4.9.0
-    # via black
+    # via
+    #   black
+    #   mypy
 urllib3==2.0.7
     # via
     #   -r requirements.txt
     #   botocore
     #   requests
+    #   types-requests
 xmlschema==3.0.1
     # via -r requirements.txt

setup.cfg

@@ -3,3 +3,8 @@ profile=black
 
 [flake8]
 max-line-length=119
+
+[mypy]
+
+[mypy-iatikit.*,sqlalchemy.*,google.oauth2.*]
+ignore_missing_imports = True