Merge origin/main into refactor/replace-mypy-with-ty

ryoppippi · ryoppippi · commit dd8c61bc16ae · 2025-12-21T15:34:03.000Z
Resolved conflict in pyproject.toml:
- Keep coverage configuration from main
- Remove mypy configuration (replaced by ty in this branch)
diff --git a/.claude/rules/no-relative-imports.md b/.claude/rules/no-relative-imports.md
@@ -12,7 +12,7 @@ Standards for using absolute imports instead of relative imports in Python files
 
 - Always use absolute imports starting with the full package name (`stackone_ai`)
 - Never use relative imports (`.` or `..`)
-- Keep imports organised and grouped
+- Keep imports organized and grouped
 
 ## Examples
 
diff --git a/.env_example b/.env_example
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -12,6 +12,8 @@ concurrency:
 
 permissions:
   contents: read
+  pages: write
+  id-token: write
 
 jobs:
   typos:
@@ -59,3 +61,46 @@ jobs:
 
       - name: Run Tests
         run: nix develop --command just test
+
+  coverage:
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main'
+    env:
+      STACKONE_API_KEY: ${{ secrets.STACKONE_API_KEY }}
+      OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+
+      - name: Setup Nix
+        uses: ./.github/actions/setup-nix
+
+      - name: Install dependencies
+        run: nix develop --command just install --all-extras
+
+      - name: Run Tests with Coverage
+        run: nix develop --command just coverage
+
+      - name: Create Coverage Badge
+        uses: jaywcjlove/coverage-badges-cli@bd6ccbf422c0ed54c01f283019fd2bc648f58541 # v2.2.0
+        with:
+          source: coverage/coverage.json
+          output: coverage/badges.svg
+          jsonPath: totals.percent_covered
+
+      - name: Upload coverage artifact
+        uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v3.0.2
+        with:
+          path: coverage/
+
+  deploy-coverage:
+    needs: coverage
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main'
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5
diff --git a/.gitignore b/.gitignore
@@ -5,6 +5,8 @@
 .pytest_cache
 .python-version
 __pycache__
+.coverage
+coverage/
 
 .DS_Store
 
