cnoe-agent-utils 0.1.0__tar.gz

cnoe_agent_utils-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.

cnoe_agent_utils-0.1.0/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.3
+Name: cnoe-agent-utils
+Version: 0.1.0
+Summary: 
+Author: Sri Aradhyula
+Author-email: sraradhy@cisco.com
+Requires-Python: >=3.13,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: dotenv (>=0.9.9,<0.10.0)
+Requires-Dist: langchain-anthropic (>=0.3.14)
+Requires-Dist: langchain-aws (>=0.2.24,<0.3.0)
+Requires-Dist: langchain-google-genai (>=2.1.5)
+Requires-Dist: langchain-google-vertexai (>=2.0.24)
+Requires-Dist: langchain-openai (>=0.3.18)
+Description-Content-Type: text/markdown
+
+# cnoe-agent-utils
+
+**cnoe-agent-utils** is an open-source Python library providing utility functions and abstractions for building agent-based systems, including LLM (Large Language Model) factories and integrations.
+
+## Features
+
+- LLM Factory for easy model instantiation across AWS, Azure, GCP Vertex, Google Gemini, Anthropic Claude, and OpenAI
+- Utilities for agent orchestration
+- Extensible and modular design
+
+## Getting Started
+
+### Create and Activate a Virtual Environment
+
+It is recommended to use a virtual environment to manage dependencies:
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+```
+
+### Installation
+
+```bash
+pip install cnoe-agent-utils
+```
+
+Or, if you are developing locally:
+
+```bash
+git clone https://github.com/cnoe-agent-utils/cnoe-agent-utils.git
+cd cnoe-agent-utils
+poetry build
+poetry install
+```
+
+## Usage
+
+Run the example script to test integration with AWS Bedrock Claude:
+
+```bash
+uv run examples/test_aws_bedrock_claude.py
+```
+
+This will demonstrate how to use the LLM Factory and other utilities provided by the library.
+
+---
+
+## 📜 License
+
+Apache 2.0 (see [LICENSE](./LICENSE))
+
+---
+
+## 👥 Maintainers
+
+See [MAINTAINERS.md](MAINTAINERS.md)
+
+- Contributions welcome via PR or issue!

cnoe_agent_utils-0.1.0/README.md

@@ -0,0 +1,59 @@
+# cnoe-agent-utils
+
+**cnoe-agent-utils** is an open-source Python library providing utility functions and abstractions for building agent-based systems, including LLM (Large Language Model) factories and integrations.
+
+## Features
+
+- LLM Factory for easy model instantiation across AWS, Azure, GCP Vertex, Google Gemini, Anthropic Claude, and OpenAI
+- Utilities for agent orchestration
+- Extensible and modular design
+
+## Getting Started
+
+### Create and Activate a Virtual Environment
+
+It is recommended to use a virtual environment to manage dependencies:
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+```
+
+### Installation
+
+```bash
+pip install cnoe-agent-utils
+```
+
+Or, if you are developing locally:
+
+```bash
+git clone https://github.com/cnoe-agent-utils/cnoe-agent-utils.git
+cd cnoe-agent-utils
+poetry build
+poetry install
+```
+
+## Usage
+
+Run the example script to test integration with AWS Bedrock Claude:
+
+```bash
+uv run examples/test_aws_bedrock_claude.py
+```
+
+This will demonstrate how to use the LLM Factory and other utilities provided by the library.
+
+---
+
+## 📜 License
+
+Apache 2.0 (see [LICENSE](./LICENSE))
+
+---
+
+## 👥 Maintainers
+
+See [MAINTAINERS.md](MAINTAINERS.md)
+
+- Contributions welcome via PR or issue!

cnoe_agent_utils-0.1.0/cnoe_agent_utils/__init__.py

@@ -0,0 +1,3 @@
+from .llm_factory import LLMFactory
+
+__all__ = ['LLMFactory']

cnoe_agent_utils-0.1.0/cnoe_agent_utils/llm_factory.py

