gopher-mcp-python 0.1.1__tar.gz

gopher_mcp_python-0.1.1/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.

gopher_mcp_python-0.1.1/PKG-INFO

@@ -0,0 +1,269 @@
+Metadata-Version: 2.4
+Name: gopher-mcp-python
+Version: 0.1.1
+Summary: Python SDK for Gopher MCP - AI Agent orchestration framework with native performance
+Author-email: Gopher Security <dev@gophersecurity.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/GopherSecurity/gopher-mcp-python
+Project-URL: Repository, https://github.com/GopherSecurity/gopher-mcp-python.git
+Project-URL: Issues, https://github.com/GopherSecurity/gopher-mcp-python/issues
+Keywords: gopher,mcp,ai,agent,orchestration,llm,ffi
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: black>=24.0.0; extra == "dev"
+Requires-Dist: ruff>=0.3.0; extra == "dev"
+Provides-Extra: darwin-arm64
+Requires-Dist: gopher-mcp-python-native-darwin-arm64>=0.1.0; extra == "darwin-arm64"
+Provides-Extra: darwin-x64
+Requires-Dist: gopher-mcp-python-native-darwin-x64>=0.1.0; extra == "darwin-x64"
+Provides-Extra: linux-arm64
+Requires-Dist: gopher-mcp-python-native-linux-arm64>=0.1.0; extra == "linux-arm64"
+Provides-Extra: linux-x64
+Requires-Dist: gopher-mcp-python-native-linux-x64>=0.1.0; extra == "linux-x64"
+Provides-Extra: win32-arm64
+Requires-Dist: gopher-mcp-python-native-win32-arm64>=0.1.0; extra == "win32-arm64"
+Provides-Extra: win32-x64
+Requires-Dist: gopher-mcp-python-native-win32-x64>=0.1.0; extra == "win32-x64"
+Dynamic: license-file
+
+# gopher-mcp-python Python SDK
+
+Python SDK for gopher-mcp-python, providing AI agent orchestration with native C++ performance through ctypes FFI bindings.
+
+## Features
+
+- Python 3.8+ compatibility
+- pip/setuptools build system
+- ctypes FFI bindings to native library
+- GopherAgent class with builder pattern configuration
+- Context manager support for automatic resource cleanup
+- Typed errors (AgentError, ApiKeyError, ConnectionError, TimeoutError)
+- Comprehensive test suite with pytest
+
+## Requirements
+
+- Python 3.8 or higher
+- Native gopher-mcp-python library (built from source)
+
+## Installation
+
+### From Source
+
+1. Clone the repository:
+```bash
+git clone https://github.com/GopherSecurity/gopher-mcp-python.git
+cd gopher-mcp-python
+```
+
+2. Build the native library:
+```bash
+./build.sh
+```
+
+3. Install the Python package:
+```bash
+pip install -e .
+```
+
+## Quick Start
+
+### Using API Key
+
+```python
+from gopher_mcp_python import GopherAgent, GopherAgentConfig
+
+# Create configuration with API key
+config = (GopherAgentConfig.builder()
+    .provider("AnthropicProvider")
+    .model("claude-3-haiku-20240307")
+    .api_key("your-api-key")
+    .build())
+
+# Create and use agent with context manager
+with GopherAgent.create(config) as agent:
+    response = agent.run("What time is it in Tokyo?")
+    print(response)
+```
+
+### Using JSON Server Configuration
+
+```python
+from gopher_mcp_python import GopherAgent, GopherAgentConfig
+
+# Create configuration with server config
+config = (GopherAgentConfig.builder()
+    .provider("AnthropicProvider")
+    .model("claude-3-haiku-20240307")
+    .server_config('{"mcpServers": [...]}')
+    .build())
+
+# Create agent
+agent = GopherAgent.create(config)
+try:
+    response = agent.run("What is the weather?")
+    print(response)
+finally:
+    agent.dispose()
+```
+
+### Using Convenience Methods
+
+```python
+from gopher_mcp_python import GopherAgent
+
+# Create with API key (shorthand)
+agent = GopherAgent.create_with_api_key(
+    provider="AnthropicProvider",
+    model="claude-3-haiku-20240307",
+    api_key="your-api-key"
+)
+
+# Or with server config
+agent = GopherAgent.create_with_server_config(
+    provider="AnthropicProvider",
+    model="claude-3-haiku-20240307",
+    server_config='{"mcpServers": [...]}'
+)
+```
+
+### Getting Detailed Results
+
+```python
+from gopher_mcp_python import GopherAgent
+
+with GopherAgent.create(config) as agent:
+    result = agent.run_detailed("What time is it?")
+
+    if result.is_success():
+        print(f"Response: {result.response}")
+        print(f"Iterations: {result.iteration_count}")
+        print(f"Tokens used: {result.tokens_used}")
+    elif result.is_timeout():
+        print(f"Request timed out: {result.error_message}")
+    else:
+        print(f"Error: {result.error_message}")
+```
+
+## API Reference
+
+### GopherAgent
+
+Main class for interacting with the gopher-mcp-python native library.
+
+#### Static Methods
+
+- `GopherAgent.init()` - Initialize the library (called automatically)
+- `GopherAgent.shutdown()` - Shutdown the library
+- `GopherAgent.is_initialized()` - Check if library is initialized
+- `GopherAgent.create(config)` - Create an agent with configuration
+- `GopherAgent.create_with_api_key(provider, model, api_key)` - Convenience method
+- `GopherAgent.create_with_server_config(provider, model, server_config)` - Convenience method
+
+#### Instance Methods
+
+- `agent.run(query, timeout_ms=60000)` - Run a query and get response string
+- `agent.run_detailed(query, timeout_ms=60000)` - Run a query and get AgentResult
+- `agent.dispose()` - Release resources
+- `agent.is_disposed()` - Check if agent is disposed
+
+### GopherAgentConfig
+
+Configuration class with builder pattern.
+
+```python
+config = (GopherAgentConfig.builder()
+    .provider("AnthropicProvider")  # Required
+    .model("claude-3-haiku-20240307")  # Required
+    .api_key("key")  # Either api_key or server_config required
+    .server_config("{...}")  # Either api_key or server_config required
+    .build())
+```
+
+### AgentResult
+
+Result class with status and metadata.
+
+- `result.response` - Response text
+- `result.status` - AgentResultStatus enum
+- `result.iteration_count` - Number of iterations
+- `result.tokens_used` - Tokens consumed
+- `result.error_message` - Error message (if applicable)
+- `result.is_success()` - Check if successful
+- `result.is_error()` - Check if error
+- `result.is_timeout()` - Check if timeout
+
+### Exceptions
+
+- `AgentError` - Base exception for agent errors
+- `ApiKeyError` - Invalid API key
+- `ConnectionError` - Connection failed
+- `TimeoutError` - Operation timed out
+
+## Development
+
+### Running Tests
+
+```bash
+pytest
+```
+
+### Code Formatting
+
+This project uses Black for code formatting and Ruff for linting.
+
+Format code:
+```bash
+black .
+```
+
+Check formatting without modifying:
+```bash
+black --check .
+```
+
+Run linter:
+```bash
+ruff check .
+```
+
+Fix linting issues:
+```bash
+ruff check --fix .
+```
+
+### Building the Native Library
+
+```bash
+./build.sh
+```
+
+### Clean Build
+
+```bash
+./build.sh --clean
+```
+
+## Environment Variables
+
+- `GOPHER_MCP_PYTHON_LIBRARY_PATH` - Custom path to native library
+- `DEBUG` - Enable debug output for library loading
+
+## License
+
+See LICENSE file for details.

