Skip to main content

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.

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.4.0.tar.gz (13.9 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.4.0-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ai2web-0.4.0.tar.gz
Algorithm Hash digest
SHA256 6bbdf126f9a394f05f5e12ff9dd977e39677c44e5afa221f1a7f000fde07c2c0
MD5 1d30531e89fe3438a93cb1b4668b5474
BLAKE2b-256 ab2c082ef54f8f9ea5b639c4c0f34cc1bd5cb2cac1b0c8b19cba94b4db676b17

See more details on using hashes here.

Provenance

The following attestation bundles were made for ai2web-0.4.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.4.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for ai2web-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a9c772ac58718cce04bb37c806406ebe89dab117bbd2a4d26a6659e8cc4228d8
MD5 c518494ec61b45547976bdcfd98a217d
BLAKE2b-256 5fb11492c482b177c48394c3b8679b77012928f877dd3b895c994f2f070dc3a6

See more details on using hashes here.

Provenance

The following attestation bundles were made for ai2web-0.4.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.

Release history Release notifications | RSS feed

0.4.2

2 files

0.4.1

2 files

This release

0.4.0 This release

2 files

0.3.0

2 files

0.2.1

2 files

0.2.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page