Python SDK for BotVisibility — Lighthouse for AI agents. Scan any URL across 58 checks and 5 levels for AI-agent readiness.
Project description
botvisibility (Python SDK)
Python client for BotVisibility — Lighthouse for AI agents. Scan any URL across 58 checks and 5 levels (Discoverable, Usable, Optimized, Indexable, Agent-Native) to see how ready it is for AI agents like Claude and GPT.
Install
pip install botvisibility
Quick start
from botvisibility import Client
with Client() as bv:
result = bv.scan("stripe.com")
print(result.url, "->", f"Level {result.score.level}: {result.level_name} ({result.grade})")
print(f"{result.score.passed} passed / {result.score.failed} failed")
for check in result.failing():
print(f" [{check.id}] {check.name} → {check.recommendation}")
Compare sites
with Client() as bv:
for r in bv.compare(["stripe.com", "twilio.com"]):
print(r.url, r.level_name, r.grade)
Badge URL
Client().badge_url("stripe.com")
# -> "https://botvisibility.com/api/badge?url=stripe.com"
Authentication
Public access needs no credentials. To raise your daily allowance, pass an
OAuth 2.0 scan:read bearer token or an API key:
Client(token="…") # Authorization: Bearer …
Client(api_key="…") # X-API-Key: …
See https://botvisibility.com/auth.md.
Errors
from botvisibility import Client, PaymentRequiredError, InvalidURLError, APIError
try:
Client().scan("example.com")
except PaymentRequiredError as e:
# Over the free allowance — settle via x402 and retry.
print("Pay at", e.paid_endpoint)
except InvalidURLError:
...
except APIError as e:
print(e.status, e.body)
CLI
botvisibility stripe.com # human-readable summary
botvisibility stripe.com --json # raw JSON report
Development
pip install -e ".[dev]"
pytest
License
MIT © Joey Janisheck. Not affiliated with any third party; see https://botvisibility.com.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file botvisibility-0.1.0.tar.gz.
File metadata
- Download URL: botvisibility-0.1.0.tar.gz
- Upload date:
- Size: 7.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b73f59a93ed542dbacb6df86de56e63f72892984a197b1963b55768ab4cc653a
|
|
| MD5 |
475ab65611e256151ec79507814beddf
|
|
| BLAKE2b-256 |
8351d74d60d966267867171fc8667617b954a2f3338ec7e537e86713e36ffaf9
|
File details
Details for the file botvisibility-0.1.0-py3-none-any.whl.
File metadata
- Download URL: botvisibility-0.1.0-py3-none-any.whl
- Upload date:
- Size: 8.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
145b1f6d849a810d3305ba8ab0d751a2c52b4563d9d8091a3f30104eb8a3c6b6
|
|
| MD5 |
38daa01122d9e835402c3bbbc4d5e543
|
|
| BLAKE2b-256 |
24e4ad1f9950f809cca2ac9ff19adc8234c8ac4ea8ec3170b042055991ebc9cd
|