gofannon 0.1.0__tar.gz → 0.25.11__tar.gz

gofannon-0.25.11/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.3
+Name: gofannon
+Version: 0.25.11
+Summary: A collection of tools for LLMs
+License: ASFv2
+Author: Trevor Grant
+Author-email: trevor.d.grant@gmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Provides-Extra: aws
+Provides-Extra: google
+Provides-Extra: headless-browser
+Provides-Extra: langchain
+Provides-Extra: smolagents
+Provides-Extra: testing
+Requires-Dist: GitPython (>=3.1.43,<4.0.0)
+Requires-Dist: boto3 (>=1.34.97,<2.0.0) ; extra == "aws"
+Requires-Dist: google-api-python-client (>=2.161.0,<3.0.0) ; extra == "google"
+Requires-Dist: jsonschema (>=4.23.0,<5.0.0)
+Requires-Dist: langchain (>=0.3.16,<0.4.0) ; extra == "langchain"
+Requires-Dist: openai (>=1.60.2,<2.0.0)
+Requires-Dist: pydantic (>=2.10.6,<3.0.0) ; extra == "langchain"
+Requires-Dist: pygithub (>=2.6.1,<3.0.0)
+Requires-Dist: pytest (>=8.3.4,<9.0.0) ; extra == "testing"
+Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
+Requires-Dist: requests (>=2.32.3,<3.0.0)
+Requires-Dist: requests-mock (>=1.12.1,<2.0.0) ; extra == "testing"
+Requires-Dist: selenium (>=4.10.0,<5.0.0) ; extra == "headless-browser"
+Requires-Dist: smolagents (>=1.6.0,<2.0.0) ; extra == "smolagents"
+Description-Content-Type: text/markdown
+
+![gofannon logo](https://github.com/The-AI-Alliance/gofannon/blob/main/gofannon.jpg)  
+<!-- ![CI](https://github.com/The-AI-Alliance/gofannon/actions/workflows/main.yml/badge.svg) -->
+![PyPI](https://img.shields.io/pypi/v/gofannon)
+![License](https://img.shields.io/github/license/The-AI-Alliance/gofannon)
+![Issues](https://img.shields.io/github/issues/The-AI-Alliance/gofannon)
+![GitHub stars](https://img.shields.io/github/stars/The-AI-Alliance/gofannon?style=social)
+  
+# gofannon  
+  
+**gofannon** is a collection of tools designed to enhance the capabilities of function-calling-enabled language models. These tools provide additional functionality for various tasks, including mathematical operations, GitHub interactions, arXiv searches, and advanced reasoning techniques.  
+
+## Why the name `gofanon` ?
+
+See [`why_the_name_gofannon.md`](https://github.com/The-AI-Alliance/gofannon/blob/main/why_the_name_gofannon.md) for the rich story on why we chose to honor this Celtic Diety
+
+## Our Mission
+
+We aim to achieve:
+
+### Cross-Framework Compatibility
+We solve the "vendor lock-in" problem in AI tooling through:
+- Standardized interface definitions
+- Automatic schema translation
+- Bidirectional conversion tools
+
+### Open Source Education
+We make AI development accessible by:
+- Curated contribution pathways
+- Interactive documentation
+- Pair programming sessions
+- Weekly office hours
+
+### Encouraging First-Time Contributors
+We actively support new contributors through:
+- Beginner-friendly issues
+- Clear documentation and guides
+- Supportuve community engagement
+
+## Features  
+  
+- **Basic Math Operations**: Perform addition, subtraction, multiplication, division, and exponentiation.  
+- **GitHub Integration**: Interact with GitHub repositories, including creating issues, committing files, and retrieving repository contents.  
+- **arXiv Search**: Search for and retrieve articles from arXiv.  
+- **Advanced Reasoning**: Utilize Chain-of-Thought (CoT) and Tree-of-Thought (ToT) reasoning techniques for complex problem-solving.  
+- **NHTSA Complaints**: Retrieve vehicle complaint data from the National Highway Traffic Safety Administration (NHTSA).  
+  
+## Roadmap  
+  
+For a detailed overview of planned features and their current status, please refer to the [ROADMAP](https://github.com/The-AI-Alliance/gofannon/blob/main/ROADMAP.md).   
+
+## Documentation
+
+Documentation can be found [here](https://github.com/The-AI-Alliance/gofannon/tree/main/docs).Each tool comes with its own documentation, which can be found in the docs/ directory. The documentation provides detailed information on how to use each tool, including required parameters and example usage.
+
+## Installation  
+  
+To install gofannon, simply clone the repository and install the required dependencies:  
+  
+```bash  
+git clone https://github.com/The-AI-Alliance/gofannon.git  
+cd gofannon  
+pip install -r requirements.txt
+```
+
+or 
+
+```
+pip install git+https://github.com/The-AI-Alliance/gofannon.git
+# OR
+pip install gofannon
+```
+
+## Communication Channels
+- **Discord** [Join our Discord server](https://discord.gg/2MMCVs76Sr)for eal-time collaboration and support
+- **GitHub Discussions**: Explore our [GitHub organization](https://github.com/The-AI-Alliance/agents-wg/discussions/) for all related projects
+- **Community Calls**: [Join our bi-weekly video meetings](https://calendar.app.google/c4eKW4zrNiXaue926)
+
+## Usage Example
+```bash
+from gofannon.base import BaseTool  
+  
+class NewTool(BaseTool):  
+    def __init__(self):  
+        super().__init__()  
+  
+    @property  
+    def definition(self):  
+        return {  
+            # Define your tool metadata and configuration  
+        }  
+  
+    def fn(self, *args, **kwargs):  
+        # Define your tool functionality  
+        pass  
+```
+
+## License  
+  
+This project is licensed under the ASFv2 License. See the [LICENSE](https://github.com/The-AI-Alliance/gofannon/blob/main/LICENSE) file for more details.
+
+## Contributing  
+  
+We welcome contributions from the community! If you'd like to add a new tool or improve an existing one, please check out our [CONTRIBUTING](https://github.com/The-AI-Alliance/gofannon/blob/main/CONTRIBUTING.md) guide for detailed instructions on how to get started.  
+  
+## Support  
+  
+If you encounter any issues or have questions, please open an issue on our [GitHub repository](https://github.com/your-repo/gofannon/issues).  
+  
+## Acknowledgments  
+  
+We would like to thank the open-source community for their contributions and support in making this project possible.  
+

gofannon-0.25.11/README.md

@@ -0,0 +1,111 @@
+![gofannon logo](https://github.com/The-AI-Alliance/gofannon/blob/main/gofannon.jpg)  
+<!-- ![CI](https://github.com/The-AI-Alliance/gofannon/actions/workflows/main.yml/badge.svg) -->
+![PyPI](https://img.shields.io/pypi/v/gofannon)
+![License](https://img.shields.io/github/license/The-AI-Alliance/gofannon)
+![Issues](https://img.shields.io/github/issues/The-AI-Alliance/gofannon)
+![GitHub stars](https://img.shields.io/github/stars/The-AI-Alliance/gofannon?style=social)
+  
+# gofannon  
+  
+**gofannon** is a collection of tools designed to enhance the capabilities of function-calling-enabled language models. These tools provide additional functionality for various tasks, including mathematical operations, GitHub interactions, arXiv searches, and advanced reasoning techniques.  
+
+## Why the name `gofanon` ?
+
+See [`why_the_name_gofannon.md`](https://github.com/The-AI-Alliance/gofannon/blob/main/why_the_name_gofannon.md) for the rich story on why we chose to honor this Celtic Diety
+
+## Our Mission
+
+We aim to achieve:
+
+### Cross-Framework Compatibility
+We solve the "vendor lock-in" problem in AI tooling through:
+- Standardized interface definitions
+- Automatic schema translation
+- Bidirectional conversion tools
+
+### Open Source Education
+We make AI development accessible by:
+- Curated contribution pathways
+- Interactive documentation
+- Pair programming sessions
+- Weekly office hours
+
+### Encouraging First-Time Contributors
+We actively support new contributors through:
+- Beginner-friendly issues
+- Clear documentation and guides
+- Supportuve community engagement
+
+## Features  
+  
+- **Basic Math Operations**: Perform addition, subtraction, multiplication, division, and exponentiation.  
+- **GitHub Integration**: Interact with GitHub repositories, including creating issues, committing files, and retrieving repository contents.  
+- **arXiv Search**: Search for and retrieve articles from arXiv.  
+- **Advanced Reasoning**: Utilize Chain-of-Thought (CoT) and Tree-of-Thought (ToT) reasoning techniques for complex problem-solving.  
+- **NHTSA Complaints**: Retrieve vehicle complaint data from the National Highway Traffic Safety Administration (NHTSA).  
+  
+## Roadmap  
+  
+For a detailed overview of planned features and their current status, please refer to the [ROADMAP](https://github.com/The-AI-Alliance/gofannon/blob/main/ROADMAP.md).   
+
+## Documentation
+
+Documentation can be found [here](https://github.com/The-AI-Alliance/gofannon/tree/main/docs).Each tool comes with its own documentation, which can be found in the docs/ directory. The documentation provides detailed information on how to use each tool, including required parameters and example usage.
+
+## Installation  
+  
+To install gofannon, simply clone the repository and install the required dependencies:  
+  
+```bash  
+git clone https://github.com/The-AI-Alliance/gofannon.git  
+cd gofannon  
+pip install -r requirements.txt
+```
+
+or 
+
+```
+pip install git+https://github.com/The-AI-Alliance/gofannon.git
+# OR
+pip install gofannon
+```
+
+## Communication Channels
+- **Discord** [Join our Discord server](https://discord.gg/2MMCVs76Sr)for eal-time collaboration and support
+- **GitHub Discussions**: Explore our [GitHub organization](https://github.com/The-AI-Alliance/agents-wg/discussions/) for all related projects
+- **Community Calls**: [Join our bi-weekly video meetings](https://calendar.app.google/c4eKW4zrNiXaue926)
+
+## Usage Example
+```bash
+from gofannon.base import BaseTool  
+  
+class NewTool(BaseTool):  
+    def __init__(self):  
+        super().__init__()  
+  
+    @property  
+    def definition(self):  
+        return {  
+            # Define your tool metadata and configuration  
+        }  
+  
+    def fn(self, *args, **kwargs):  
+        # Define your tool functionality  
+        pass  
+```
+
+## License  
+  
+This project is licensed under the ASFv2 License. See the [LICENSE](https://github.com/The-AI-Alliance/gofannon/blob/main/LICENSE) file for more details.
+
+## Contributing  
+  
+We welcome contributions from the community! If you'd like to add a new tool or improve an existing one, please check out our [CONTRIBUTING](https://github.com/The-AI-Alliance/gofannon/blob/main/CONTRIBUTING.md) guide for detailed instructions on how to get started.  
+  
+## Support  
+  
+If you encounter any issues or have questions, please open an issue on our [GitHub repository](https://github.com/your-repo/gofannon/issues).  
+  
+## Acknowledgments  
+  
+We would like to thank the open-source community for their contributions and support in making this project possible.  

gofannon-0.25.11/gofannon/base/__init__.py

@@ -0,0 +1,113 @@
+import time
+from abc import ABC, abstractmethod
+from dataclasses import dataclass
+from typing import Any, Callable
+import json
+import logging
+from pathlib import Path
+from ..config import ToolConfig
+
+from .smol_agents import SmolAgentsMixin
+from .langchain import LangchainMixin
+from .bedrock import BedrockMixin
+
+
+@dataclass
+class ToolResult:
+    success: bool
+    output: Any
+    error: str = None
+    retryable: bool = False
+
+
+class WorkflowContext:
+    def __init__(self, firebase_config=None):
+        self.data = {}
+        self.execution_log = []
+        self.firebase_config = firebase_config
+        self.local_storage = Path.home() / ".llama" / "checkpoints"
+        self.local_storage.mkdir(parents=True, exist_ok=True)
+
+    def save_checkpoint(self, name="checkpoint"):
+        if self.firebase_config:
+            self._save_to_firebase(name)
+        else:
+            self._save_local(name)
+
+    def _save_local(self, name):
+        path = self.local_storage / f"{name}.json"
+        with open(path, "w") as f:
+            json.dump({"data": self.data, "execution_log": self.execution_log}, f)
+
+    def _save_to_firebase(self, name):
+        from firebase_admin import firestore
+
+        db = firestore.client()
+        doc_ref = db.collection("checkpoints").document(name)
+        doc_ref.set(
+            {
+                "data": self.data,
+                "execution_log": self.execution_log,
+                "timestamp": firestore.SERVER_TIMESTAMP,
+            }
+        )
+
+    def log_execution(self, tool_name, duration, input_data, output_data):
+        entry = {
+            "tool": tool_name,
+            "duration": duration,
+            "input": input_data,
+            "output": output_data,
+        }
+        self.execution_log.append(entry)
+
+
+class BaseTool(SmolAgentsMixin, LangchainMixin, BedrockMixin, ABC):
+    def __init__(self, **kwargs):
+        self.logger = logging.getLogger(
+            f"{self.__class__.__module__}.{self.__class__.__name__}"
+        )
+        self._load_config()
+        self._configure(**kwargs)
+        self.logger.debug("Initialized %s tool", self.__class__.__name__)
+
+    def _configure(self, **kwargs):
+        """Set instance-specific configurations"""
+        for key, value in kwargs.items():
+            if hasattr(self, key):
+                setattr(self, key, value)
+
+    def _load_config(self):
+        """Auto-load config based on tool type"""
+        if hasattr(self, "API_SERVICE"):
+            self.api_key = ToolConfig.get(f"{self.API_SERVICE}_api_key")
+
+    @property
+    @abstractmethod
+    def definition(self):
+        pass
+
+    @property
+    def output_schema(self):
+        return self.definition.get("function", {}).get("parameters", {})
+
+    @abstractmethod
+    def fn(self, *args, **kwargs):
+        pass
+
+    def execute(self, context: WorkflowContext, **kwargs) -> ToolResult:
+        try:
+            start_time = time.time()
+            result = self.fn(**kwargs)
+            duration = time.time() - start_time
+
+            context.log_execution(
+                tool_name=self.__class__.__name__,
+                duration=duration,
+                input_data=kwargs,
+                output_data=result,
+            )
+
+            return ToolResult(success=True, output=result)
+        except Exception as e:
+            return ToolResult(success=False, output=None, error=str(e), retryable=True)