Installation - PraisonAI PPT

Installation Guide

📋 Requirements

• Python 3.7 or higher
• python-pptx library (automatically installed)
• PyYAML library (automatically installed)

Optional for PDF Conversion

Choose one of the following:

• Aspose.Slides (Recommended): Commercial library with high-quality conversion

  pip install praisonaippt[pdf-aspose]
  

• LibreOffice (Free): Requires LibreOffice installation on your system
  • Download from libreoffice.org
  • Works on Windows, macOS, and Linux

🚀 Installation Methods

Method 1: Install from PyPI (Recommended)

# Using pip
pip install praisonaippt

# Or using uv (faster)
uv pip install praisonaippt

Method 2: Install with PDF Support

# With Aspose.Slides (commercial, high quality)
pip install praisonaippt[pdf-aspose]

# With all PDF features
pip install praisonaippt[pdf-all]

Method 3: Development Installation

# Clone the repository
git clone https://github.com/MervinPraison/PraisonAIPPT.git
cd PraisonAIPPT

# Install in editable mode
pip install -e .

# Or with uv
uv install -e .

Method 4: Install from Source

# Clone the repository
git clone https://github.com/MervinPraison/PraisonAIPPT.git
cd PraisonAIPPT

# Install with pip
pip install .

# Or with uv
uv install .

🔧 Verification

After installation, verify everything is working:

# Check version
praisonaippt --version

# Test basic functionality
praisonaippt --help

# Test PDF conversion (if installed)
praisonaippt convert-pdf --help

Python API Verification

# Test import
import praisonaippt
print(f"PraisonAI PPT version: {praisonaippt.__version__}")

# Test PDF conversion availability
try:
    from praisonaippt import convert_pptx_to_pdf, PDFOptions
    print("✅ PDF conversion available")
except ImportError:
    print("❌ PDF conversion not available")

📦 Package Contents

When you install praisonaippt, you get:

• CLI Tool: praisonaippt command-line interface
• Python API: Full programmatic access
• PDF Conversion: Optional PDF export capabilities
• Examples: Built-in example files
• Documentation: Complete usage guides

🌍 Platform Support

Supported Operating Systems

• ✅ Windows - Full support including PDF conversion
• ✅ macOS - Full support including PDF conversion
• ✅ Linux - Full support including PDF conversion

Python Versions

• ✅ Python 3.7 - Supported
• ✅ Python 3.8 - Supported
• ✅ Python 3.9 - Supported
• ✅ Python 3.10 - Supported
• ✅ Python 3.11 - Supported
• ✅ Python 3.12 - Supported

🔍 Troubleshooting Installation

Common Issues

1. Permission Denied

# Use user installation
pip install --user praisonaippt

# Or use sudo (not recommended)
sudo pip install praisonaippt

2. Python Not Found

# On macOS with Homebrew
brew install python3

# On Ubuntu/Debian
sudo apt-get install python3 python3-pip

# On Windows
# Download from python.org

3. PDF Conversion Not Working

# Install LibreOffice (free option)
# Ubuntu/Debian:
sudo apt-get install libreoffice

# macOS:
brew install --cask libreoffice

# Windows:
# Download from libreoffice.org

# Or install Aspose.Slides (commercial)
pip install praisonaippt[pdf-aspose]

4. Virtual Environment Issues

# Create new virtual environment
python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install in clean environment
pip install praisonaippt[pdf-all]

📚 Dependencies

Core Dependencies

• python-pptx>=0.6.21 - PowerPoint file creation
• PyYAML>=6.0 - YAML file support

Optional PDF Dependencies

• aspose.slides>=24.0.0 - Commercial PDF conversion
• psutil>=5.9.0 - System utilities (for LibreOffice)
• tqdm>=4.64.0 - Progress bars

Development Dependencies

• pytest - Testing framework
• black - Code formatting
• flake8 - Linting

🎯 Next Steps

After successful installation:

1. Quick Start Tutorial
2. Complete Command Reference
3. Python API Documentation
4. PDF Conversion Guide

💡 Pro Tips

• Use virtual environments to avoid conflicts
• Install with [pdf-all] for full functionality
• Use uv for faster installation (if available)
• Check version after installation to verify success
• Test PDF conversion before using in production

Need help? Open an issue on GitHub