Installation Guide

WPipe is distributed via PyPI and is designed to be lightweight with minimal external dependencies.

1. Requirements

Most users should install the stable release via pip:

pip install wpipe

If you need specific development tools or the latest source code:

Development

Includes testing frameworks (pytest, ruff, mypy).

pip install "wpipe[dev]"

Documentation

Includes Sphinx and themes for building these docs locally.

pip install "wpipe[docs]"

Source (Bleeding Edge)

git clone https://github.com/wisrovi/wpipe
cd wpipe
pip install -e .

For cloud deployments, we recommend using the official Python slim images.

FROM python:3.11-slim
RUN pip install wpipe
COPY my_pipeline.py .
CMD ["python", "my_pipeline.py"]

Ensure the engine is correctly balanced:

import wpipe
print(wpipe.__version__)  # Should return 2.4.0

Issue	Solution
SQLite Error	Ensure your filesystem supports file locking (required for WAL mode).
Memory Limit Failed	`memory_limit` utilities require Linux cgroups. Use Docker if on Windows/Mac.
Module Not Found	Ensure your virtual environment is active.