solace-agent-mesh 0.2.2__tar.gz → 0.2.4__tar.gz

solace_agent_mesh-0.2.4/.dockerignore

@@ -0,0 +1,25 @@
+*.pyc
+*.pyo
+*.pyd
+__pycache__
+.pytest_cache
+.env*
+.env
+.env_template
+docker-compose-local.yaml
+Makefile
+Dockerfile
+venv
+.venv
+.vscode
+.git
+.DS_Store
+*.log
+*.out
+*.txt
+project_notes.txt
+*.trace
+trace_*
+dist
+build
+tmp

solace_agent_mesh-0.2.4/.github/helper_scripts/build_frontend.py

@@ -0,0 +1,36 @@
+# noqa: INP001
+import os
+import shutil
+import subprocess
+from sys import stderr
+
+from hatchling.builders.hooks.plugin.interface import BuildHookInterface
+
+
+class CustomBuildHook(BuildHookInterface):
+    def initialize(self, version, build_data):
+        super().initialize(version, build_data)
+        stderr.write(">>> Building Solace Agent Mesh frontend\n")
+        npm = shutil.which("npm")
+        if npm is None:
+            raise RuntimeError(
+                "NodeJS `npm` is required for building Solace Agent Mesh frontend but it was not found"
+            )
+
+        os.chdir("config_portal/frontend")
+        try:
+            stderr.write("### npm install\n")
+            subprocess.run([npm, "install"], check=True)
+            stderr.write("\n### npm run build\n")
+            subprocess.run([npm, "run", "build"], check=True)
+        finally:
+            os.chdir("../..")
+
+        os.chdir("web-visualizer/")
+        try:
+            stderr.write("### npm install\n")
+            subprocess.run([npm, "install"], check=True)
+            stderr.write("\n### npm run build\n")
+            subprocess.run([npm, "run", "build"], check=True)
+        finally:
+            os.chdir("..")

solace_agent_mesh-0.2.4/.github/workflows/ci.yaml

@@ -0,0 +1,60 @@
+name: Continuous Integration
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+permissions:
+  repository-projects: read
+  contents: write
+  id-token: write
+  packages: write
+  checks: write
+  pull-requests: write
+
+jobs:
+  docker-build:
+    name: Build Docker Image
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Get Commit Hash
+        id: get_commit_hash
+        run: |
+          echo "commit_hash=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT
+
+      - name: Setup Qemu
+        uses: docker/setup-qemu-action@v3.6.0
+
+      - name: Setup Docker Buildx
+        uses: docker/setup-buildx-action@v3.10.0
+
+      - name: Build Docker Image
+        uses: docker/build-push-action@v6.16.0
+        with:
+          context: .
+          file: Dockerfile
+          tags: solace/solace-agent-mesh:${{ steps.get_commit_hash.outputs.commit_hash }}
+          push: false
+          cache-from: type=gha
+          cache-to: type=gha
+  ci:
+    uses: SolaceDev/solace-public-workflows/.github/workflows/hatch_ci.yml@main
+    with:
+      min-python-version: "3.10"
+      max-python-version: "3.13"
+      whitesource_product_name: "solace-agent-mesh"
+      whitesource_config_file: "wss-unified-agent.config"
+      npm_package_path: web-visualizer
+      node_version: 20
+      npm_lock_file: package-lock.json
+    secrets:
+      SONAR_TOKEN: ${{ secrets.SONARQUBE_TOKEN }}
+      SONAR_HOST_URL: ${{ secrets.SONARQUBE_HOST_URL }}
+      WHITESOURCE_API_KEY: ${{ secrets.WHITESOURCE_API_KEY }}
+      MANIFEST_AWS_ACCESS_KEY_ID: ${{ secrets.MANIFEST_READ_ONLY_AWS_ACCESS_KEY_ID }}
+      MANIFEST_AWS_SECRET_ACCESS_KEY: ${{ secrets.MANIFEST_READ_ONLY_AWS_SECRET_ACCESS_KEY }}

solace_agent_mesh-0.2.4/.github/workflows/release.yml

@@ -0,0 +1,68 @@
+name: Release
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        type: choice
+        required: true
+        description: "Version bump type"
+        options:
+          - patch
+          - minor
+          - major
+
+permissions:
+  id-token: write
+  checks: write
+  contents: write
+  packages: write
+jobs:
+  release:
+    uses: SolaceDev/solace-public-workflows/.github/workflows/hatch_release_pypi.yml@main
+    with:
+      ENVIRONMENT: pypi
+      version: ${{ github.event.inputs.version }}
+      npm_package_path: web-visualizer
+      node_version: 20
+      npm_lock_file: package-lock.json
+      pypi-project: solace-agent-mesh
+
+    secrets:
+      COMMIT_KEY: ${{ secrets.COMMIT_KEY }}
+      PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+
+  release-docker:
+    runs-on: ubuntu-latest
+    needs: release
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Get Latest Tag
+        id: get_latest_tag
+        run: |
+          echo "latest_tag=$(git describe --tags --abbrev=0)" >> $GITHUB_OUTPUT
+
+      - name: Setup Qemu
+        uses: docker/setup-qemu-action@v3.6.0
+
+      - name: Setup Docker Buildx
+        uses: docker/setup-buildx-action@v3.10.0
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3.4.0
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Build And Push Docker Image
+        uses: docker/build-push-action@v6.16.0
+        with:
+          context: .
+          file: Dockerfile
+          push: true
+          tags: |
+            solace/solace-agent-mesh:${{ steps.get_latest_tag.outputs.latest_tag }}
+            solace/solace-agent-mesh:latest
+          cache-from: type=gha
+          cache-to: type=gha

solace_agent_mesh-0.2.4/Dockerfile