diff --git a/.vscode/settings.json b/.vscode/settings.json
diff --git a/README.md b/README.md
@@ -2,6 +2,7 @@
 
 [![PyPI version](https://badge.fury.io/py/stackone-ai.svg)](https://badge.fury.io/py/stackone-ai)
 [![GitHub release (latest by date)](https://img.shields.io/github/v/release/StackOneHQ/stackone-ai-python)](https://github.com/StackOneHQ/stackone-ai-python/releases)
+[![Coverage](https://stackonehq.github.io/stackone-ai-python/badges.svg)](https://stackonehq.github.io/stackone-ai-python/html/)
 
 StackOne AI provides a unified interface for accessing various SaaS tools through AI-friendly APIs.
 
@@ -358,25 +359,6 @@ For more examples, check out the [examples/](examples/) directory:
 - [CrewAI Integration](examples/crewai_integration.py)
 - [Meta Tools](examples/meta_tools_example.py)
 
-## Migration from `get_tools()` to `fetch_tools()`
-
-If you're upgrading from a previous version that used `get_tools()`, here's how to migrate:
-
-```python
-# Before (deprecated)
-tools = toolset.get_tools("hris_*", account_id="acc-123")
-
-# After
-tools = toolset.fetch_tools(actions=["hris_*"], account_ids=["acc-123"])
-```
-
-Key differences:
-
-- `fetch_tools()` uses keyword arguments for all filtering
-- `account_id` becomes `account_ids` (list)
-- Filter patterns go in the `actions` parameter (list)
-- `fetch_tools()` requires the MCP extra (`pip install 'stackone-ai[mcp]'`)
-
 ## License
 
 Apache 2.0 License
diff --git a/examples/crewai_integration.py b/examples/crewai_integration.py
@@ -18,7 +18,7 @@
 
 def crewai_integration():
     toolset = StackOneToolSet()
-    tools = toolset.fetch_tools(actions=["hris_*"], account_ids=[account_id])
+    tools = toolset.fetch_tools(actions=["bamboohr_*"], account_ids=[account_id])
 
     # CrewAI uses LangChain tools natively
     langchain_tools = tools.to_langchain()
diff --git a/examples/file_uploads.py b/examples/file_uploads.py
@@ -1,6 +1,6 @@
 """
 Example demonstrating file upload functionality using StackOne.
-Shows how to upload an employee document using an HRIS integration.
+Shows how to upload an employee document using a BambooHR integration.
 
 This example is runnable with the following command:
 ```bash
@@ -24,7 +24,7 @@
 """
 # Resume content
 
-This is a sample resume content that will be uploaded using the `hris_upload_employee_document` tool.
+This is a sample resume content that will be uploaded using the `bamboohr_upload_employee_document` tool.
 """
 
 resume_content = """
@@ -46,7 +46,7 @@
 """
 # Upload employee document
 
-This function uploads a resume using the `hris_upload_employee_document` tool.
+This function uploads a resume using the `bamboohr_upload_employee_document` tool.
 
 """
 
@@ -57,9 +57,9 @@ def upload_employee_document() -> None:
         resume_file.write_text(resume_content)
 
         toolset = StackOneToolSet()
-        tools = toolset.fetch_tools(actions=["hris_*"], account_ids=[account_id])
+        tools = toolset.fetch_tools(actions=["bamboohr_*"], account_ids=[account_id])
 
-        upload_tool = tools.get_tool("hris_upload_employee_document")
+        upload_tool = tools.get_tool("bamboohr_upload_employee_document")
         assert upload_tool is not None
 
         with open(resume_file, "rb") as f:
diff --git a/examples/index.py b/examples/index.py
@@ -1,5 +1,5 @@
 """
-StackOne AI SDK provides an AI-friendly interface for accessing various SaaS tools through the StackOne Unified API.
+StackOne AI SDK provides an AI-friendly interface for accessing various SaaS tools through the StackOne API.
 
 This SDK is available on [PyPI](https://pypi.org/project/stackone-ai/) for python projects. There is a node version in the works.
 
@@ -72,11 +72,11 @@
 def quickstart():
     toolset = StackOneToolSet()
 
-    # Get all HRIS-related tools using MCP-backed fetch_tools()
-    tools = toolset.fetch_tools(actions=["hris_*"], account_ids=[account_id])
+    # Get all BambooHR-related tools using MCP-backed fetch_tools()
+    tools = toolset.fetch_tools(actions=["bamboohr_*"], account_ids=[account_id])
 
     # Use a specific tool
-    employee_tool = tools.get_tool("hris_list_employees")
+    employee_tool = tools.get_tool("bamboohr_list_employees")
     assert employee_tool is not None
 
     employees = employee_tool.execute()
diff --git a/examples/langchain_integration.py b/examples/langchain_integration.py
@@ -19,7 +19,7 @@
 
 def langchain_integration() -> None:
     toolset = StackOneToolSet()
-    tools = toolset.fetch_tools(actions=["hris_*"], account_ids=[account_id])
+    tools = toolset.fetch_tools(actions=["bamboohr_*"], account_ids=[account_id])
 
     # Convert to LangChain format and verify
     langchain_tools = tools.to_langchain()
diff --git a/examples/meta_tools_example.py b/examples/meta_tools_example.py
@@ -24,8 +24,8 @@ def example_meta_tools_basic():
     toolset = StackOneToolSet()
 
     # Get all available tools using MCP-backed fetch_tools()
-    all_tools = toolset.fetch_tools(actions=["hris_*"])
-    print(f"Total HRIS tools available: {len(all_tools)}")
+    all_tools = toolset.fetch_tools(actions=["bamboohr_*"])
+    print(f"Total BambooHR tools available: {len(all_tools)}")
 
     # Get meta tools for dynamic discovery
     meta_tools = all_tools.meta_tools()
@@ -93,9 +93,9 @@ def example_with_openai():
         # Initialize StackOne toolset
         toolset = StackOneToolSet()
 
-        # Get HRIS tools and their meta tools using MCP-backed fetch_tools()
-        hris_tools = toolset.fetch_tools(actions=["hris_*"])
-        meta_tools = hris_tools.meta_tools()
+        # Get BambooHR tools and their meta tools using MCP-backed fetch_tools()
+        bamboohr_tools = toolset.fetch_tools(actions=["bamboohr_*"])
+        meta_tools = bamboohr_tools.meta_tools()
 
         # Convert to OpenAI format
         openai_tools = meta_tools.to_openai()
@@ -142,7 +142,7 @@ def example_with_langchain():
         toolset = StackOneToolSet()
 
         # Get tools and convert to LangChain format using MCP-backed fetch_tools()
-        tools = toolset.fetch_tools(actions=["hris_list_*"])
+        tools = toolset.fetch_tools(actions=["bamboohr_list_*"])
         langchain_tools = tools.to_langchain()
 
         # Get meta tools as well
diff --git a/examples/openai_integration.py b/examples/openai_integration.py
@@ -36,9 +36,9 @@ def openai_integration() -> None:
     # Filter tools to only the ones we need to avoid context window limits
     tools = toolset.fetch_tools(
         actions=[
-            "hris_get_employee",
-            "hris_list_employee_employments",
-            "hris_get_employee_employment",
+            "bamboohr_get_employee",
+            "bamboohr_list_employee_employments",
+            "bamboohr_get_employee_employment",
         ],
         account_ids=[account_id],
     )
diff --git a/examples/stackone_account_ids.py b/examples/stackone_account_ids.py
@@ -19,14 +19,14 @@ def stackone_account_ids():
     """
     Set the account ID whilst getting tools using fetch_tools().
     """
-    tools = toolset.fetch_tools(actions=["hris_*"], account_ids=["test_id"])
+    tools = toolset.fetch_tools(actions=["bamboohr_*"], account_ids=["test_id"])
 
     """
     You can override the account ID on fetched tools.
     """
     tools.set_account_id("a_different_id")
 
-    employee_tool = tools.get_tool("hris_get_employee")
+    employee_tool = tools.get_tool("bamboohr_get_employee")
     assert employee_tool is not None
 
     """
diff --git a/flake.nix b/flake.nix
@@ -84,6 +84,7 @@
               nixfmt-rfc-style
               typos
               typos-lsp
+              basedpyright
             ];
 
             shellHook = ''
diff --git a/justfile b/justfile
@@ -14,6 +14,10 @@ lint-fix:
 test:
 	uv run pytest
 
+# Run tests with coverage
+coverage:
+	uv run pytest --cov --cov-report=term --cov-report=json --cov-report=html
+
 # Run tool-specific tests
 test-tools:
 	uv run pytest tests
diff --git a/pyproject.toml b/pyproject.toml
@@ -94,3 +94,26 @@ select = [
     "C4", # flake8-comprehensions
     "UP", # pyupgrade
 ]
+
+[tool.coverage.run]
+source = ["stackone_ai"]
+branch = true
+omit = [
+    "stackone_ai/__init__.py",
+    "**/py.typed",
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise NotImplementedError",
+    "if TYPE_CHECKING:",
+    "if typing.TYPE_CHECKING:",
+]
+
+[tool.coverage.json]
+output = "coverage/coverage.json"
+
+[tool.coverage.html]
+directory = "coverage/html"
diff --git a/stackone_ai/integrations/langgraph.py b/stackone_ai/integrations/langgraph.py
@@ -7,7 +7,7 @@
     from stackone_ai.integrations.langgraph import to_tool_node
 
     toolset = StackOneToolSet()
-    tools = toolset.get_tools("hris_*", account_id="...")
+    tools = toolset.fetch_tools(actions=["bamboohr_*"], account_ids=["..."])
     node = to_tool_node(tools)  # langgraph.prebuilt.ToolNode
 """
 
diff --git a/tests/test_feedback.py b/tests/test_feedback.py
@@ -252,7 +252,7 @@ def test_live_feedback_submission() -> None:
         {
             "feedback": f"CI live test feedback {feedback_token}",
             "account_id": f"acc-ci-{feedback_token}",
-            "tool_names": ["hris_list_employees"],
+            "tool_names": ["hibob_list_employees"],
         }
     )
 
diff --git a/tests/test_meta_tools.py b/tests/test_meta_tools.py
diff --git a/tests/test_tfidf_index.py b/tests/test_tfidf_index.py
diff --git a/tests/test_toolset.py b/tests/test_toolset.py
diff --git a/typos.toml b/typos.toml
