Skip to main content

​
Overview

ExuluPython provides seamless integration with Python-powered features in the Exulu backend, including advanced document processing with Docling. The integration handles Python environment setup automatically, requiring minimal configuration.

​
Features

  • Automatic Setup: Python environment configured on package installation
  • Zero Configuration: Works out of the box for most users
  • Type-Safe: Full TypeScript support with proper types
  • Error Handling: Clear error messages guide you through any issues
  • Enterprise-Grade: Uses Docling for high-quality document parsing

​
Quick Start

​
Automatic Installation

When you install @exulu/backend, the Python environment is set up automatically: 
npm install @exulu/backend
The postinstall script will:
  • Check for Python 3.10+
  • Create a virtual environment
  • Install required dependencies
  • Validate the installation

​
Manual Setup (Optional)

If automatic setup was skipped or failed, you can set it up manually: 
import { ExuluPython } from '@exulu/backend';

const result = await ExuluPython.setup();

if (result.success) {
  console.log('✓ Python environment ready!');
} else {
  console.error('Setup failed:', result.message);
}

​
Environment Variables

​
Skip Automatic Setup

To skip automatic Python setup during installation: 
SKIP_PYTHON_SETUP=1 npm install @exulu/backend

​
Enable Setup in CI

By default, setup is skipped in CI environments. To enable it: 
SETUP_PYTHON_IN_CI=1 npm install @exulu/backend

​
Requirements

  • Python: 3.10 or higher
  • pip: Latest version (auto-upgraded during setup)
  • Disk Space: ~500MB for Python packages

​
Installing Python

brew install python@3.12

​
Next Steps

Configuration

Learn how to configure and manage the Python environment

API Reference

Explore the complete API documentation