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.

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.2.1.tar.gz (10.7 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.2.1-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ai2web-0.2.1.tar.gz
Algorithm Hash digest
SHA256 a3a495e98bac4a419cfe08e3e46514d0d41f09dc23e04b5430d692acfd7ea0d1
MD5 dec796c4ef7c98b0d8a3d1b627dfce58
BLAKE2b-256 b5d18e2198ef592365ab64844e572eda143d3ddc41a71b0cdeaf56853fe07f44

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: ai2web-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 10.2 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.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6246602fb9b84fef7590f87e6f029b9265f98dd617bee9c4658b157b87839e86
MD5 ed4046b61be31bf628c0ab9e9811bc62
BLAKE2b-256 be1d4c8fb5ccdda48513f383bbab3d246fd5e30c09fd4223afd17b8c6a55986c

See more details on using hashes here.

Provenance

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