oo-a2a-registry 0.1.0__tar.gz

oo_a2a_registry-0.1.0/.gitignore

@@ -0,0 +1,221 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Agent settings
+.claude

oo_a2a_registry-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

oo_a2a_registry-0.1.0/PKG-INFO

@@ -0,0 +1,229 @@
+Metadata-Version: 2.4
+Name: oo-a2a-registry
+Version: 0.1.0
+Summary: Server and client library for A2A agent discovery via heartbeat registration
+Project-URL: Homepage, https://github.com/obics-eu/oo-a2a-registry
+Project-URL: Issues, https://github.com/obics-eu/oo-a2a-registry/issues
+License: MIT
+License-File: LICENSE
+Keywords: a2a,agent,agent-to-agent,discovery,fastapi,registry
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: fastapi>=0.100.0
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: dev
+Requires-Dist: httpx>=0.24.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: respx>=0.20; extra == 'dev'
+Requires-Dist: uvicorn[standard]>=0.20.0; extra == 'dev'
+Provides-Extra: server
+Requires-Dist: uvicorn[standard]>=0.20.0; extra == 'server'
+Description-Content-Type: text/markdown
+
+# oo-a2a-registry
+
+Fast and lean AI agent registry implementing the [A2A protocol](https://a2a-protocol.org/) for agent discovery via heartbeat-based registration.
+
+Supports **A2A v0.3** (top-level `url` field, `agent.json` discovery) and **A2A v1.0** (`supportedInterfaces`, `agent-card.json` discovery).
+
+## Overview
+
+| Component | What it does |
+|-----------|--------------|
+| **Server** | Exposes `GET /.well-known/agents` returning live A2A agent cards. Accepts `POST /registry/heartbeat` from clients. Verifies agents by fetching their well-known card (`agent-card.json` or `agent.json`). Evicts agents that miss more than 3 consecutive heartbeats. |
+| **Client** | Sends the agent's `AgentCard` to the registry on a configurable interval (default 60 s) as a background task. |
+
+## Installation
+
+```bash
+pip install oo-a2a-registry                   # client + server (no ASGI server)
+pip install "oo-a2a-registry[server]"         # includes uvicorn
+```
+
+## Quick start
+
+### Standalone registry server
+
+```python
+import uvicorn
+from a2a_registry import AgentRegistryServer
+
+server = AgentRegistryServer()
+app = server.create_app()
+
+if __name__ == "__main__":
+    uvicorn.run(app, host="0.0.0.0", port=8000)
+```
+
+### Mount into an existing FastAPI app
+
+```python
+from fastapi import FastAPI
+from a2a_registry import AgentRegistryServer
+
+app = FastAPI()
+registry = AgentRegistryServer()
+registry.setup(app)          # adds /.well-known/agents and /registry/heartbeat
+```
+
+### Agent client — A2A v0.3
+
+```python
+import asyncio
+from a2a_registry import AgentCard, RegistryClient
+
+card = AgentCard(
+    name="My Agent",
+    url="http://my-agent:8080",   # agent must serve /.well-known/agent.json
+    version="1.0.0",
+)
+
+async def main():
+    async with RegistryClient("http://registry:8000", card, interval=30) as client:
+        await asyncio.sleep(300)   # heartbeats run in the background
+
+asyncio.run(main())
+```
+
+### Agent client — A2A v1.0
+
+```python
+import asyncio
+from a2a_registry import AgentCard, AgentInterface, RegistryClient
+
+card = AgentCard(
+    name="My Agent",
+    supportedInterfaces=[
+        AgentInterface(
+            url="http://my-agent:8080/jsonrpc",
+            protocolBinding="json-rpc/2.0",
+            protocolVersion="1.0",
+        )
+    ],
+    version="1.0.0",
+)
+
+async def main():
+    async with RegistryClient("http://registry:8000", card, interval=30) as client:
+        await asyncio.sleep(300)
+
+asyncio.run(main())
+```
+
+### Send a single heartbeat
+
+```python
+client = RegistryClient("http://registry:8000", card)
+result = await client.send_once()
+print(result.verified)
+```
+
+## Examples
+
+Runnable examples are in the [`examples/`](examples/) directory:
+
+| File | Description |
+|------|-------------|
+| [`registry_server.py`](examples/registry_server.py) | Standalone registry on port 8000 |
+| [`hello_world_agent.py`](examples/hello_world_agent.py) | Hello World agent (A2A v0.3) on port 8001 |
+| [`hello_world_agent_v1.py`](examples/hello_world_agent_v1.py) | Hello World agent (A2A v1.0) on port 8002 |
+
+```bash
+pip install "oo-a2a-registry[server]"
+python examples/registry_server.py &
+python examples/hello_world_agent.py &
+curl -s http://localhost:8000/.well-known/agents | python -m json.tool
+```
+
+## A2A version compatibility
+
+The registry accepts agent cards from both protocol versions and auto-detects the discovery path.
+
+| | A2A v0.3 | A2A v1.0 |
+|---|---|---|
+| Agent URL field | top-level `url` | `supportedInterfaces[].url` |
+| Discovery path | `/.well-known/agent.json` | `/.well-known/agent-card.json` |
+| Protocol version | `protocolVersion` (card-level) | `supportedInterfaces[].protocolVersion` |
+
+Cards without a top-level `url` must provide `supportedInterfaces`. The registry uses `AgentCard.effective_url` as the canonical key (returns `url` for v0.3, `supportedInterfaces[0].url` for v1.0).
+
+When verifying an agent the registry tries the preferred discovery path first (based on which fields the heartbeat card has) and falls back to the other automatically.
+
+## How it works
+
+```
+Agent                          Registry Server
+  |                                  |
+  |-- POST /registry/heartbeat ----> |
+  |   { agent_card, interval }       |
+  |                                  |-- GET {origin}/.well-known/agent-card.json  (v1.0)
+  |                                  |       — or —
+  |                                  |-- GET {origin}/.well-known/agent.json       (v0.3)
+  |                                  |   (once, to verify reachability)
+  |                                  |-- store as "available"
+  |<-- { status: "ok", verified } -- |
+  |                                  |
+  |-- POST /registry/heartbeat ----> |  (every `interval` seconds)
+  |                                  |-- refresh last_heartbeat timestamp
+  |                                  |
+  |   (silence > 3 × interval)       |-- evict from registry
+```
+
+`GET /.well-known/agents` returns only agents with `status == available`.
+
+## Custom storage backend
+
+Implement `RegistryProvider` to plug in Redis, a database, etc.:
+
+```python
+from a2a_registry.server import RegistryProvider
+
+class RedisRegistryProvider(RegistryProvider):
+    async def upsert(self, agent_card, interval): ...
+    async def get(self, agent_url): ...
+    async def mark_verified(self, agent_url): ...
+    async def unregister(self, agent_url): ...
+    async def list_available(self): ...
+    async def get_stale(self, multiplier=3): ...
+
+server = AgentRegistryServer(provider=RedisRegistryProvider())
+```
+
+## Configuration
+
+| Parameter | Default | Description |
+|-----------|---------|-------------|
+| `stale_multiplier` | `3` | Evict agent after `multiplier × interval` seconds of silence |
+| `cleanup_interval` | `30` | Seconds between cleanup sweeps |
+| `fetch_timeout` | `10.0` | Timeout for fetching remote agent cards |
+| `interval` (client) | `60` | Heartbeat interval in seconds |
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+```
+
+## Publishing
+
+```bash
+pip install build twine
+python -m build
+twine upload dist/*
+```
+
+## License
+
+MIT

oo_a2a_registry-0.1.0/README.md

@@ -0,0 +1,196 @@
+# oo-a2a-registry
+
+Fast and lean AI agent registry implementing the [A2A protocol](https://a2a-protocol.org/) for agent discovery via heartbeat-based registration.
+
+Supports **A2A v0.3** (top-level `url` field, `agent.json` discovery) and **A2A v1.0** (`supportedInterfaces`, `agent-card.json` discovery).
+
+## Overview
+
+| Component | What it does |
+|-----------|--------------|
+| **Server** | Exposes `GET /.well-known/agents` returning live A2A agent cards. Accepts `POST /registry/heartbeat` from clients. Verifies agents by fetching their well-known card (`agent-card.json` or `agent.json`). Evicts agents that miss more than 3 consecutive heartbeats. |
+| **Client** | Sends the agent's `AgentCard` to the registry on a configurable interval (default 60 s) as a background task. |
+
+## Installation
+
+```bash
+pip install oo-a2a-registry                   # client + server (no ASGI server)
+pip install "oo-a2a-registry[server]"         # includes uvicorn
+```
+
+## Quick start
+
+### Standalone registry server
+
+```python
+import uvicorn
+from a2a_registry import AgentRegistryServer
+
+server = AgentRegistryServer()
+app = server.create_app()
+
+if __name__ == "__main__":
+    uvicorn.run(app, host="0.0.0.0", port=8000)
+```
+
+### Mount into an existing FastAPI app
+
+```python
+from fastapi import FastAPI
+from a2a_registry import AgentRegistryServer
+
+app = FastAPI()
+registry = AgentRegistryServer()
+registry.setup(app)          # adds /.well-known/agents and /registry/heartbeat
+```
+
+### Agent client — A2A v0.3
+
+```python
+import asyncio
+from a2a_registry import AgentCard, RegistryClient
+
+card = AgentCard(
+    name="My Agent",
+    url="http://my-agent:8080",   # agent must serve /.well-known/agent.json
+    version="1.0.0",
+)
+
+async def main():
+    async with RegistryClient("http://registry:8000", card, interval=30) as client:
+        await asyncio.sleep(300)   # heartbeats run in the background
+
+asyncio.run(main())
+```
+
+### Agent client — A2A v1.0
+
+```python
+import asyncio
+from a2a_registry import AgentCard, AgentInterface, RegistryClient
+
+card = AgentCard(
+    name="My Agent",
+    supportedInterfaces=[
+        AgentInterface(
+            url="http://my-agent:8080/jsonrpc",
+            protocolBinding="json-rpc/2.0",
+            protocolVersion="1.0",
+        )
+    ],
+    version="1.0.0",
+)
+
+async def main():
+    async with RegistryClient("http://registry:8000", card, interval=30) as client:
+        await asyncio.sleep(300)
+
+asyncio.run(main())
+```
+
+### Send a single heartbeat
+
+```python
+client = RegistryClient("http://registry:8000", card)
+result = await client.send_once()
+print(result.verified)
+```
+
+## Examples
+
+Runnable examples are in the [`examples/`](examples/) directory:
+
+| File | Description |
+|------|-------------|
+| [`registry_server.py`](examples/registry_server.py) | Standalone registry on port 8000 |
+| [`hello_world_agent.py`](examples/hello_world_agent.py) | Hello World agent (A2A v0.3) on port 8001 |
+| [`hello_world_agent_v1.py`](examples/hello_world_agent_v1.py) | Hello World agent (A2A v1.0) on port 8002 |
+
+```bash
+pip install "oo-a2a-registry[server]"
+python examples/registry_server.py &
+python examples/hello_world_agent.py &
+curl -s http://localhost:8000/.well-known/agents | python -m json.tool
+```
+
+## A2A version compatibility
+
+The registry accepts agent cards from both protocol versions and auto-detects the discovery path.
+
+| | A2A v0.3 | A2A v1.0 |
+|---|---|---|
+| Agent URL field | top-level `url` | `supportedInterfaces[].url` |
+| Discovery path | `/.well-known/agent.json` | `/.well-known/agent-card.json` |
+| Protocol version | `protocolVersion` (card-level) | `supportedInterfaces[].protocolVersion` |
+
+Cards without a top-level `url` must provide `supportedInterfaces`. The registry uses `AgentCard.effective_url` as the canonical key (returns `url` for v0.3, `supportedInterfaces[0].url` for v1.0).
+
+When verifying an agent the registry tries the preferred discovery path first (based on which fields the heartbeat card has) and falls back to the other automatically.
+
+## How it works
+
+```
+Agent                          Registry Server
+  |                                  |
+  |-- POST /registry/heartbeat ----> |
+  |   { agent_card, interval }       |
+  |                                  |-- GET {origin}/.well-known/agent-card.json  (v1.0)
+  |                                  |       — or —
+  |                                  |-- GET {origin}/.well-known/agent.json       (v0.3)
+  |                                  |   (once, to verify reachability)
+  |                                  |-- store as "available"
+  |<-- { status: "ok", verified } -- |
+  |                                  |
+  |-- POST /registry/heartbeat ----> |  (every `interval` seconds)
+  |                                  |-- refresh last_heartbeat timestamp
+  |                                  |
+  |   (silence > 3 × interval)       |-- evict from registry
+```
+
+`GET /.well-known/agents` returns only agents with `status == available`.
+
+## Custom storage backend
+
+Implement `RegistryProvider` to plug in Redis, a database, etc.:
+
+```python
+from a2a_registry.server import RegistryProvider
+
+class RedisRegistryProvider(RegistryProvider):
+    async def upsert(self, agent_card, interval): ...
+    async def get(self, agent_url): ...
+    async def mark_verified(self, agent_url): ...
+    async def unregister(self, agent_url): ...
+    async def list_available(self): ...
+    async def get_stale(self, multiplier=3): ...
+
+server = AgentRegistryServer(provider=RedisRegistryProvider())
+```
+
+## Configuration
+
+| Parameter | Default | Description |
+|-----------|---------|-------------|
+| `stale_multiplier` | `3` | Evict agent after `multiplier × interval` seconds of silence |
+| `cleanup_interval` | `30` | Seconds between cleanup sweeps |
+| `fetch_timeout` | `10.0` | Timeout for fetching remote agent cards |
+| `interval` (client) | `60` | Heartbeat interval in seconds |
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+```
+
+## Publishing
+
+```bash
+pip install build twine
+python -m build
+twine upload dist/*
+```
+
+## License
+
+MIT