docs: changed wording in readme, installed mypy and create mypy.ini config. add requirements-dev.txt for mypy

FirstFlush · FirstFlush · commit 0ff3f28578c5 · 2025-07-30T17:11:01.000-07:00
diff --git a/README.md b/README.md
@@ -31,8 +31,8 @@ class PredictionResponse(BaseModel):
 ```python
 @router.post("/foo", response_model=PredictionResponse)
 def foo():
-    result = PredictionResponse(entities=[{"label": "RESOURCE", "value": "food"}])
-    return build_api_response(data=result, status=200)
+    your_data = PredictionResponse(entities=[{"label": "RESOURCE", "value": "food"}])
+    return build_api_response(data=your_data, status=200)
 ```
 
 ✅ build_api_response() accepts any Pydantic model or well-typed object and wraps it into a fully structured, metadata-rich response — with full type hint propagation and IDE support via generics.
diff --git a/mypy.ini b/mypy.ini
@@ -0,0 +1,6 @@
+# mypy.ini
+[mypy]
+python_version = 3.10
+strict = True
+ignore_missing_imports = True
+show_error_codes = True
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -0,0 +1,9 @@
+annotated-types==0.7.0
+mypy==1.17.0
+mypy_extensions==1.1.0
+pathspec==0.12.1
+pydantic==2.11.7
+pydantic_core==2.33.2
+tomli==2.2.1
+typing-inspection==0.4.1
+typing_extensions==4.14.1
