Skip to main content

AI2Web (ai2w) Python SDK - capability model, manifest builder, validator, negotiation, server handler.

Project description

AI2Web Python SDK (ai2web)

CI PyPI Python versions

The Python reference implementation of the AI2Web protocol - for Django, Flask, FastAPI, or plain Python. Mirrors @ai2web/core.

pip install ai2web
from ai2web import ai2web, validate, handle

manifest = (
    ai2web({"name": "Example Store", "url": "https://example.com", "type": "ecommerce"})
    .capability("content")
    .capability("commerce", {"endpoint": "/ai2w/products", "checkout": True})
    .transports({"mcp": {"enabled": True, "endpoint": "/ai2w/mcp"}, "rest": {"enabled": True}})
    .auth({"methods": ["none", "oauth2"], "oauth2": {"pkce": True, "scopes": ["checkout"]}})
    .consent({"requires_user_approval_for": ["purchase"]})
    .contact({"support": "help@example.com"})
    .build()
)

result = validate(manifest)          # {'score': 90+, 'tier': 'Standard', ...}

# Serve every AI2Web route from one call (framework-agnostic):
res = handle({"manifest": manifest}, method, path, body, origin)

Modules

  • ai2web.manifest - fluent capability-model builder (ai2web(...), Manifest).
  • ai2web.validator - validate() + AI Readiness scoring (spec §9/§11).
  • ai2web.negotiator - negotiate() capability negotiation (spec §5).
  • ai2web.server - handle() framework-agnostic route handler.
  • ai2web.safety - is_safe_public_url() / assert_safe_public_url() SSRF guard.
  • ai2web.export - to_llms_txt() / to_agent_json() projections of the manifest (RFC-0015).

The builder also carries the v0.2 optional modules - .governance(...), .usage_policy(...), .legal(...), .agent_identity(...), .knowledge(...) - and actions accept intent and bindings. All are additive: a minimal manifest stays valid without them.

Test

python tests/run.py     # dependency-free; includes the shared conformance contract

Requires Python 3.9+. Zero runtime dependencies.

Licence

MIT.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ai2web-0.3.0.tar.gz (13.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ai2web-0.3.0-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

File details

Details for the file ai2web-0.3.0.tar.gz.

File metadata

  • Download URL: ai2web-0.3.0.tar.gz
  • Upload date:
  • Size: 13.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ai2web-0.3.0.tar.gz
Algorithm Hash digest
SHA256 1174bfe5652cc7c473dd4997f41f1d8e4dcef2a4a385839a9d90cd33736d1102
MD5 b68a1c06aaf150fa390ce9006eb310a4
BLAKE2b-256 98f15f554455abed5d1aee93388f890bb774f7b3b238ac76c5ed61e7293e31a0

See more details on using hashes here.

Provenance

The following attestation bundles were made for ai2web-0.3.0.tar.gz:

Publisher: publish.yml on ai2web-foundation/ai2web-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ai2web-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: ai2web-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 12.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ai2web-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 64158ced4291fdddda365fbc1294bdf1b3ba4e01492ce7f936ef435f3d9b7e2c
MD5 76a3b784c54b0252e39adc00b989d8d3
BLAKE2b-256 f4eca1d8d704e86dc4a1c8095f232e346a9b51550ceef6f2397db8295844a528

See more details on using hashes here.

Provenance

The following attestation bundles were made for ai2web-0.3.0-py3-none-any.whl:

Publisher: publish.yml on ai2web-foundation/ai2web-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page