@@ -0,0 +1,37 @@
+FROM python:3.11-slim
+
+ENV PYTHONUNBUFFERED=1
+
+# Install dependencies
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends plantuml graphviz git curl && \
+    curl -sL https://deb.nodesource.com/setup_18.x | bash - && \
+    apt-get install -y --no-install-recommends nodejs && \
+    apt-get purge -y --auto-remove && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/*
+
+# Building the Solace Agent Mesh package
+WORKDIR /sam-temp
+COPY . /sam-temp
+RUN python3.11 -m pip install --no-cache-dir hatch
+RUN python3.11 -m hatch build
+
+# Install the Solace Agent Mesh package
+RUN python3.11 -m pip install --no-cache-dir dist/solace_agent_mesh-*.whl
+
+# Clean up temporary files
+WORKDIR /app
+RUN rm -rf /sam-temp
+
+# Create a non-root user
+# RUN groupadd -r samapp && useradd -r -g samapp samapp
+# RUN chown -R samapp:samapp /app /tmp
+
+# # Switch to non-root user
+# USER samapp
+
+LABEL org.opencontainers.image.source=https://github.com/SolaceLabs/solace-agent-mesh
+
+# CLI entry point
+ENTRYPOINT ["solace-agent-mesh"]

solace_agent_mesh-0.2.4/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.4
+Name: solace-agent-mesh
+Version: 0.2.4
+Summary: Solace Agent Mesh is an EDA AI-first platform powered by Solace
+Project-URL: homepage, https://github.com/SolaceLabs/solace-agent-mesh
+Project-URL: repository, https://github.com/SolaceLabs/solace-agent-mesh
+Project-URL: documentation, https://github.com/SolaceLabs/solace-agent-mesh/blob/main/docs/docs/index.md
+Author-email: Edward Funnekotter <edward.funnekotter@solace.com>, Greg Meldrum <greg.meldrum@solace.com>, Cyrus Mobini <cyrus.mobini@solace.com>
+License-File: LICENSE
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+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
+Requires-Python: >=3.10.16
+Requires-Dist: beautifulsoup4~=4.12.3
+Requires-Dist: boto3~=1.34.122
+Requires-Dist: build~=1.2.2.post1
+Requires-Dist: click~=8.1.7
+Requires-Dist: duckduckgo-search~=6.3.7
+Requires-Dist: html2text~=2024.2.26
+Requires-Dist: jq~=1.8.0
+Requires-Dist: kaleido~=0.1.0.post1; sys_platform == 'win32'
+Requires-Dist: kaleido~=0.2.1; sys_platform != 'win32'
+Requires-Dist: markitdown~=0.0.1a3
+Requires-Dist: plotly~=5.24.1
+Requires-Dist: pyperclip~=1.9.0
+Requires-Dist: pytest-cov~=5.0.0
+Requires-Dist: pytest~=8.3.1
+Requires-Dist: python-dateutil==2.9.0.post0
+Requires-Dist: ruamel-yaml~=0.18.6
+Requires-Dist: solace-ai-connector-rest~=0.0.3
+Requires-Dist: solace-ai-connector-slack~=0.0.2
+Requires-Dist: solace-ai-connector-web~=0.2.2
+Requires-Dist: solace-ai-connector[llm]~=1.1.4
+Requires-Dist: solace-ai-connector[websocket]~=1.1.4
+Requires-Dist: solace-ai-connector~=1.1.4
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="./docs/static/img/logo.png" alt="Solace Agent Mesh Logo" width="100"/>
+</p>
+<h2 align="center">
+  Solace Agent Mesh
+</h2>
+<h3 align="center">Open-source framework for building event driven multi-agent AI systems</h3>
+<h5 align="center">Star ⭐️ this repo to stay updated as we ship new features and improvements.</h5>
+
+<p align="center">
+  <a href="https://github.com/SolaceLabs/solace-agent-mesh/blob/main/LICENSE">
+    <img src="https://img.shields.io/github/license/SolaceLabs/solace-agent-mesh" alt="License">
+  </a>
+  <a href="https://pypi.org/project/solace-agent-mesh">
+    <img src="https://img.shields.io/pypi/v/solace-agent-mesh.svg" alt="PyPI - Version">
+  </a>
+  <a href="https://pypi.org/project/solace-agent-mesh">
+    <img src="https://img.shields.io/pypi/pyversions/solace-agent-mesh.svg" alt="PyPI - Python Version">
+  </a>
+  <a href="https://pypi.org/project/solace-agent-mesh">
+      <img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/solace-agent-mesh?color=00C895">
+  </a>
+</p>
+<p align="center">
+  <a href="#-key-features">Key Features</a> •
+  <a href="#-quick-start-5-minutes">Quickstart</a> •
+  <a href="#️-next-steps">Next Steps</a>
+</p>
+
+---
+
+Whether you're prototyping an 🤖 AI assistant or deploying a 🌎 production-grade solution, **Solace Agent Mesh (SAM)** provides the infrastructure to:
+  - Connect AI agents to real-world data sources and systems.
+  - Add gateways to expose capabilities via REST, a browser-based UI, Slack, and many more.
+  - Scale from local development to distributed, enterprise deployments.
+
+![Solace Agent Mesh Overview](./docs/static/img/Solace_AI_Framework_README.png)
+
+---
+
+## ✨ Key Features 
+- ⚙️ **[Modular, Event-Driven Architecture](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/getting-started/component-overview)** – All components communicate via events through a central event mesh, enabling loose coupling and high scalability.
+- 🤖 **[Composable Agents](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/concepts/agents)** – Combine specialized AI agents to solve complex, multi-step workflows.
+- 🌐 **[Flexible Interfaces](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/concepts/gateways)** – Interact with SAM via the REST API, browser UI, or [Slack Integration](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/tutorials/slack-integration).
+- 🧠 **[Built-in Orchestration](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/concepts/orchestrator)** – Tasks are automatically broken down and delegated across agents by a built-in orchestrator.
+- 🧩 **[Plugin-Extensible](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/concepts/plugins)** – Add your own agents, gateways, or services with minimal boilerplate.
+- 🏢 **[Production-Ready](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/deployment/deploy)** – Backed by [Solace’s enterprise-grade event broker](https://solace.com/products/event-broker/) for reliability and performance.
+- 🔧 **[Services](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/concepts/services)** –  File storage, memory, and embeddings, all extensible, and built-in.
+
+---
+
+## 🚀 Quick Start (5 minutes)
+
+Set up Solace Agent Mesh in just a few steps.
+
+### ⚙️ System Requirements
+
+To run Solace Agent Mesh locally, you’ll need:
+
+- **Python 3.10.16+**
+- **pip** (comes with Python)
+- **OS**: MacOS, Linux, or Windows (with [WSL](https://learn.microsoft.com/en-us/windows/wsl/))
+- **LLM API key** (any major provider or custom endpoint)
+
+### 💻 Setup Steps
+
+```bash
+# 1. (Optional) Create and activate a Python virtual environment
+python3 -m venv venv
+source venv/bin/activate
+
+# 2. Install the Solace Agent Mesh
+pip install solace-agent-mesh
+
+# 3. Initialize a new project
+mkdir my-agent-mesh && cd my-agent-mesh
+solace-agent-mesh init        # Follow the steps in the interactive init
+
+# 4. Build and run the project
+solace-agent-mesh run -b      # Shortcut for build + run
+```
+
+#### Once running:
+
+- Open the Web UI at [http://localhost:5001](http://localhost:5001) to talk with a chat interface.
+<details>
+  <summary>Use the REST API directly via curl</summary>
+
+  ```bash
+  curl --location 'http://127.0.0.1:5050/api/v1/request' \
+    --form 'prompt="What is the capital of France?"' \
+    --form 'stream="false"'
+  ```
+
+</details>
+
+
+---
+
+## ➡️ Next Steps
+
+Want to go further? Here are some hands-on tutorials to help you get started:
+
+| 🔧 Integration | ⏱️ Est. Time | 📘 Tutorial |
+|----------------|--------------|-------------|
+| 🌤️ **Weather Agent**<br>Build an agent that gives Solace Agent Mesh  the ability to access real-time weather information.  | **~5 min** | [Weather Agent Plugin](https://github.com/SolaceLabs/solace-agent-mesh-core-plugins/tree/main/sam-geo-information) |
+| 🗃️ **SQL Database Integration**<br>Enable Solace Agent Mesh to answer company-specific questions using a sample coffee company database.| **~10–15 min** | [SQL Database Tutorial](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/tutorials/sql-database) |
+| 🧠 **MCP Integration**<br>Integrating a Model Context Protocol (MCP) Server into Solace Agent Mesh. | **~10–15 min** | [MCP Integration Tutorial](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/tutorials/mcp-integration) |
+| 💬 **Slack Integration**<br>Chat with Solace Agent Mesh directly from Slack. | **~20–30 min** | [Slack Integration Tutorial](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/tutorials/slack-integration) |
+
+
+📚 Want to explore more? Check out the full [Solace Agent Mesh documentation](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/getting-started/introduction/).
+
+---
+
+## 📦 Release Notes
+
+Stay up to date with the latest changes, features, and fixes.  
+See [CHANGELOG.md](CHANGELOG.md) for a full history of updates.
+
+---
+
+## 👥 Contributors
+
+Solace Agent Mesh is built with the help of our amazing community.  
+Thanks to everyone who has contributed ideas, code, and time to make this project better.  
+👀 View the full list of contributors → [GitHub Contributors](https://github.com/SolaceLabs/solace-agent-mesh/graphs/contributors)
+🤝 **Looking to contribute?** Check out [CONTRIBUTING.md](CONTRIBUTING.md) to get started and see how you can help.
+
+---
+
+## 📄 License
+
+This project is licensed under the **Apache 2.0 License**.  
+See the full license text in the [LICENSE](LICENSE) file.

solace_agent_mesh-0.2.4/README.md

@@ -0,0 +1,135 @@
+<p align="center">
+  <img src="./docs/static/img/logo.png" alt="Solace Agent Mesh Logo" width="100"/>
+</p>
+<h2 align="center">
+  Solace Agent Mesh
+</h2>
+<h3 align="center">Open-source framework for building event driven multi-agent AI systems</h3>
+<h5 align="center">Star ⭐️ this repo to stay updated as we ship new features and improvements.</h5>
+
+<p align="center">
+  <a href="https://github.com/SolaceLabs/solace-agent-mesh/blob/main/LICENSE">
+    <img src="https://img.shields.io/github/license/SolaceLabs/solace-agent-mesh" alt="License">
+  </a>
+  <a href="https://pypi.org/project/solace-agent-mesh">
+    <img src="https://img.shields.io/pypi/v/solace-agent-mesh.svg" alt="PyPI - Version">
+  </a>
+  <a href="https://pypi.org/project/solace-agent-mesh">
+    <img src="https://img.shields.io/pypi/pyversions/solace-agent-mesh.svg" alt="PyPI - Python Version">
+  </a>
+  <a href="https://pypi.org/project/solace-agent-mesh">
+      <img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/solace-agent-mesh?color=00C895">
+  </a>
+</p>
+<p align="center">
+  <a href="#-key-features">Key Features</a> •
+  <a href="#-quick-start-5-minutes">Quickstart</a> •
+  <a href="#️-next-steps">Next Steps</a>
+</p>
+
+---
+
+Whether you're prototyping an 🤖 AI assistant or deploying a 🌎 production-grade solution, **Solace Agent Mesh (SAM)** provides the infrastructure to:
+  - Connect AI agents to real-world data sources and systems.
+  - Add gateways to expose capabilities via REST, a browser-based UI, Slack, and many more.
+  - Scale from local development to distributed, enterprise deployments.
+
+![Solace Agent Mesh Overview](./docs/static/img/Solace_AI_Framework_README.png)
+
+---
+
+## ✨ Key Features 
+- ⚙️ **[Modular, Event-Driven Architecture](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/getting-started/component-overview)** – All components communicate via events through a central event mesh, enabling loose coupling and high scalability.
+- 🤖 **[Composable Agents](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/concepts/agents)** – Combine specialized AI agents to solve complex, multi-step workflows.
+- 🌐 **[Flexible Interfaces](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/concepts/gateways)** – Interact with SAM via the REST API, browser UI, or [Slack Integration](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/tutorials/slack-integration).
+- 🧠 **[Built-in Orchestration](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/concepts/orchestrator)** – Tasks are automatically broken down and delegated across agents by a built-in orchestrator.
+- 🧩 **[Plugin-Extensible](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/concepts/plugins)** – Add your own agents, gateways, or services with minimal boilerplate.
+- 🏢 **[Production-Ready](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/deployment/deploy)** – Backed by [Solace’s enterprise-grade event broker](https://solace.com/products/event-broker/) for reliability and performance.
+- 🔧 **[Services](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/concepts/services)** –  File storage, memory, and embeddings, all extensible, and built-in.
+
+---
+
+## 🚀 Quick Start (5 minutes)
+
+Set up Solace Agent Mesh in just a few steps.
+
+### ⚙️ System Requirements
+
+To run Solace Agent Mesh locally, you’ll need:
+
+- **Python 3.10.16+**
+- **pip** (comes with Python)
+- **OS**: MacOS, Linux, or Windows (with [WSL](https://learn.microsoft.com/en-us/windows/wsl/))
+- **LLM API key** (any major provider or custom endpoint)
+
+### 💻 Setup Steps
+
+```bash
+# 1. (Optional) Create and activate a Python virtual environment
+python3 -m venv venv
+source venv/bin/activate
+
+# 2. Install the Solace Agent Mesh
+pip install solace-agent-mesh
+
+# 3. Initialize a new project
+mkdir my-agent-mesh && cd my-agent-mesh
+solace-agent-mesh init        # Follow the steps in the interactive init
+
+# 4. Build and run the project
+solace-agent-mesh run -b      # Shortcut for build + run
+```
+
+#### Once running:
+
+- Open the Web UI at [http://localhost:5001](http://localhost:5001) to talk with a chat interface.
+<details>
+  <summary>Use the REST API directly via curl</summary>
+
+  ```bash
+  curl --location 'http://127.0.0.1:5050/api/v1/request' \
+    --form 'prompt="What is the capital of France?"' \
+    --form 'stream="false"'
+  ```
+
+</details>
+
+
+---
+
+## ➡️ Next Steps
+
+Want to go further? Here are some hands-on tutorials to help you get started:
+
+| 🔧 Integration | ⏱️ Est. Time | 📘 Tutorial |
+|----------------|--------------|-------------|
+| 🌤️ **Weather Agent**<br>Build an agent that gives Solace Agent Mesh  the ability to access real-time weather information.  | **~5 min** | [Weather Agent Plugin](https://github.com/SolaceLabs/solace-agent-mesh-core-plugins/tree/main/sam-geo-information) |
+| 🗃️ **SQL Database Integration**<br>Enable Solace Agent Mesh to answer company-specific questions using a sample coffee company database.| **~10–15 min** | [SQL Database Tutorial](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/tutorials/sql-database) |
+| 🧠 **MCP Integration**<br>Integrating a Model Context Protocol (MCP) Server into Solace Agent Mesh. | **~10–15 min** | [MCP Integration Tutorial](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/tutorials/mcp-integration) |
+| 💬 **Slack Integration**<br>Chat with Solace Agent Mesh directly from Slack. | **~20–30 min** | [Slack Integration Tutorial](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/tutorials/slack-integration) |
+
+
+📚 Want to explore more? Check out the full [Solace Agent Mesh documentation](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/getting-started/introduction/).
+
+---
+
+## 📦 Release Notes
+
+Stay up to date with the latest changes, features, and fixes.  
+See [CHANGELOG.md](CHANGELOG.md) for a full history of updates.
+
+---
+
+## 👥 Contributors
+
+Solace Agent Mesh is built with the help of our amazing community.  
+Thanks to everyone who has contributed ideas, code, and time to make this project better.  
+👀 View the full list of contributors → [GitHub Contributors](https://github.com/SolaceLabs/solace-agent-mesh/graphs/contributors)
+🤝 **Looking to contribute?** Check out [CONTRIBUTING.md](CONTRIBUTING.md) to get started and see how you can help.
+
+---
+
+## 📄 License
+
+This project is licensed under the **Apache 2.0 License**.  
+See the full license text in the [LICENSE](LICENSE) file.