Skip to content

Installation

Prerequisites

  • Python ≥ 3.11, < 3.14
  • uv — used for dependency management and virtual environments

If you don't have uv installed:

curl -LsSf https://astral.sh/uv/install.sh | sh

Setup

Clone the repository and install dependencies:

git clone https://github.com/silence-laboratories/ap3.git
cd ap3

Install all dependencies and create the virtual environment:

uv sync

Activate the virtual environment:

source .venv/bin/activate  # macOS / Linux

Verify Installation

Run a quick import check to confirm everything is working:

import ap3
from ap3 import Operation, PrivacyIntentDirective

print(ap3.__version__)  # 1.0.0

Dependencies

The SDK pulls in the following core dependencies automatically:

  • Core: pydantic, httpx, cryptography
  • Optional (A2A hosting/client): install with ap3[a2a] which brings in a2a-sdk[http-server] plus server/runtime deps.

Project Structure

After cloning, the SDK source lives under src/ap3/:

ap3/
├── src/ap3/
│   ├── types/          # Core types, directives, and error models
│   ├── core/           # Base Operation contract for protocol implementations
│   ├── signing/        # Ed25519 signing primitives for directives/commitments
│   ├── services/       # Commitment metadata + discovery + compatibility
│   └── integrations/   # Framework integrations (CrewAI, Google ADK, LangChain)
├── ap3operations/      # Protocol implementations (e.g., PSI)
├── examples/           # Working examples
├── tests/              # Test suite
└── docs/               # This documentation

Next Steps

  1. Configure your environment — set up API keys
  2. Quickstart — understand the AP3 extension model
  3. API Reference — explore the SDK surface

Support

If you run into issues: