Installation Extras

Documentation Index

Fetch the complete documentation index at: https://docs.praison.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

Quick Start

# Basic agent development
pip install praisonai

# Bot integrations (Telegram, Discord, Slack)
pip install "praisonai[bot]"

# Gateway server with WebSocket/REST
pip install "praisonai[api]"

# Gateway + bots (most common)
pip install "praisonai[bot,api]"

# Everything included
pip install "praisonai[all]"

# Test core functionality
from praisonaiagents import Agent
agent = Agent(name="test", instructions="Hello")

# Test bot integration (if [bot] installed)
from praisonai.bots import TelegramBot

# Test gateway (if [api] installed)
from praisonai.gateway import WebSocketGateway

# Error: Gateway requires starlette and uvicorn
pip install "praisonai[api]"

# Error: No module named 'python-telegram-bot'
pip install "praisonai[bot]"

​

Available Extras

​

Bot Integration ([bot])

pip install "praisonai[bot]"

• python-telegram-bot - Telegram bot API
• discord.py - Discord bot integration
• slack-sdk - Slack app development
• twilio - WhatsApp Business API
• requests - HTTP client for webhooks

• Telegram bot deployment
• Discord server integration
• Slack workspace apps
• WhatsApp Business messaging
• Multi-platform chat bots

from praisonai.bots import TelegramBot, DiscordBot

telegram = TelegramBot(token="your_token")
discord = DiscordBot(token="your_token")

​

API Server ([api])

pip install "praisonai[api]"

• uvicorn - ASGI server
• fastapi - Web framework
• starlette - WebSocket support
• python-multipart - File upload handling
• websockets - WebSocket protocol

• PraisonAI Gateway deployment
• REST API endpoints
• WebSocket real-time communication
• Agent-as-a-Service hosting
• Dashboard and UI backends

from praisonai.gateway import WebSocketGateway
from praisonaiagents.gateway import GatewayConfig

config = GatewayConfig(host="127.0.0.1", port=8765)
gateway = WebSocketGateway(config=config)

​

Tools Collection ([tools])

pip install "praisonai[tools]"

• tavily-python - Web search API
• requests - HTTP requests
• beautifulsoup4 - HTML parsing
• PyPDF2 - PDF processing
• python-docx - Word document handling

• Web search capabilities
• Document processing
• File format conversion
• Data extraction and parsing
• Research and analysis

​

Storage Backends ([storage])

pip install "praisonai[storage]"

• chromadb - Vector database
• qdrant-client - Qdrant vector store
• pinecone-client - Pinecone vector database
• redis - Redis caching
• pymongo - MongoDB integration

• Knowledge base storage
• Vector similarity search
• Session state persistence
• Caching and performance
• Multi-agent coordination

​

Complete Installation ([all])

pip install "praisonai[all]"

• Development environments
• Full-featured deployments
• Experimenting with all features
• Production systems using multiple capabilities

​

Common Use Cases

​

Gateway Deployment

pip install "praisonai[bot,api]"

• [bot] provides Telegram, Discord, Slack integration
• [api] provides gateway WebSocket server and REST endpoints

# gateway.yaml
gateway:
  host: "127.0.0.1"
  port: 8765

channels:
  telegram:
    platform: telegram
    token: ${TELEGRAM_BOT_TOKEN}

​

Agent Development

pip install praisonai
# No extras needed for core agent functionality

from praisonaiagents import Agent

agent = Agent(
    name="researcher", 
    instructions="Research topics thoroughly",
    model="gpt-4o-mini"
)

​

Production Bot

pip install "praisonai[all]"

• Bot platform integration
• Web search and document processing
• Vector knowledge storage
• REST API for monitoring
• All available tools and integrations

​

Installation Troubleshooting

​

Common Import Errors

ImportError: Gateway requires starlette and uvicorn.
Install with: pip install praisonai[api]

pip install "praisonai[api]"
# or
pip install "praisonai[bot,api]" # for bot + gateway

ModuleNotFoundError: No module named 'python-telegram-bot'

pip install "praisonai[bot]"

ModuleNotFoundError: No module named 'chromadb'

pip install "praisonai[storage]"
# or
pip install "praisonai[all]"

$env:PYTHONUTF8 = "1"
pip install "praisonai[bot,api]"

# Install Visual Studio Build Tools
# or use conda-forge
conda install -c conda-forge praisonai

​

Dependency Conflicts

# Clean installation
pip uninstall praisonai
pip cache purge

# Reinstall with specific extras
pip install "praisonai[bot,api]==latest"

# Check for conflicts
pip check

​

Minimal Installation

# Core only (smallest footprint)
pip install praisonai --no-deps
pip install openai  # Manual essential deps

# Specific platform only
pip install "praisonai[bot]" --no-deps
pip install python-telegram-bot openai

​

Extra Dependency Reference

​

Platform-Specific Notes

• Some packages may require Visual Studio Build Tools
• UTF-8 encoding setup recommended: $env:PYTHONUTF8 = "1"
• Consider using conda for complex dependencies

• May require Xcode Command Line Tools
• Install via Homebrew Python for best compatibility

• Usually installs without issues
• May need system packages for some features (e.g., libssl-dev)

​

Best Practices

# Create dedicated environment
python -m venv praisonai-env
source praisonai-env/bin/activate  # Linux/macOS
# or
praisonai-env\Scripts\activate     # Windows

# Install with extras
pip install "praisonai[bot,api]"

# requirements.txt
praisonai[bot,api]==1.2.3
python-telegram-bot==20.7
fastapi==0.104.1

# Development: everything
pip install "praisonai[all]"

# Production bot: minimal
pip install "praisonai[bot]"

# Gateway only: minimal  
pip install "praisonai[api]"

# Check for vulnerabilities
pip-audit

# Update safely
pip install --upgrade "praisonai[all]"
pip check  # Verify no conflicts

​

Related