acp-sdk 0.8.1__tar.gz → 0.8.2__tar.gz

{acp_sdk-0.8.1 → acp_sdk-0.8.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: acp-sdk
-Version: 0.8.1
+Version: 0.8.2
 Summary: Agent Communication Protocol SDK
 Author: IBM Corp.
 Maintainer-email: Tomas Pilar <thomas7pilar@gmail.com>

acp_sdk-0.8.2/docs/.gitignore

@@ -0,0 +1 @@
+_build/

acp_sdk-0.8.2/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

acp_sdk-0.8.2/docs/conf.py

@@ -0,0 +1,30 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "ACP SDK"
+copyright = "2025, IBM Corp."
+author = "IBM Corp."
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ["autoapi.extension"]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "alabaster"
+html_static_path = ["_static"]
+
+autoapi_dirs = ["../src/acp_sdk"]
+autoapi_root = "api-reference"
+autoapi_generate_api_docs = True

acp_sdk-0.8.2/docs/index.rst

@@ -0,0 +1,17 @@
+.. ACP SDK documentation master file, created by
+   sphinx-quickstart on Wed Apr 30 07:50:18 2025.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+ACP SDK documentation
+=================
+
+Add your content using ``reStructuredText`` syntax. See the
+`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
+documentation for details.
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+

acp_sdk-0.8.2/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

{acp_sdk-0.8.1 → acp_sdk-0.8.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "acp-sdk"
-version = "0.8.1"
+version = "0.8.2"
 description = "Agent Communication Protocol SDK"
 license = "Apache-2.0"
 readme = "README.md"

acp_sdk-0.8.1/docs/_sidebar.md

@@ -1,7 +0,0 @@
-- [Python](/python/)
-
-- Modules
-
-  - [Client](client.md)
-  - [Server](server.md)
-  - [Models](models.md)

acp_sdk-0.8.1/docs/client.md

@@ -1,99 +0,0 @@
-# Client
-
-<!-- TOC -->
-## Table of Contents
-- [Client](#client)
-  - [Table of Contents](#table-of-contents)
-  - [Overview](#overview)
-  - [Usage](#usage)
-    - [Setting up a client](#setting-up-a-client)
-    - [Performing discovery](#performing-discovery)
-    - [Running an agent](#running-an-agent)
-    - [Using sessions](#using-sessions)
-<!-- /TOC -->
-
----
-
-## Overview
-
-The client module provides a thin ACP client that can be integrated into any application that needs to communicate with ACP agents. It provides the following advantages over raw HTTP client:
-
-- Strong typing
-- Error handling
-- Stream decoding
-- Session management
-- Instrumentation
-
-> [!NOTE]
->
-> Location within the sdk: [client](/python/src/acp_sdk/client)
-
-## Usage
-
-The client is based on the [httpx.AsyncClient](https://www.python-httpx.org/async/). The usage is very similar as demonstrated below.
-
-### Setting up a client
-
-To set up a simple client, simply provide an URL:
-
-```py
-async with Client(base_url="http://localhost:8000") as client:
-  ...
-```
-
-To use advanced HTTP configuration, provide `httpx` async client:
-
-```py
-async with Client(
-  client=httpx.AsyncClient(
-    base_url="http://localhost:8000",
-    headers={"token": "foobar"})
-  ) as client:
-  ...
-```
-
-### Performing discovery
-
-To discover available agents:
-
-```py
-async with Client(base_url="http://localhost:8000") as client:
-  async for agent in client.agents():
-    ...
-```
-
-### Running an agent
-
-Agent run can be invoked in three modes:
-
-```py
-async with Client(base_url="http://localhost:8000") as client:
-  message = Message(parts=[MessagePart(content="Hello")])
-
-  # Async
-  run = await client.run_async(agent="agent", input=[message])
-  print(run.status)
-
-  # Sync - waits for completion, failure, cancellation or await
-  run = await client.run_sync(agent="agent", input=[message])
-  print(run.output)
-  
-  # Stream - as sync but also receives events
-  async for event in client.run_stream(agent="agent", input=[message])
-    print(event)
-```
-
-### Using sessions
-
-Sessions are a mechanism to have multi-turn conversations with agents.
-
-To enter a session, create one from the client:
-
-```py
-async with Client(base_url="http://localhost:8000" as client:
-    agents = [agent async for agent in client.agents()]
-
-    async with client.session() as session:
-        for agent in agents:
-            await session.run_sync(agent=agent.name, input=[Message(parts=[MessagePart(content="Hello!")])])
-```

acp_sdk-0.8.1/docs/index.html

@@ -1,104 +0,0 @@
-<!doctype html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <title>ACP Docs</title>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
-    <meta name="description" content="Description" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0" />
-    <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css" />
-    <link
-      rel="stylesheet"
-      title="docsify-darklight-theme"
-      href="//cdn.jsdelivr.net/npm/docsify-darklight-theme@latest/dist/style.min.css"
-    />
-    <style>
-      aside.sidebar {
-        padding-top: 0;
-      }
-      .app-name-link img {
-        filter: invert(var(--docs-logo-color-invert));
-      }
-    </style>
-  </head>
-  <body>
-    <div id="app"></div>
-    <script>
-      function fixLinkFactory() {
-        var main = "https://github.com/i-am-bee/acp/tree/main";
-        var exampleRegex = /^[\/]{0,1}examples\/(.*)/;
-        var srcRegex = /^[\/]{0,1}src\/(.*)/;
-        var docsMatch = /^[\/]{0,1}docs\/(.*)/;
-
-        return function (url) {
-          if (url === "LICENSE") {
-            return main.concat("/LICENSE");
-          }
-          if (url.substring(0, 2) === "./") {
-            url = url.substring(2);
-          }
-          if (url.match(docsMatch)) {
-            url = url.replace(docsMatch, "$1");
-          }
-          if (url.match(exampleRegex) || url.match(srcRegex) || url === "/package.json") {
-            url = main.concat(url);
-          }
-          return url;
-        };
-      }
-
-      var fixLink = fixLinkFactory();
-      var basePath = window.location.pathname.replace(/index.html/gi, "").replace("/#/", "") || "/";
-
-      window.$docsify = {
-        "name": "ACP",
-        "basePath": basePath,
-        "darklightTheme": {
-          "defaultTheme": 'dark',
-          "light": {
-            'docs-logo-color-invert': 0,
-          },
-          "dark": {
-            'docs-logo-color-invert': 1,
-          }
-        },
-        "repo": "i-am-bee/acp",
-        "loadSidebar": true,
-        "subMaxLevel": 2,
-        "auto2top": true,
-        "search": {
-          depth: 6,
-          namespace: "acp",
-        },
-        "flexible-alerts": {
-          important: {
-            label: "Important",
-            icon: "icon-note",
-            className: "note",
-          },
-        },
-        "markdown": {
-          smartypants: true,
-          renderer: {
-            link: function (link, renderer, text) {
-              return this.origin.link.apply(this, [fixLink(link), renderer, text]);
-            },
-            html: function (html) {
-              var regex = /(src|href|srcset)\s*=\s*(['"])[\.]{0,1}\/docs\/(.+?)\2/gi;
-              html = html.replace(regex, "$1=$2" + basePath + "$3$2");
-              return html;
-            },
-          },
-        },
-      };
-    </script>
-    <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
-    <script src="//cdn.jsdelivr.net/npm/docsify-darklight-theme@latest/dist/index.min.js"></script>
-    <script src="https://unpkg.com/docsify-plugin-flexible-alerts"></script>
-    <script src="https://unpkg.com/docsify-copy-code@3"></script>
-    <script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
-    <script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-python.min.js"></script>
-    <script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-sql.min.js"></script>
-    <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
-  </body>
-</html>

acp_sdk-0.8.1/docs/models.md

@@ -1,45 +0,0 @@
-# Models
-
-<!-- TOC -->
-## Table of Contents
-- [Models](#models)
-  - [Table of Contents](#table-of-contents)
-  - [Overview](#overview)
-  - [Core](#core)
-  - [Schemas](#schemas)
-  - [Errors](#errors)
-<!-- /TOC -->
-
----
-
-## Overview
-
-The models module provides `pydantic` models describing ACP data structures.
-
-> [!NOTE]
->
-> Location within the sdk: [models](/python/src/acp_sdk/models)
-
-## Core
-
-Core models are used directly by the SDK consumers. They describe ACP structures like `Message`, `MessagePart` or `Run`. 
-
-> [!NOTE]
->
-> Location within the sdk: [models.models](/python/src/acp_sdk/models/models.py)
-
-## Schemas
-
-Schema models are used by client and server implementations. They describe payloads of HTTP requests and responses.
-
-> [!NOTE]
->
-> Location within the sdk: [models.schemas](/python/src/acp_sdk/models/schemas.py)
-
-## Errors
-
-Error model describes errors within the system. SDK consumers can encounter errors in various places, during a stream, as part of the `Run` model or raised inside the `ACPError` exception.
-
-> [!NOTE]
->
-> Location within the sdk: [models.errors](/python/src/acp_sdk/models/errors.py)

acp_sdk-0.8.1/docs/server.md

@@ -1,103 +0,0 @@
-# Server
-
-<!-- TOC -->
-## Table of Contents
-- [Server](#server)
-  - [Table of Contents](#table-of-contents)
-  - [Overview](#overview)
-  - [Usage](#usage)
-    - [Running a server](#running-a-server)
-    - [Standalone application](#standalone-application)
-<!-- /TOC -->
-
----
-
-## Overview
-
-The server module aims to expose arbitrary agents over the Agent Commucation Protocol. Consumers can use this module to avoid protocol-specific technicalities and focus on the agent itself. The modules provides Agent abstractions, FastAPI application factory and Uvicorn-based server.
-
-> [!NOTE]
->
-> Location within the sdk: [server](/python/src/acp_sdk/server).
-
-## Usage
-
-The SDK provides `Agent` abstract class and `agent` decorator. Arbitrary agent can be created in by either inheritance from the class or by using the decorator on a generator, coroutine or a regular function.
-
-> [!NOTE]
->
-> Location within the sdk: [server.agent](/python/src/acp_sdk/server/agent.py).
-
-### Running a server
-
-The SDK provides `Server` class as a convenience for developers to easily serve agents over ACP. The server allows to easily create and register agents. It sets up logging and optionally telemetry exporters.
-
-<!-- embedme python/examples/servers/echo.py -->
-
-```py
-import asyncio
-from collections.abc import AsyncGenerator
-
-from acp_sdk.models import (
-    Message,
-)
-from acp_sdk.server import Context, RunYield, RunYieldResume, Server
-
-server = Server()
-
-
-@server.agent()
-async def echo(input: list[Message], context: Context) -> AsyncGenerator[RunYield, RunYieldResume]:
-    """Echoes everything"""
-    for message in input:
-        await asyncio.sleep(0.5)
-        yield {"thought": "I should echo everything"}
-        await asyncio.sleep(0.5)
-        yield message
-
-
-server.run()
-```
-
-> [!NOTE]
->
-> Location within the sdk: [server.server](/python/src/acp_sdk/server/server.py).
-
-### Standalone application
-
-The SDK provides `create_app` factory that turns agents into `FastAPI` application. The application implements route handlers, error handlers, unified execution environment and more. The application can be served with arbitrary ASGI compatible server.
-
-<!-- embedme python/examples/servers/standalone.py -->
-
-```py
-from collections.abc import AsyncGenerator
-
-from acp_sdk.models import (
-    Message,
-)
-from acp_sdk.server import RunYield, RunYieldResume, agent, create_app
-
-# This example demonstrates how to serve agents with you own server
-
-
-@agent()
-async def echo(input: list[Message]) -> AsyncGenerator[RunYield, RunYieldResume]:
-    """Echoes everything"""
-    for message in input:
-        yield message
-
-
-app = create_app(echo)
-
-# The app can now be used with any ASGI server
-
-# Run with
-#   1. fastapi run examples/servers/standalone.py
-#   2. uvicorn examples.servers.standalone:app
-#   ...
-
-```
-
-> [!NOTE]
->
-> Location within the sdk: [server.app](/python/src/acp_sdk/server/app.py).