v0.0.14

Author: azdolinski

CHANGELOG.md

@@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/),
 and this project adheres to [SimpleTool](https://github.com/nchekwa/simpletool-python/tree/master).
 
+
+# [0.0.14] - 2025-01-09 Milestone Alpha2
+
+## Added
+- SimpleToolResponseModel
+- add correct handle __repr__ for SimpleTool child classes
+- add get_version for `setup.py` to automate version update
+- auto add annotation version in `__init__.py`
+
 # [0.0.13] - 2025-01-08 Milestone Alpha2
 
 ## Fixed

setup.py

@@ -1,7 +1,37 @@
 from setuptools import setup
+import re
+import os
+
+
+def get_version():
+    # Read version from CHANGELOG.md
+    with open('CHANGELOG.md', 'r', encoding='utf-8') as f:
+        first_line = f.readline().strip()
+        match = re.search(r'\[(\d+\.\d+\.\d+)\]', first_line)
+        if match:
+            version = match.group(1)
+            
+            # Update version in __init__.py
+            init_path = os.path.join('simpletool', '__init__.py')
+            with open(init_path, 'r', encoding='utf-8') as init_file:
+                init_content = init_file.read()
+            
+            # Replace version in the header
+            updated_init_content = re.sub(
+                r'(version:)\s*',
+                r'\1 ' + version,
+                init_content
+            )
+            
+            with open(init_path, 'w', encoding='utf-8') as init_file:
+                init_file.write(updated_init_content)
+            
+            return version
+    return '0.0.0'  # fallback version if not found
+
 
 setup(name='simpletool',
-      version='0.0.13',
+      version=get_version(),
       description='simpletool',
       url='https://github.com/nchekwa/simpletool-python/tree/master',
       author='Artur Zdolinski',

simpletool/__init__.py

@@ -1,5 +1,7 @@
 """
-This module contains the base class for all simple tools.
+name: SimpleTools
+author: Artur Zdolinski
+version: 
 """
 import asyncio
 import os
@@ -14,7 +16,7 @@
 from pydantic import BaseModel, Field
 from pydantic.fields import FieldInfo
 from .types import Content, TextContent, ImageContent, FileContent, ResourceContent, BoolContent, ErrorContent
-from .models import SimpleInputModel
+from .models import SimpleInputModel, SimpleToolResponseModel
 from .schema import NoTitleDescriptionJsonSchema
 from .errors import SimpleToolError, ValidationError
 
@@ -200,7 +202,16 @@ def __str__(self) -> str:
         }).encode("utf-8").decode("unicode_escape")
 
     def __repr__(self):
-        return f"SimpleTool(name='{self.name}', description={self.description})"
+        # Create a SimpleToolResponseModel internally
+        response_model = SimpleToolResponseModel(
+            name=self.name,
+            description=self.description,
+            input_schema=self.input_schema
+        )
+        # Get the original repr
+        original_repr = repr(response_model)
+        # Replace with the actual child class name
+        return original_repr.replace("SimpleToolResponseModel", self.__class__.__name__)
 
     @validate_tool_output
     @set_timeout(DEFAULT_TIMEOUT)

simpletool/models.py

@@ -1,6 +1,6 @@
 """ Type definitions for the simpletool package."""
-from typing import Union, Type
-from pydantic import BaseModel, model_validator
+from typing import Union, Type, Optional
+from pydantic import BaseModel, model_validator, Field
 
 
 class SimpleInputModel(BaseModel):
@@ -29,3 +29,35 @@ class SimpleToolModel(BaseModel):
     name: str
     description: Union[str, None] = None
     input_model: Type[SimpleInputModel]
+
+
+class SimpleToolResponseModel(BaseModel):
+    """
+    Response model for the tools endpoint.
+
+    Attributes:
+        name (str): The name of the tool.
+        description (str): A description of the tool's functionality.
+        input_schema (Optional[dict]): The input schema for the tool, if available.
+    """
+    name: str = Field(..., description="Name of the tool")
+    description: str = Field(..., description="Description of the tool's functionality")
+    input_schema: Optional[dict] = Field(None, description="Input schema for the tool, if available")
+
+    # def __repr__(self):
+    #   return f"SimpleTool(name='{self.name}', description='{self.description}', input_schema={self.input_schema})"
+
+    class Config:
+        """Pydantic model configuration."""
+        schema_extra = {
+            "example": {
+                "name": "example_tool",
+                "description": "An example tool for demonstration",
+                "input_schema": {
+                    "type": "object",
+                    "properties": {
+                        "input": {"type": "string"}
+                    }
+                }
+            }
+        }

tests/test_simpletool.py

@@ -140,7 +140,7 @@ def test_simpletool_repr():
     tool = TestSimpleTool()
     repr_str = repr(tool)
 
-    assert repr_str == "SimpleTool(name='TestTool', description=A tool for testing)"
+    assert repr_str == "TestSimpleTool(name='TestTool', description='A tool for testing', input_schema={'properties': {'test_field': {'type': 'string'}}, 'required': ['test_field'], 'type': 'object'})"
 
 
 def test_simpletool_async_context_manager():

tool_example.py

@@ -39,14 +39,17 @@ async def main(t: str):
 print(f"Type: {type(str(my_tool))}")
 print(str(my_tool))
 
-print("\nTool Details - my_tool.info:")
+print("\nTool Details Print - my_tool.info:")
 print(f"Type: {type(my_tool.info)}")
 print(my_tool.info)
 
-print("\nDictionary Representation - my_tool.to_dict:")
+print("\nDictionary - my_tool.to_dict:")
 print(f"Type: {type(my_tool.to_dict)}")
 print(my_tool.to_dict)
 
+print("\nRepresentation - my_tool.__repr__():")
+print(f"Type: {type(repr(my_tool))}")
+print(repr(my_tool))
 
 print("----------------------------------------------------------------------")
 # Demonstrate in/out - model/schema