fix!: rename package to 'toolbox_llamaindex' (#8)

* chore: chore: separate sdk from server repo

* chore: fix package name

* fix!: Improve PyPI package name.

* improve package name

* fix package name

* lint

* lint

* change license year for header checker lint

* reformat

* Change mypy command

* change back mypy command

* chore: rename folder

* lint

* Create py.typed

* random commit to get rid of conventional commits

* revert random commit

* chore: add missing trampolinerc

* Revert "chore: add missing trampolinerc" (#14)

---------

Co-authored-by: Kurtis Van Gent <[email protected]>
Co-authored-by: Anubhav Dhawan <[email protected]>

Author: 3 people

.github/workflows/lint.yaml

@@ -50,12 +50,14 @@ jobs:
             } catch (e) {
               console.log('Failed to remove label. Another job may have already removed it!');
             }
+
       - name: Checkout code
         uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
         with:
           ref: ${{ github.event.pull_request.head.sha }}
           repository: ${{ github.event.pull_request.head.repo.full_name }}
           token: ${{ secrets.GITHUB_TOKEN }}
+
       - name: Setup Python
         uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
         with:
@@ -71,7 +73,8 @@ jobs:
         run: |
           black --check .
           isort --check .
+      
       - name: Run type-check
         env:
           MYPYPATH: './src'
-        run: mypy --install-types --non-interactive --cache-dir=.mypy_cache/ -p toolbox_llamaindex_sdk
+        run: mypy --install-types --non-interactive --cache-dir=.mypy_cache/ -p toolbox_llamaindex

README.md

@@ -31,15 +31,15 @@ applications, enabling advanced orchestration and interaction with GenAI models.
 You can install the Toolbox SDK for LlamaIndex using `pip`.
 
 ```bash
-pip install toolbox-llamaindex-sdk
+pip install toolbox-llamaindex
 ```
 
 ## Usage
 
 Import and initialize the toolbox client.
 
 ```py
-from toolbox_llamaindex_sdk import ToolboxClient
+from toolbox_llamaindex import ToolboxClient
 
 # Replace with your Toolbox service's URL
 toolbox = ToolboxClient("http://127.0.0.1:5000")
@@ -173,7 +173,7 @@ toolbox.add_auth_token("my_auth_service", get_auth_token)
 
 ```py
 import asyncio
-from toolbox_llamaindex_sdk import ToolboxClient
+from toolbox_llamaindex import ToolboxClient
 
 async def get_auth_token():
     # Replace with your actual ID token retrieval logic.

pyproject.toml

@@ -1,5 +1,5 @@
 [project]
-name = "toolbox-llamaindex-sdk"
+name = "toolbox-llamaindex"
 version="0.0.1"
 description = "Python SDK for interacting with the Toolbox service with LlamaIndex"
 license = {file = "LICENSE"}

src/toolbox_llamaindex_sdk/__init__.py src/toolbox_llamaindex/__init__.pysrc/toolbox_llamaindex_sdk/__init__.py renamed to src/toolbox_llamaindex/__init__.py

@@ -0,0 +1 @@
+

src/toolbox_llamaindex_sdk/client.py src/toolbox_llamaindex/client.pysrc/toolbox_llamaindex_sdk/client.py renamed to src/toolbox_llamaindex/client.py

@@ -21,8 +21,8 @@
 from llama_index.core.tools import FunctionTool
 from llama_index.core.tools.types import ToolMetadata, ToolOutput
 
-from toolbox_llamaindex_sdk import ToolboxClient
-from toolbox_llamaindex_sdk.utils import ManifestSchema, ParameterSchema, ToolSchema
+from toolbox_llamaindex import ToolboxClient
+from toolbox_llamaindex.utils import ManifestSchema, ParameterSchema, ToolSchema
 
 # Sample manifest data for testing
 manifest_data = {
@@ -86,7 +86,7 @@ async def test_close_not_closing_session():
 
 
 @pytest.mark.asyncio
-@patch("toolbox_llamaindex_sdk.client._load_manifest")
+@patch("toolbox_llamaindex.client._load_manifest")
 async def test_load_tool_manifest_success(mock_load_manifest):
     client = ToolboxClient("https://my-toolbox.com", session=aiohttp.ClientSession())
     mock_load_manifest.return_value = ManifestSchema(**manifest_data)
@@ -99,7 +99,7 @@ async def test_load_tool_manifest_success(mock_load_manifest):
 
 
 @pytest.mark.asyncio
-@patch("toolbox_llamaindex_sdk.client._load_manifest")
+@patch("toolbox_llamaindex.client._load_manifest")
 async def test_load_tool_manifest_failure(mock_load_manifest):
     client = ToolboxClient("https://my-toolbox.com", session=aiohttp.ClientSession())
     mock_load_manifest.side_effect = Exception("Failed to load manifest")
@@ -110,7 +110,7 @@ async def test_load_tool_manifest_failure(mock_load_manifest):
 
 
 @pytest.mark.asyncio
-@patch("toolbox_llamaindex_sdk.client._load_manifest")
+@patch("toolbox_llamaindex.client._load_manifest")
 async def test_load_toolset_manifest_success(mock_load_manifest):
     client = ToolboxClient("https://my-toolbox.com", session=aiohttp.ClientSession())
     mock_load_manifest.return_value = ManifestSchema(**manifest_data)
@@ -132,7 +132,7 @@ async def test_load_toolset_manifest_success(mock_load_manifest):
 
 
 @pytest.mark.asyncio
-@patch("toolbox_llamaindex_sdk.client._load_manifest")
+@patch("toolbox_llamaindex.client._load_manifest")
 async def test_load_toolset_manifest_failure(mock_load_manifest):
     client = ToolboxClient("https://my-toolbox.com", session=aiohttp.ClientSession())
     mock_load_manifest.side_effect = Exception("Failed to load manifest")
@@ -166,8 +166,8 @@ async def test_generate_tool_missing_tool():
 
 
 @pytest.mark.asyncio
-@patch("toolbox_llamaindex_sdk.client.ToolboxClient._load_tool_manifest")
-@patch("toolbox_llamaindex_sdk.client.ToolboxClient._generate_tool")
+@patch("toolbox_llamaindex.client.ToolboxClient._load_tool_manifest")
+@patch("toolbox_llamaindex.client.ToolboxClient._generate_tool")
 async def test_load_tool_success(mock_generate_tool, mock_load_manifest):
     client = ToolboxClient("https://my-toolbox.com", session=aiohttp.ClientSession())
     mock_load_manifest.return_value = ManifestSchema(**manifest_data)
@@ -191,7 +191,7 @@ async def test_load_tool_success(mock_generate_tool, mock_load_manifest):
 
 
 @pytest.mark.asyncio
-@patch("toolbox_llamaindex_sdk.client.ToolboxClient._load_tool_manifest")
+@patch("toolbox_llamaindex.client.ToolboxClient._load_tool_manifest")
 async def test_load_tool_failure(mock_load_manifest):
     client = ToolboxClient("https://my-toolbox.com", session=aiohttp.ClientSession())
     mock_load_manifest.side_effect = Exception("Failed to load manifest")
@@ -202,8 +202,8 @@ async def test_load_tool_failure(mock_load_manifest):
 
 
 @pytest.mark.asyncio
-@patch("toolbox_llamaindex_sdk.client.ToolboxClient._load_toolset_manifest")
-@patch("toolbox_llamaindex_sdk.client.ToolboxClient._generate_tool")
+@patch("toolbox_llamaindex.client.ToolboxClient._load_toolset_manifest")
+@patch("toolbox_llamaindex.client.ToolboxClient._generate_tool")
 async def test_load_toolset_success(mock_generate_tool, mock_load_manifest):
     client = ToolboxClient("https://my-toolbox.com", session=aiohttp.ClientSession())
     mock_load_manifest.return_value = ManifestSchema(**manifest_data)
@@ -260,7 +260,7 @@ async def test_load_toolset_success(mock_generate_tool, mock_load_manifest):
 
 
 @pytest.mark.asyncio
-@patch("toolbox_llamaindex_sdk.client.ToolboxClient._load_toolset_manifest")
+@patch("toolbox_llamaindex.client.ToolboxClient._load_toolset_manifest")
 async def test_load_toolset_failure(mock_load_manifest):
     """Test handling of _load_toolset_manifest failure."""
     client = ToolboxClient("https://my-toolbox.com", session=aiohttp.ClientSession())
@@ -272,9 +272,7 @@ async def test_load_toolset_failure(mock_load_manifest):
 
 
 @pytest.mark.asyncio
-@patch(
-    "toolbox_llamaindex_sdk.client._invoke_tool", return_value={"result": "test_result"}
-)
+@patch("toolbox_llamaindex.client._invoke_tool", return_value={"result": "test_result"})
 async def test_generate_tool_invoke(mock_invoke_tool):
     """Test invoking the tool function generated by _generate_tool."""
     mock_session = Mock(spec=aiohttp.ClientSession)
@@ -572,7 +570,7 @@ async def test_process_auth_params(
 
 
 @pytest.mark.asyncio
-@patch("toolbox_llamaindex_sdk.client._load_manifest")
+@patch("toolbox_llamaindex.client._load_manifest")
 @pytest.mark.parametrize(
     "params, auth_tokens, expected_fn_schema_str, expected_tool_param_auth",
     [
@@ -631,8 +629,8 @@ async def test_load_tool(
 
 
 @pytest.mark.asyncio
-@patch("toolbox_llamaindex_sdk.client.ToolboxClient._load_tool_manifest")
-@patch("toolbox_llamaindex_sdk.client.ToolboxClient._generate_tool")
+@patch("toolbox_llamaindex.client.ToolboxClient._load_tool_manifest")
+@patch("toolbox_llamaindex.client.ToolboxClient._generate_tool")
 async def test_load_tool_deprecation_warning(mock_generate_tool, mock_load_manifest):
     """Test load_tool with deprecated auth_headers argument."""
     client = ToolboxClient("https://my-toolbox.com", session=aiohttp.ClientSession())
@@ -668,7 +666,7 @@ async def test_load_tool_deprecation_warning(mock_generate_tool, mock_load_manif
 
 
 @pytest.mark.asyncio
-@patch("toolbox_llamaindex_sdk.client._load_manifest")
+@patch("toolbox_llamaindex.client._load_manifest")
 @pytest.mark.parametrize(
     "params, auth_tokens, expected_tool_param_auth, expected_num_tools",
     [
@@ -727,8 +725,8 @@ async def test_load_toolset(
 
 
 @pytest.mark.asyncio
-@patch("toolbox_llamaindex_sdk.client.ToolboxClient._load_toolset_manifest")
-@patch("toolbox_llamaindex_sdk.client.ToolboxClient._generate_tool")
+@patch("toolbox_llamaindex.client.ToolboxClient._load_toolset_manifest")
+@patch("toolbox_llamaindex.client.ToolboxClient._generate_tool")
 async def test_load_toolset_deprecation_warning(mock_generate_tool, mock_load_manifest):
     """Test load_toolset with deprecated auth_headers argument."""
     client = ToolboxClient("https://my-toolbox.com", session=aiohttp.ClientSession())
@@ -765,7 +763,7 @@ async def test_load_toolset_deprecation_warning(mock_generate_tool, mock_load_ma
 
 
 @pytest.mark.asyncio
-@patch("toolbox_llamaindex_sdk.client._invoke_tool")
+@patch("toolbox_llamaindex.client._invoke_tool")
 @pytest.mark.parametrize(
     "manifest, tool_param_auth, id_token_getters, expected_invoke_tool_call",
     [
@@ -907,7 +905,7 @@ async def test_del_closes_session_not_running(mock_close):
 
 
 @pytest.mark.asyncio
-@patch("toolbox_llamaindex_sdk.client.asyncio.get_event_loop")
+@patch("toolbox_llamaindex.client.asyncio.get_event_loop")
 @patch("aiohttp.ClientSession.close")
 async def test_del_handles_exception(mock_close, mock_get_event_loop):
     """Test that __del__ handles exceptions gracefully."""
@@ -923,7 +921,7 @@ async def test_del_handles_exception(mock_close, mock_get_event_loop):
 
 
 @pytest.mark.asyncio
-@patch("toolbox_llamaindex_sdk.client.asyncio.get_event_loop")
+@patch("toolbox_llamaindex.client.asyncio.get_event_loop")
 async def test_del_loop_not_running(mock_get_event_loop):
     """Test that __del__ handles the case where the loop is not running."""
 

src/toolbox_llamaindex/py.typed

@@ -35,7 +35,7 @@
 import pytest_asyncio
 from aiohttp import ClientResponseError
 
-from toolbox_llamaindex_sdk.client import ToolboxClient
+from toolbox_llamaindex.client import ToolboxClient
 
 
 @pytest.mark.asyncio

src/toolbox_llamaindex_sdk/utils.py src/toolbox_llamaindex/utils.pysrc/toolbox_llamaindex_sdk/utils.py renamed to src/toolbox_llamaindex/utils.py

@@ -23,7 +23,7 @@
 import pytest
 from pydantic import BaseModel
 
-from toolbox_llamaindex_sdk.utils import (
+from toolbox_llamaindex.utils import (
     ParameterSchema,
     _convert_none_to_empty_string,
     _get_auth_headers,