acp-sdk 0.3.2__py3-none-any.whl → 0.4.0__py3-none-any.whl

acp_sdk/models/models.py

@@ -1,4 +1,5 @@
 import uuid
+from datetime import datetime
 from enum import Enum
 from typing import Any, Literal, Optional, Union
 
@@ -7,11 +8,62 @@ from pydantic import AnyUrl, BaseModel, ConfigDict, Field
 from acp_sdk.models.errors import Error
 
 
-class Metadata(BaseModel):
+class AnyModel(BaseModel):
     model_config = ConfigDict(extra="allow")
 
 
-class AnyModel(BaseModel):
+class Author(BaseModel):
+    name: str
+    email: str | None = None
+    url: AnyUrl | None = None
+
+
+class Contributor(BaseModel):
+    name: str
+    email: str | None = None
+    url: AnyUrl | None = None
+
+
+class LinkType(str, Enum):
+    SOURCE_CODE = "source-code"
+    CONTAINER_IMAGE = "container-image"
+    HOMEPAGE = "homepage"
+    DOCUMENTATION = "documentation"
+
+
+class Link(BaseModel):
+    type: LinkType
+    url: AnyUrl
+
+
+class DependencyType(str, Enum):
+    AGENT = "agent"
+    TOOL = "tool"
+    MODEL = "model"
+
+
+class Dependency(BaseModel):
+    type: DependencyType
+    name: str
+
+
+class Metadata(BaseModel):
+    annotations: AnyModel | None = None
+    documentation: str | None = None
+    license: str | None = None
+    programming_language: str | None = None
+    natural_languages: list[str] | None = None
+    framework: str | None = None
+    use_cases: list[str] | None = None
+    tags: list[str] | None = None
+    created_at: datetime | None = None
+    updated_at: datetime | None = None
+    author: Author | None = None
+    contributors: list[Contributor] | None = None
+    links: list[Link] | None = None
+    dependencies: list[Dependency] | None = None
+    recommended_models: list[str] | None = None
+
     model_config = ConfigDict(extra="allow")
 
 

acp_sdk/server/agent.py

