glchat-plugin 0.2.0__py3-none-any.whl

glchat_plugin/tools/decorators.py

@@ -0,0 +1,115 @@
+"""Tool Plugin Decorators for External Use.
+
+This module provides utilities for marking and preparing tool plugins using a decorator-based approach.
+The decorators and utilities can be used independently in external repositories, as they only add
+metadata to tool classes without creating any connections to a plugin registration system.
+
+Authors:
+    Raymond Christopher (raymond.christopher@gdplabs.id)
+    Christian Trisno Sen Long Chen (christian.t.s.l.chen@gdplabs.id)
+"""
+
+import inspect
+from typing import Any, Callable, Type
+
+from gllm_core.utils import LoggerManager
+from langchain_core.tools import BaseTool
+
+logger = LoggerManager().get_logger()
+
+
+def tool_plugin(
+    version: str = "1.0.0",
+) -> Callable[[Type[BaseTool]], Type[BaseTool]]:
+    """Decorator to mark a BaseTool class as a tool plugin.
+
+    This decorator adds metadata to the tool class that will be used by the
+    plugin system when the tool is loaded. It doesn't directly register
+    the tool with any system, allowing for use in external repositories.
+    The actual tool name and description are intended to be retrieved
+    from the tool instance at runtime.
+
+    Args:
+        version (str): Version of the plugin. Defaults to "1.0.0".
+
+    Returns:
+        Callable[[Type[BaseTool]], Type[BaseTool]]: A decorator function that wraps the tool class.
+
+    Example:
+        ```python
+        @tool_plugin(version="1.0.0")
+        class MyAwesomeTool(BaseTool):
+            name = "my_awesome_tool"
+            description = "Does something awesome"
+
+            def _run(self, **kwargs):
+                return "Awesome result!"
+        ```
+    """
+
+    def decorator(tool_class: Type[BaseTool]) -> Type[BaseTool]:
+        """Marks a BaseTool class as a plugin by adding metadata for discovery.
+
+        This decorator adds plugin metadata to the tool class and marks it for later discovery.
+        It validates that the decorated class is a subclass of BaseTool.
+
+        Args:
+            tool_class (Type[BaseTool]): The BaseTool class to be decorated with plugin metadata.
+
+        Returns:
+            Type[BaseTool]: The decorated BaseTool class with added plugin metadata.
+        """
+        if not issubclass(tool_class, BaseTool):
+            raise TypeError(f"{tool_class.__name__} is not a subclass of BaseTool")
+
+        # Store basic plugin metadata as class attributes for later discovery
+        tool_class._plugin_metadata = {
+            "version": version,
+            "tool_class": tool_class.__name__,
+            "module": tool_class.__module__,
+        }
+
+        # Mark the class as a decorated tool plugin for easy discovery
+        tool_class._is_tool_plugin = True
+
+        # Log the preparation (but don't require any specific logger)
+        try:
+            # Simplified logging message
+            logger.info(f"Marked tool class {tool_class.__name__} as plugin with version {version}")
+        except Exception:
+            # Ignore logging errors in standalone mode
+            pass
+
+        return tool_class
+
+    return decorator
+
+
+def is_tool_plugin(obj: Any) -> bool:
+    """Check if an object is a tool plugin.
+
+    Args:
+        obj (Any): The object to check.
+
+    Returns:
+        bool: True if the object is a decorated tool plugin, False otherwise.
+    """
+    return inspect.isclass(obj) and getattr(obj, "_is_tool_plugin", False) is True
+
+
+def get_plugin_metadata(tool_class: Type[BaseTool]) -> dict[str, Any]:
+    """Get the plugin metadata from a decorated tool class.
+
+    Args:
+        tool_class (Type[BaseTool]): The tool class to get metadata from.
+
+    Returns:
+        dict[str, Any]: A dictionary of plugin metadata.
+
+    Raises:
+        ValueError: If the tool class is not a decorated tool plugin.
+    """
+    if not is_tool_plugin(tool_class):
+        raise ValueError(f"{tool_class.__name__} is not a decorated tool plugin")
+
+    return getattr(tool_class, "_plugin_metadata", {})

glchat_plugin-0.2.0.dist-info/METADATA

