Installation¶

Requirements¶

Python 3.11 or newer
pip (or uv, recommended)

The library itself has only two runtime dependencies: pydantic and typer. API adapters and advanced detectors are in optional extras so the base install stays light.

Install from PyPI¶

pip install chatbot-auditor

Or with uv (faster, isolated):

uv add chatbot-auditor

Optional extras¶

Choose the extras you need based on your data sources and features:

Extra	Adds	Install
`intercom`	Intercom REST API adapter (`httpx`)	`pip install "chatbot-auditor[intercom]"`
`zendesk`	Zendesk REST API adapter (`httpx`)	`pip install "chatbot-auditor[zendesk]"`
`llm`	Optional local model backends (`sentence-transformers`, `scikit-learn`)	`pip install "chatbot-auditor[llm]"`
`server`	FastAPI + uvicorn for the self-hosted service	`pip install "chatbot-auditor[server]"`

Install multiple at once:

pip install "chatbot-auditor[intercom,zendesk]"

Verify the install¶

chatbot-audit version

You should see:

chatbot-auditor 0.0.1
Copyright 2026 BK
License: Apache-2.0

Install from source (for contributors)¶

git clone https://github.com/HemantBK/chatbot-auditor.git
cd chatbot-auditor
uv sync --all-extras
uv run pytest

See CONTRIBUTING for the full developer workflow.