gopher_mcp_python-0.1.1/README.md

@@ -0,0 +1,225 @@
+# gopher-mcp-python Python SDK
+
+Python SDK for gopher-mcp-python, providing AI agent orchestration with native C++ performance through ctypes FFI bindings.
+
+## Features
+
+- Python 3.8+ compatibility
+- pip/setuptools build system
+- ctypes FFI bindings to native library
+- GopherAgent class with builder pattern configuration
+- Context manager support for automatic resource cleanup
+- Typed errors (AgentError, ApiKeyError, ConnectionError, TimeoutError)
+- Comprehensive test suite with pytest
+
+## Requirements
+
+- Python 3.8 or higher
+- Native gopher-mcp-python library (built from source)
+
+## Installation
+
+### From Source
+
+1. Clone the repository:
+```bash
+git clone https://github.com/GopherSecurity/gopher-mcp-python.git
+cd gopher-mcp-python
+```
+
+2. Build the native library:
+```bash
+./build.sh
+```
+
+3. Install the Python package:
+```bash
+pip install -e .
+```
+
+## Quick Start
+
+### Using API Key
+
+```python
+from gopher_mcp_python import GopherAgent, GopherAgentConfig
+
+# Create configuration with API key
+config = (GopherAgentConfig.builder()
+    .provider("AnthropicProvider")
+    .model("claude-3-haiku-20240307")
+    .api_key("your-api-key")
+    .build())
+
+# Create and use agent with context manager
+with GopherAgent.create(config) as agent:
+    response = agent.run("What time is it in Tokyo?")
+    print(response)
+```
+
+### Using JSON Server Configuration
+
+```python
+from gopher_mcp_python import GopherAgent, GopherAgentConfig
+
+# Create configuration with server config
+config = (GopherAgentConfig.builder()
+    .provider("AnthropicProvider")
+    .model("claude-3-haiku-20240307")
+    .server_config('{"mcpServers": [...]}')
+    .build())
+
+# Create agent
+agent = GopherAgent.create(config)
+try:
+    response = agent.run("What is the weather?")
+    print(response)
+finally:
+    agent.dispose()
+```
+
+### Using Convenience Methods
+
+```python
+from gopher_mcp_python import GopherAgent
+
+# Create with API key (shorthand)
+agent = GopherAgent.create_with_api_key(
+    provider="AnthropicProvider",
+    model="claude-3-haiku-20240307",
+    api_key="your-api-key"
+)
+
+# Or with server config
+agent = GopherAgent.create_with_server_config(
+    provider="AnthropicProvider",
+    model="claude-3-haiku-20240307",
+    server_config='{"mcpServers": [...]}'
+)
+```
+
+### Getting Detailed Results
+
+```python
+from gopher_mcp_python import GopherAgent
+
+with GopherAgent.create(config) as agent:
+    result = agent.run_detailed("What time is it?")
+
+    if result.is_success():
+        print(f"Response: {result.response}")
+        print(f"Iterations: {result.iteration_count}")
+        print(f"Tokens used: {result.tokens_used}")
+    elif result.is_timeout():
+        print(f"Request timed out: {result.error_message}")
+    else:
+        print(f"Error: {result.error_message}")
+```
+
+## API Reference
+
+### GopherAgent
+
+Main class for interacting with the gopher-mcp-python native library.
+
+#### Static Methods
+
+- `GopherAgent.init()` - Initialize the library (called automatically)
+- `GopherAgent.shutdown()` - Shutdown the library
+- `GopherAgent.is_initialized()` - Check if library is initialized
+- `GopherAgent.create(config)` - Create an agent with configuration
+- `GopherAgent.create_with_api_key(provider, model, api_key)` - Convenience method
+- `GopherAgent.create_with_server_config(provider, model, server_config)` - Convenience method
+
+#### Instance Methods
+
+- `agent.run(query, timeout_ms=60000)` - Run a query and get response string
+- `agent.run_detailed(query, timeout_ms=60000)` - Run a query and get AgentResult
+- `agent.dispose()` - Release resources
+- `agent.is_disposed()` - Check if agent is disposed
+
+### GopherAgentConfig
+
+Configuration class with builder pattern.
+
+```python
+config = (GopherAgentConfig.builder()
+    .provider("AnthropicProvider")  # Required
+    .model("claude-3-haiku-20240307")  # Required
+    .api_key("key")  # Either api_key or server_config required
+    .server_config("{...}")  # Either api_key or server_config required
+    .build())
+```
+
+### AgentResult
+
+Result class with status and metadata.
+
+- `result.response` - Response text
+- `result.status` - AgentResultStatus enum
+- `result.iteration_count` - Number of iterations
+- `result.tokens_used` - Tokens consumed
+- `result.error_message` - Error message (if applicable)
+- `result.is_success()` - Check if successful
+- `result.is_error()` - Check if error
+- `result.is_timeout()` - Check if timeout
+
+### Exceptions
+
+- `AgentError` - Base exception for agent errors
+- `ApiKeyError` - Invalid API key
+- `ConnectionError` - Connection failed
+- `TimeoutError` - Operation timed out
+
+## Development
+
+### Running Tests
+
+```bash
+pytest
+```
+
+### Code Formatting
+
+This project uses Black for code formatting and Ruff for linting.
+
+Format code:
+```bash
+black .
+```
+
+Check formatting without modifying:
+```bash
+black --check .
+```
+
+Run linter:
+```bash
+ruff check .
+```
+
+Fix linting issues:
+```bash
+ruff check --fix .
+```
+
+### Building the Native Library
+
+```bash
+./build.sh
+```
+
+### Clean Build
+
+```bash
+./build.sh --clean
+```
+
+## Environment Variables
+
+- `GOPHER_MCP_PYTHON_LIBRARY_PATH` - Custom path to native library
+- `DEBUG` - Enable debug output for library loading
+
+## License
+
+See LICENSE file for details.