gofannon 0.1.0__tar.gz

gofannon-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

gofannon-0.1.0/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.1
+Name: gofannon
+Version: 0.1.0
+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
+Requires-Dist: GitPython (>=3.1.43,<4.0.0)
+Requires-Dist: langchain (>=0.3.16,<0.4.0)
+Requires-Dist: openai (>=1.60.2,<2.0.0)
+Requires-Dist: pydantic (>=2.10.6,<3.0.0)
+Requires-Dist: pytest (>=8.3.4,<9.0.0)
+Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
+Requires-Dist: requests (>=2.32.3,<3.0.0)
+Requires-Dist: smolagents (>=1.6.0,<2.0.0)
+Description-Content-Type: text/markdown
+
+![gofannon logo](./gofannon.jpg)  
+  
+# 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`](./why_the_name_gofannon.md) for the rich story on why we chose to honor this Celtic Diety
+
+## 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](./ROADMAP.md).  
+
+## Documentation
+
+Documentation can be found [here](./docs).
+
+## 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](./CONTRIBUTING.md) guide for detailed instructions on how to get started.  
+  
+## Documentation  
+  
+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/your-repo/gofannon.git  
+cd gofannon  
+pip install -r requirements.txt
+```
+
+or 
+
+```
+pip install git+https://github.com/your-repo/gofannon.git
+```
+
+## License  
+  
+This project is licensed under the ASFv2 License. See the [LICENSE](./LICENSE) file for more details.  
+  
+## 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.1.0/README.md

@@ -0,0 +1,61 @@
+![gofannon logo](./gofannon.jpg)  
+  
+# 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`](./why_the_name_gofannon.md) for the rich story on why we chose to honor this Celtic Diety
+
+## 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](./ROADMAP.md).  
+
+## Documentation
+
+Documentation can be found [here](./docs).
+
+## 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](./CONTRIBUTING.md) guide for detailed instructions on how to get started.  
+  
+## Documentation  
+  
+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/your-repo/gofannon.git  
+cd gofannon  
+pip install -r requirements.txt
+```
+
+or 
+
+```
+pip install git+https://github.com/your-repo/gofannon.git
+```
+
+## License  
+  
+This project is licensed under the ASFv2 License. See the [LICENSE](./LICENSE) file for more details.  
+  
+## 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.1.0/gofannon/arxiv/__init__.py

@@ -0,0 +1,2 @@
+from.search import Search
+from.get_article import GetArticle  

gofannon-0.1.0/gofannon/arxiv/get_article.py

@@ -0,0 +1,41 @@
+from..base import BaseTool
+import requests
+from ..config import FunctionRegistry
+import logging
+
+logger = logging.getLogger(__name__)
+
+@FunctionRegistry.register
+class GetArticle(BaseTool):
+    def __init__(self, name="get_article"):
+        super().__init__()
+        self.name = name
+
+    @property
+    def definition(self):
+        return {
+            "type": "function",
+            "function": {
+                "name": self.name,
+                "description": "Get a specific article from arXiv",
+                "parameters": {
+                    "type": "object",
+                    "properties": {
+                        "id": {
+                            "type": "string",
+                            "description": "The ID of the article"
+                        }
+                    },
+                    "required": ["id"]
+                }
+            }
+        }
+
+    def fn(self, id):
+        logger.debug("Fetching Article '%s' from ArXiv", id)
+        base_url = "http://export.arxiv.org/api/query"
+        params = {
+            "id_list": id
+        }
+        response = requests.get(base_url, params=params)
+        return response.text  

gofannon-0.1.0/gofannon/arxiv/search.py

@@ -0,0 +1,115 @@
+
+from..base import BaseTool
+import requests
+from ..config import FunctionRegistry
+import logging
+
+logger = logging.getLogger(__name__)
+
+@FunctionRegistry.register
+class Search(BaseTool):
+    def __init__(self, name="search"):
+        super().__init__()
+        self.name = name
+
+    @property
+    def definition(self):
+        return {
+            "type": "function",
+            "function": {
+                "name": self.name,
+                "description": "Search for articles on arXiv",
+                "parameters": {
+                    "type": "object",
+                    "properties": {
+                        "query": {
+                            "type": "string",
+                            "description": "The search query"
+                        },
+                        "start": {
+                            "type": "integer",
+                            "description": "The start index of the search results"
+                        },
+                        "max_results": {
+                            "type": "integer",
+                            "description": "The maximum number of search results to return"
+                        },
+                        "submittedDateFrom": {
+                            "type": "string",
+                            "description": "The start submission date in the format YYYYMMDD"
+                        },
+                        "submittedDateTo": {
+                            "type": "string",
+                            "description": "The end submission date in the format YYYYMMDD"
+                        },
+                        "ti": {
+                            "type": "string",
+                            "description": "Search in title"
+                        },
+                        "au": {
+                            "type": "string",
+                            "description": "Search in author"
+                        },
+                        "abs": {
+                            "type": "string",
+                            "description": "Search in abstract"
+                        },
+                        "co": {
+                            "type": "string",
+                            "description": "Search in comment"
+                        },
+                        "jr": {
+                            "type": "string",
+                            "description": "Search in journal reference"
+                        },
+                        "cat": {
+                            "type": "string",
+                            "description": "Search in subject category"
+                        }
+                    },
+                    "required": ["query"]
+                }
+            }
+        }
+
+    def _format_date(self, date):
+        if len(date) == 8:
+            return f"{date}0000"
+        return date
+
+    def fn(self, query, start=0, max_results=10, submittedDateFrom=None, submittedDateTo=None, ti=None, au=None, abs=None, co=None, jr=None, cat=None):
+        logger.debug("Querying ArXiv for '%s'", query)
+        base_url = "http://export.arxiv.org/api/query"
+        params = {
+            "search_query": query,
+            "start": start,
+            "max_results": max_results
+        }
+
+        if submittedDateFrom and submittedDateTo:
+            params["search_query"] += f" AND submittedDate:[{self._format_date(submittedDateFrom)}0000 TO {self._format_date(submittedDateTo)}0000]"
+        elif submittedDateFrom:
+            params["search_query"] += f" AND submittedDate:[{self._format_date(submittedDateFrom)}0000 TO *]"
+        elif submittedDateTo:
+            params["search_query"] += f" AND submittedDate:[* TO {self._format_date(submittedDateTo)}0000]"
+
+        if ti:
+            params["search_query"] += f" AND ti:{ti}"
+
+        if au:
+            params["search_query"] += f" AND au:{au}"
+
+        if abs:
+            params["search_query"] += f" AND abs:{abs}"
+
+        if co:
+            params["search_query"] += f" AND co:{co}"
+
+        if jr:
+            params["search_query"] += f" AND jr:{jr}"
+
+        if cat:
+            params["search_query"] += f" AND cat:{cat}"
+
+        response = requests.get(base_url, params=params)
+        return response.text