Installation

Get Shadai up and running in under 60 seconds.

Requirements

Python 3.10+ (Python 3.12 recommended)

pip or uv package manager

Install via pip

Install via uv (Recommended)

uv is a blazingly fast Python package installer:

Install from Source

For the latest development version:

Verify Installation

Optional Dependencies

Development Tools

Includes:

pytest - Testing framework

pytest-asyncio - Async test support

black - Code formatter

mypy - Type checker

ruff - Fast linter

System Dependencies

Shadai has minimal system dependencies - only aiohttp and pydantic are required. No heavy ML libraries needed!

Troubleshooting

ImportError: No module named 'shadai'

Make sure you're in the correct Python environment:

SSL Certificate Error

If you encounter SSL errors:

Permission Denied

On Linux/Mac, you might need to use --user:

Next Steps

✅ Installation complete! Now let's set up authentication.

→ Authentication Guide

Requirements#

Install via pip#

Install via uv (Recommended)#

Install from Source#

Verify Installation#

Optional Dependencies#

Development Tools#

System Dependencies#

Troubleshooting#

ImportError: No module named 'shadai'#

SSL Certificate Error#

Permission Denied#

Next Steps#