Installation Guide

Prerequisites

Luminara requires Python 3.9+. We recommend using a virtual environment (venv, poetry, or conda) to manage dependencies.

Standard Installation

The core package can be installed from PyPI using pip:

pip install luminara

Optional Dependencies

Luminara provides integrations with various databases and message queues. You can install specific dependencies as needed:

Redis Integration

For Redis pub/sub and list operations:

pip install "luminara[redis]"

PostgreSQL Connector

Async PostgreSQL support via asyncpg:

pip install "luminara[postgres]"

Full Installation

To install all optional dependencies (including Kafka, RabbitMQ, and Cloud Storage):

pip install "luminara[all]"

Using Docker

We provide official Docker images for running Luminara pipelines in containerized environments. The base image is built on Alpine Linux.

docker pull ghcr.io/luminara-dev/luminara:latest

Example usage:

docker run -v $(pwd)/pipeline.yaml:/app/pipeline.yaml luminara run pipeline.yaml

Building from Source

If you want to contribute or use the latest development version, you can clone the repository and install manually:

git clone https://github.com/luminara-dev/luminara.git
cd luminara
pip install -e .

Running Tests

To verify the installation, you can run the test suite using pytest:

pip install pytest pytest-asyncio
pytest tests/