@@ -0,0 +1,62 @@
+Metadata-Version: 2.4
+Name: glchat-plugin
+Version: 0.2.0
+Author-email: GenAI SDK Team <gat-sdk@gdplabs.id>
+Requires-Python: <3.13,>=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: poetry>=2.1.3
+Requires-Dist: bosa-core-binary>=0.5.0
+Requires-Dist: gllm-core-binary>=0.3.0
+Requires-Dist: gllm-inference-binary>=0.4.0
+Requires-Dist: gllm-pipeline-binary>=0.4.0
+Requires-Dist: langchain>=0.3.0
+Requires-Dist: langchain-core>=0.3.0
+Requires-Dist: semver>=3.0.4
+Provides-Extra: flair
+Requires-Dist: flair; extra == "flair"
+Provides-Extra: dev
+Requires-Dist: coverage>=7.4.4; extra == "dev"
+Requires-Dist: mypy>=1.15.0; extra == "dev"
+Requires-Dist: pre-commit>=3.7.0; extra == "dev"
+Requires-Dist: pytest>=8.1.1; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23.6; extra == "dev"
+Requires-Dist: pytest-cov>=5.0.0; extra == "dev"
+Requires-Dist: ruff>=0.6.7; extra == "dev"
+
+# GDP Labs GenAI Plugin
+
+## Description
+
+A library to implement Plugin architecture and integrate with existing pipelines.
+
+## Installation
+
+### Prerequisites
+- Python 3.11+ - [Install here](https://www.python.org/downloads/)
+- Pip (if using Pip) - [Install here](https://pip.pypa.io/en/stable/installation/)
+- Poetry 1.8.1+ (if using Poetry) - [Install here](https://python-poetry.org/docs/#installation)
+- Git (if using Git) - [Install here](https://git-scm.com/downloads)
+- For git installation:
+  - Access to the [GDP Labs SDK github repository](https://github.com/GDP-ADMIN/glchat-sdk)
+
+### 1. Installation from Pypi
+Choose one of the following methods to install the package:
+
+#### Using pip
+```bash
+pip install glchat-plugin-binary
+```
+
+#### Using Poetry
+```bash
+poetry add glchat-plugin-binary
+```
+
+### 2. Development Installation (Git)
+For development purposes, you can install directly from the Git repository:
+```bash
+poetry add "git+ssh://git@github.com/GDP-ADMIN/glchat-sdk.git#subdirectory=python/glchat-plugin"
+```
+
+## Usage
+For more information, please refer to the [PIPELINE.md](https://github.com/GDP-ADMIN/glchat-sdk/blob/main/python/glchat-plugin/PIPELINE.md).

glchat_plugin-0.2.0.dist-info/RECORD

@@ -0,0 +1,19 @@
+glchat_plugin/__init__.py,sha256=SHSBMz7JDU6MecyIrhHu5-3NVs89JkXhyvD3ZGOkWOE,37
+glchat_plugin/config/__init__.py,sha256=DNnX8B_TvAN89oyMgq32zG1DeaezODrihiAXTwOPT5o,39
+glchat_plugin/config/app_config.py,sha256=9_ShYtaQ7Rp14sSkrIFLoOAMlbwVlm13EuCxzOn4NCI,426
+glchat_plugin/config/constant.py,sha256=hdTXG5mIULV86DepClE97VGhn9E-HtsjZ9PyLKKEdmc,689
+glchat_plugin/pipeline/__init__.py,sha256=Sk-NfIGyA9VKIg0Bt5OHatNUYyWVPh9i5xhE5DFAfbo,41
+glchat_plugin/pipeline/base_pipeline_preset_config.py,sha256=2DxJlroZ_tvVO6DYo1R07cjhWgKQJpysw1GsJ3BNRnw,1100
+glchat_plugin/pipeline/pipeline_handler.py,sha256=vDvIPI7Y39K_DI3jvQZsXC9YzQLUI4TuC-boyasdey8,24405
+glchat_plugin/pipeline/pipeline_plugin.py,sha256=1i7w7WepM5gON4Kx10SjL7NV7-SYVAmRE1EW2m_dOYg,4028
+glchat_plugin/service/__init__.py,sha256=eVyDgTcbOG0slfGT2GSUnUM9MHC2Wh3aU6fcLV_JHs4,45
+glchat_plugin/service/base_user_service.py,sha256=agpziGm7ua2wIv-rrrnTOiYlyUjp6L6dArWY2q0m63g,2178
+glchat_plugin/storage/__init__.py,sha256=VNO7ua2yAOLzXwe6H6zDZz9yXbhQfKqNJzxE3G8IyfA,50
+glchat_plugin/storage/base_anonymizer_storage.py,sha256=oFwovWrsjM7v1YjeN-4p-M3OGnAeo_Y7-9xqlToI180,1969
+glchat_plugin/storage/base_chat_history_storage.py,sha256=JvUUFMu_9jRBQ9yug_x7S4rQjZEA1vM5ombDvz-7zCE,11095
+glchat_plugin/tools/__init__.py,sha256=OFotHbgQ8mZEbdlvlv5aVMdxfubPvkVWAcTwhIPdIqQ,542
+glchat_plugin/tools/decorators.py,sha256=AvQBV18wzXWdC483RSSmpfh92zsqTyp8SzDLIkreIGU,3925
+glchat_plugin-0.2.0.dist-info/METADATA,sha256=Vhjz_PklkL2HzLFrJBi27NPAox_4ytlLDX137ltMKLg,2063
+glchat_plugin-0.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+glchat_plugin-0.2.0.dist-info/top_level.txt,sha256=fzKSXmct5dY4CAKku4-mkdHX-QPAyQVvo8vpQj8qizY,14
+glchat_plugin-0.2.0.dist-info/RECORD,,

glchat_plugin-0.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

glchat_plugin-0.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+glchat_plugin