@@ -129,7 +129,7 @@ def agent(
 
             @property
             def description(self) -> str:
-                return description or fn.__doc__ or ""
+                return description or inspect.getdoc(fn) or ""
 
             @property
             def metadata(self) -> Metadata:

acp_sdk/server/errors.py

@@ -33,7 +33,7 @@ def status_code_to_error_code(status_code: int) -> ErrorCode:
 async def acp_error_handler(request: Request, exc: ACPError, *, status_code: int | None = None) -> JSONResponse:
     error = exc.error
     return JSONResponse(
-        status_code=status_code or error_code_to_status_code(error.code), content=error.model_dump_json()
+        status_code=status_code or error_code_to_status_code(error.code), content=error.model_dump(mode="json")
     )
 
 

acp_sdk-0.4.0.dist-info/METADATA

@@ -0,0 +1,63 @@
+Metadata-Version: 2.4
+Name: acp-sdk
+Version: 0.4.0
+Summary: Agent Communication Protocol SDK
+Author: IBM Corp.
+Maintainer-email: Tomas Pilar <thomas7pilar@gmail.com>
+License-Expression: Apache-2.0
+Requires-Python: <4.0,>=3.11
+Requires-Dist: fastapi[standard]>=0.115.8
+Requires-Dist: httpx-sse>=0.4.0
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: janus>=2.0.0
+Requires-Dist: opentelemetry-api>=1.31.1
+Requires-Dist: opentelemetry-exporter-otlp-proto-http>=1.31.1
+Requires-Dist: opentelemetry-instrumentation-fastapi>=0.52b1
+Requires-Dist: opentelemetry-instrumentation-httpx>=0.52b1
+Requires-Dist: opentelemetry-sdk>=1.31.1
+Requires-Dist: pydantic>=2.11.1
+Description-Content-Type: text/markdown
+
+# Agent Communication Protocol SDK for Python
+
+Agent Communication Protocol SDK for Python provides allows developers to serve and consume agents over the Agent Communication Protocol.
+
+## Prerequisites
+
+✅ Python >= 3.11
+
+## Installation
+
+Install with:
+
+```shell
+pip install acp-sdk
+```
+
+## Quickstart
+
+Register an agent and run the server:
+
+```py
+server = Server()
+
+@server.agent()
+async def echo(inputs: list[Message]):
+    """Echoes everything"""
+    for message in inputs:
+        yield message
+
+server.run(port=8000)
+```
+
+From another process, connect to the server and run the agent:
+
+```py
+async with Client(base_url="http://localhost:8000") as client:
+    run = await client.run_sync(agent="echo", inputs=[Message(parts=[MessagePart(content="Howdy!")])])
+    print(run)
+
+```
+
+
+➡️ Explore more in our [examples library](/examples/python).

{acp_sdk-0.3.2.dist-info → acp_sdk-0.4.0.dist-info}/RECORD

@@ -6,20 +6,20 @@ acp_sdk/client/__init__.py,sha256=Bca1DORrswxzZsrR2aUFpATuNG2xNSmYvF1Z2WJaVbc,51
 acp_sdk/client/client.py,sha256=lEUs0Oc7MZbKkTF2E6e8Wn3dTW5cMVj6fD8TbuEOMDk,6584
 acp_sdk/models/__init__.py,sha256=numSDBDT1QHx7n_Y3Deb5VOvKWcUBxbOEaMwQBSRHxc,151
 acp_sdk/models/errors.py,sha256=rEyaMVvQuBi7fwWe_d0PGGySYsD3FZTluQ-SkC0yhAs,444
-acp_sdk/models/models.py,sha256=J9hnaj5S8p4T3mlVb2iyGD1JuOw0R8JoKqBYDKeZXUw,5318
+acp_sdk/models/models.py,sha256=eOoOfftPKbTaLlqZlE4gE1ZwDkrQ_FdRiDx4wSJILP4,6539
 acp_sdk/models/schemas.py,sha256=Kj7drJSR8d-N3KHzu_qTnLdagrMtAyhid5swluuhHTw,645
 acp_sdk/server/__init__.py,sha256=mxBBBFaZuMEUENRMLwp1XZkuLeT9QghcFmNvjnqvAAU,377
-acp_sdk/server/agent.py,sha256=fGky5MIuknw-Gy-THqhWLt9I9-gUyNIar8qEAvZb3uQ,6195
+acp_sdk/server/agent.py,sha256=DhcPDPDL9jpDST40K_bInvDXfpF1cwxIhqXzu8z0blU,6203
 acp_sdk/server/app.py,sha256=3QJzGi05DKoIKyTeYYKKQhcYz4qorQKmVI94_guVkEY,6340
 acp_sdk/server/bundle.py,sha256=6LZnxsP1rawxic9CwDAQCsOV1v31qNI9meKXMty_yWg,6260
 acp_sdk/server/context.py,sha256=MgnLV6qcDIhc_0BjW7r4Jj1tHts4ZuwpdTGIBnz2Mgo,1036
-acp_sdk/server/errors.py,sha256=IGtpPpb2ChtYvCac8kf_P-RkcY71gBvX0yq97uZWa-w,2104
+acp_sdk/server/errors.py,sha256=GSO8yYIqEeX8Y4Lz86ks35dMTHiQiXuOrLYYx0eXsbI,2110
 acp_sdk/server/logging.py,sha256=Oc8yZigCsuDnHHPsarRzu0RX3NKaLEgpELM2yovGKDI,411
 acp_sdk/server/server.py,sha256=-eT3fmnEsBUN44Spi2EP2eV0l4RAlKa8bzqxnhz16SM,5399
 acp_sdk/server/session.py,sha256=0cDr924HC5x2bBNbK9NSKVHAt5A_mi5dK8P4jP_ugq0,629
 acp_sdk/server/telemetry.py,sha256=1BUxNg-xL_Vqgs27PDWNc3HikrQW2lidAtT_FKlp_Qk,1833
 acp_sdk/server/types.py,sha256=E0_9xWwgGzyvJjxtbeBBmSbIPhbbTSXLpHFL5dZDzxI,182
 acp_sdk/server/utils.py,sha256=EfrF9VCyVk3AM_ao-BIB9EzGbfTrh4V2Bz-VFr6f6Sg,351
-acp_sdk-0.3.2.dist-info/METADATA,sha256=79mXTyM_99E4TYQIIMPEJ-R5WkImcl4IWSbhNe1fc5I,3119
-acp_sdk-0.3.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-acp_sdk-0.3.2.dist-info/RECORD,,
+acp_sdk-0.4.0.dist-info/METADATA,sha256=mkVdNgaCzH9x76Farbq9WTFf0ZFVFfPTVdPDsTGCMao,1546
+acp_sdk-0.4.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+acp_sdk-0.4.0.dist-info/RECORD,,

acp_sdk-0.3.2.dist-info/METADATA

@@ -1,99 +0,0 @@
-Metadata-Version: 2.4
-Name: acp-sdk
-Version: 0.3.2
-Summary: Agent Communication Protocol SDK
-Author: IBM Corp.
-Maintainer-email: Tomas Pilar <thomas7pilar@gmail.com>
-License-Expression: Apache-2.0
-Requires-Python: <4.0,>=3.11
-Requires-Dist: fastapi[standard]>=0.115.8
-Requires-Dist: httpx-sse>=0.4.0
-Requires-Dist: httpx>=0.28.1
-Requires-Dist: janus>=2.0.0
-Requires-Dist: opentelemetry-api>=1.31.1
-Requires-Dist: opentelemetry-exporter-otlp-proto-http>=1.31.1
-Requires-Dist: opentelemetry-instrumentation-fastapi>=0.52b1
-Requires-Dist: opentelemetry-instrumentation-httpx>=0.52b1
-Requires-Dist: opentelemetry-sdk>=1.31.1
-Requires-Dist: pydantic>=2.11.1
-Description-Content-Type: text/markdown
-
-# Agent Communication Protocol SDK for Python
-
-Agent Communication Protocol SDK for Python provides allows developers to serve and consume agents over the Agent Communication Protocol.
-
-## Prerequisites
-
-✅ Python >= 3.11
-
-## Installation
-
-Install with:
-
-```shell
-pip install acp-sdk
-```
-
-## Overview
-
-### Core
-
-The core of the SDK exposes [pydantic](https://docs.pydantic.dev/) data models corresponding to REST API requests, responses, resources, events and errors.
-
-
-### Client
-
-The `client` submodule exposes [httpx](https://www.python-httpx.org/) based client with simple methods for communication over ACP.
-
-```python
-async with Client(base_url="http://localhost:8000") as client:
-    run = await client.run_sync(agent="echo", inputs=[Message(parts=[MessagePart(content="Howdy!")])])
-    print(run)
-
-```
-
-### Server
-
-The `server` submodule exposes `Agent` class and `agent` decorator together with [fastapi](https://fastapi.tiangolo.com/) application factory, making it easy to expose agents over ACP. Additionaly, it exposes [uvicorn](https://www.uvicorn.org/) based server to serve agents with set up logging, [opentelemetry](https://opentelemetry.io/) and more.
-
-```python
-server = Server()
-
-@server.agent()
-async def echo(inputs: list[Message], context: Context) -> AsyncGenerator[RunYield, RunYieldResume]:
-    """Echoes everything"""
-    for message in inputs:
-        yield {"thought": "I should echo everyting"}
-        await asyncio.sleep(0.5)
-        yield message
-
-
-server.run()
-```
-
-➡️ Explore more in our [examples library](/python/examples).
-
-## Architecture
-
-The architecture of the SDK is outlined in the following segment. It focuses on central parts of the SDK without going into much detail.
-
-### Models
-
-The core of the SDK contains pydantic models for requests, responses, resources, events and errors. Users of the SDK are meant to use these models directly or indirectly.
-
-### Server
-
-The server module consists of 3 parts:
-  
-  1. Agent interface
-  2. FastAPI application factory
-  3. Uvicorn based server
-
-Each part builds on top of the previous one. Not all parts need to be used, e.g. users are advised to bring their own ASGI server for production deployments.
-
-### Client
-
-The client module consists of httpx based client with session support. The client is meant to be thin and mimic the REST API. Exception is session management which has been abstracted into a context manager.
-
-
-