add ruff + mypy to CI (#2)

Author: axl1313

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+on:
+  push:
+  pull_request:
+
+jobs:
+  typecheck:
+    name: Type check
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - uses: pypa/hatch@install
+      # TODO: remove after we release codex-sdk package (and are no longer installing from github)
+      - name: setup git url rewrite
+        run: git config --global url."https://${{ secrets.GH_USERNAME }}:${{ secrets.CLEANLAB_BOT_PAT }}@github.com".insteadOf ssh://[email protected]
+      - run: hatch run types:check
+  fmt:
+    name: Format and lint
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - uses: pypa/hatch@install
+      - run: hatch fmt --check

pyproject.toml

@@ -40,6 +40,8 @@ path = "src/cleanlab_codex/__about__.py"
 [tool.hatch.envs.types]
 extra-dependencies = [
   "mypy>=1.0.0",
+  "pytest",
+  "llama-index-core",
 ]
 [tool.hatch.envs.types.scripts]
 check = "mypy --install-types --non-interactive {args:src/cleanlab_codex tests}"

src/cleanlab_codex/utils/llamaindex.py

@@ -27,4 +27,4 @@ def get_function_schema(name: str, func: Callable[..., Any], tool_properties: di
                 FieldInfo(default=param_default, description=description),
             )
 
-    return create_model(name, **fields)
+    return create_model(name, **fields)  # type: ignore

tests/test_codex.py

@@ -16,9 +16,11 @@ def mock_client() -> Generator[_Codex, None, None]:
 
 
 def test_query_read_only(mock_client: _Codex):
-    mock_client.projects.entries.query.return_value = None
+    mock_client.projects.entries.query.return_value = None  # type: ignore
     codex = Codex("")
     res = codex.query("What is the capital of France?", read_only=True, project_id=fake_project_id)
-    mock_client.projects.entries.query.assert_called_once_with(fake_project_id, "What is the capital of France?")
-    mock_client.projects.entries.add_question.assert_not_called()
+    mock_client.projects.entries.query.assert_called_once_with(  # type: ignore
+        fake_project_id, "What is the capital of France?"
+    )
+    mock_client.projects.entries.add_question.assert_not_called()  # type: ignore
     assert res == (None, None)