@@ -0,0 +1,300 @@
+# Copyright 2025 CNOE
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+import logging
+import os
+from typing import Any, Iterable
+import dotenv
+
+from langchain_aws import BedrockLLM
+from langchain_anthropic import ChatAnthropic
+from langchain_google_genai import ChatGoogleGenerativeAI
+from langchain_google_vertexai import ChatVertexAI
+from langchain_openai import AzureChatOpenAI, ChatOpenAI
+import subprocess
+import json
+
+logging.basicConfig(
+  level=logging.INFO,
+  format="%(asctime)s %(levelname)s [llm_factory] %(message)s",
+  datefmt="%Y-%m-%d %H:%M:%S",
+)
+
+class LLMFactory:
+  """Factory that returns a *ready‑to‑use* LangChain chat model.
+
+  Parameters
+  ----------
+  provider : str, optional
+      Which LLM backend to use. See SUPPORTED_PROVIDERS for the list of
+      supported providers. If not specified, the provider is read from
+      the environment variable ``LLM_PROVIDER``. If that variable is not
+      set, a ``ValueError`` is raised.
+
+  Raises
+  ------
+  ValueError
+      If the specified provider is not supported or if no provider is
+      specified and the environment variable ``LLM_PROVIDER`` is not set.
+  EnvironmentError
+      If the required environment variables for the selected provider are
+      not set (e.g., API keys, deployment names, etc.).
+  """
+
+  SUPPORTED_PROVIDERS = {
+    "anthropic-claude",
+    "aws-bedrock",
+    "azure-openai",
+    "google-gemini",
+    "gcp-vertexai",
+    "openai",
+    "mistral"
+  }
+
+  # ------------------------------------------------------------------ #
+  # Construction helpers
+  # ------------------------------------------------------------------ #
+
+  def __init__(self, provider: str | None = None) -> None:
+    dotenv.load_dotenv()
+    if provider is None:
+      provider = os.getenv("LLM_PROVIDER")
+      if provider is None:
+        raise ValueError(
+          "Provider must be specified as one of: azure-openai, openai, anthropic-claude, "
+          "or set the LLM_PROVIDER environment variable"
+        )
+    if provider not in self.SUPPORTED_PROVIDERS:
+      raise ValueError(
+        f"Unsupported provider: {self.provider}. Supported providers are: {self.SUPPORTED_PROVIDERS}"
+      )
+    self.provider = provider.lower().replace("-", "_")
+
+  # ------------------------------------------------------------------ #
+  # Public helpers
+  # ------------------------------------------------------------------ #
+
+  def get_llm(
+    self,
+    response_format: str | dict | None = None,
+    tools: Iterable[Any] | None = None,
+    strict_tools: bool = True,
+    temperature: float | None = None,
+    **kwargs,
+  ):
+    """Return a LangChain chat model, optionally bound to *tools*.
+
+    The returned object is an instance of ``ChatOpenAI``,
+    ``AzureChatOpenAI`` or ``ChatAnthropic`` depending on the selected
+    *provider*.
+    """
+
+    builder = getattr(self, f"_build_{self.provider}_llm")
+    llm = builder(response_format, temperature, **kwargs)
+    return llm.bind_tools(tools, strict=strict_tools) if tools else llm
+
+  # ------------------------------------------------------------------ #
+  # Internal builders (one per provider)
+  # ------------------------------------------------------------------ #
+
+  def _build_aws_bedrock_llm(
+    self,
+    response_format: str | dict | None,
+    temperature: float | None,
+    **kwargs,
+  ):
+    credentials_profile = os.getenv("AWS_BEDROCK_PROFILE") or os.getenv("AWS_PROFILE") or None
+    model_id = os.getenv("BEDROCK_MODEL_ID")
+    logging.info(f"[LLM] Bedrock model={model_id} profile={credentials_profile}")
+
+    try:
+      result = subprocess.run(
+        ["aws", "sts", "get-caller-identity"],
+        capture_output=True,
+        text=True,
+        check=True,
+        env=os.environ.copy() if credentials_profile is None else {**os.environ, "AWS_PROFILE": credentials_profile},
+      )
+      session_info = json.loads(result.stdout)
+      logging.info(
+        f"[LLM] Using AWS session: UserId={session_info.get('UserId')}, "
+        f"Account={session_info.get('Account')}, Arn={session_info.get('Arn')}"
+      )
+    except Exception as e:
+      logging.warning(f"[LLM] Unable to get AWS session info: {e}")
+    model_kwargs = {"response_format": response_format} if response_format else {}
+    if credentials_profile:
+      return BedrockLLM(
+        credentials_profile_name=credentials_profile,
+        model_id=model_id,
+        temperature=temperature if temperature is not None else 0,
+        model_kwargs=model_kwargs,
+        **kwargs,
+      )
+    else:
+      return BedrockLLM(
+        model_id=model_id,
+        temperature=temperature if temperature is not None else 0,
+        model_kwargs=model_kwargs,
+        **kwargs,
+      )
+
+  def _build_anthropic_claude_llm(
+    self,
+    response_format: str | dict | None,
+    temperature: float | None,
+    **kwargs,
+  ):
+    api_key = os.getenv("ANTHROPIC_API_KEY")
+    model_name = os.getenv("ANTHROPIC_MODEL_NAME")
+
+    if not api_key:
+      raise EnvironmentError("ANTHROPIC_API_KEY environment variable is required")
+
+    if not model_name:
+      raise EnvironmentError("ANTHROPIC_MODEL_NAME environment variable is required")
+
+    logging.info(f"[LLM] Anthropic model={model_name}")
+
+    model_kwargs = {"response_format": response_format} if response_format else {}
+    return ChatAnthropic(
+      model_name=model_name,
+      anthropic_api_key=api_key,
+      temperature=temperature if temperature is not None else 0,
+      max_tokens=None,
+      timeout=None,
+      model_kwargs=model_kwargs,
+      **kwargs,
+    )
+
+  def _build_azure_openai_llm(
+    self,
+    response_format: str | dict | None,
+    temperature: float | None,
+    **kwargs,
+  ):
+    deployment = os.getenv("AZURE_OPENAI_DEPLOYMENT")
+    api_version = os.getenv("AZURE_OPENAI_API_VERSION")
+    endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
+    api_key = os.getenv("AZURE_OPENAI_API_KEY")
+
+    missing_vars = []
+    if not deployment:
+      missing_vars.append("AZURE_OPENAI_DEPLOYMENT")
+    if not api_version:
+      missing_vars.append("AZURE_OPENAI_API_VERSION")
+    if not endpoint:
+      missing_vars.append("AZURE_OPENAI_ENDPOINT")
+    if not api_key:
+      missing_vars.append("AZURE_OPENAI_API_KEY")
+    if missing_vars:
+      raise EnvironmentError(
+        f"Missing the following Azure OpenAI environment variable(s): {', '.join(missing_vars)}."
+      )
+
+    logging.info(
+      f"[LLM] AzureOpenAI deployment={deployment} api_version={api_version}"
+    )
+
+    model_kwargs = {"response_format": response_format} if response_format else {}
+    return AzureChatOpenAI(
+      azure_endpoint=endpoint,
+      azure_deployment=deployment,
+      openai_api_key=api_key,
+      api_version=api_version,
+      temperature=temperature if temperature is not None else 0,
+      max_tokens=None,
+      timeout=None,
+      max_retries=5,
+      model_kwargs=model_kwargs,
+      **kwargs,
+    )
+
+  def _build_openai_llm(
+    self,
+    response_format: str | dict | None,
+    temperature: float | None,
+    **kwargs,
+  ):
+    api_key = os.getenv("OPENAI_API_KEY")
+    base_url = os.getenv("OPENAI_ENDPOINT")
+    model_name = os.getenv("OPENAI_MODEL_NAME")
+
+    missing_vars = []
+    if not api_key:
+      missing_vars.append("OPENAI_API_KEY")
+    if not base_url:
+      missing_vars.append("OPENAI_ENDPOINT")
+    if not model_name:
+      missing_vars.append("OPENAI_MODEL_NAME")
+    if missing_vars:
+      raise EnvironmentError(
+      f"Missing the following OpenAI environment variable(s): {', '.join(missing_vars)}."
+      )
+
+    logging.info(f"[LLM] OpenAI model={model_name} endpoint={base_url}")
+
+    model_kwargs = {"response_format": response_format} if response_format else {}
+    return ChatOpenAI(
+      model_name=model_name,
+      api_key=api_key,
+      base_url=base_url,
+      temperature=temperature if temperature is not None else 0,
+      model_kwargs=model_kwargs,
+      **kwargs,
+    )
+
+
+  def _build_google_gemini_llm(
+    self,
+    response_format: str | dict | None,
+    temperature: float | None,
+    **kwargs,
+  ):
+
+    api_key = os.getenv("GOOGLE_API_KEY")
+    model_name = os.getenv("GOOGLE_GEMINI_MODEL_NAME", "gemini-2.0-flash")
+
+    if not api_key:
+      raise EnvironmentError("GOOGLE_API_KEY environment variable is required")
+
+    logging.info(f"[LLM] Google Gemini model={model_name}")
+
+    model_kwargs = {"response_format": response_format} if response_format else {}
+    return ChatGoogleGenerativeAI(
+      model=model_name,
+      google_api_key=api_key,
+      temperature=temperature if temperature is not None else 0,
+      model_kwargs=model_kwargs,
+      **kwargs,
+    )
+
+
+
+  def _build_google_vertexai_llm(
+    self,
+    response_format: str | dict | None,
+    temperature: float | None,
+    **kwargs,
+  ):
+
+    model_name = os.getenv("VERTEXAI_MODEL_NAME", "gemini-1.5-flash-001")
+    project = os.getenv("VERTEXAI_PROJECT")
+    location = os.getenv("VERTEXAI_LOCATION", "us-central1")
+
+    logging.info(f"[LLM] Google VertexAI model={model_name} project={project} location={location}")
+
+    model_kwargs = {"response_format": response_format} if response_format else {}
+    return ChatVertexAI(
+      model=model_name,
+      project=project,
+      location=location,
+      temperature=temperature if temperature is not None else 0,
+      max_tokens=None,
+      max_retries=6,
+      stop=None,
+      model_kwargs=model_kwargs,
+      **kwargs,
+    )

cnoe_agent_utils-0.1.0/pyproject.toml

@@ -0,0 +1,22 @@
+[project]
+name = "cnoe-agent-utils"
+version = "0.1.0"
+description = ""
+authors = [
+    {name = "Sri Aradhyula",email = "sraradhy@cisco.com"}
+]
+readme = "README.md"
+requires-python = ">=3.13,<4.0"
+dependencies = [
+    "dotenv (>=0.9.9,<0.10.0)",
+    "langchain-anthropic>=0.3.14",
+    "langchain-aws (>=0.2.24,<0.3.0)",
+    "langchain-google-genai>=2.1.5",
+    "langchain-google-vertexai>=2.0.24",
+    "langchain-openai>=0.3.18",
+]
+
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"