Installation

Installation Guide

Requirements

• Python 3.8 or higher
• pip (Python package manager)

Basic Installation

Install PipeFrame using pip:

pip install pipeframe

That's it! You're ready to use PipeFrame.

Verify Installation

import pipeframe
print(pipeframe.__version__)  # Should print: 0.2.0

Optional Dependencies

PipeFrame supports optional features through extra dependencies:

Excel Support

pip install pipeframe[excel]

Includes: openpyxl, xlrd

Parquet Support

pip install pipeframe[parquet]

Includes: pyarrow

SQL Support

pip install pipeframe[sql]

Includes: sqlalchemy

Plotting Support

pip install pipeframe[plot]

Includes: matplotlib, seaborn, plotnine

All Optional Dependencies

pip install pipeframe[all]

Development Installation

For contributing to PipeFrame:

# Clone the repository
git clone https://github.com/Yasser03/pipeframe.git
cd pipeframe

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

# Install in editable mode with dev dependencies
pip install -e ".[dev,test]"

Upgrading

To upgrade to the latest version:

pip install --upgrade pipeframe

Uninstalling

pip uninstall pipeframe

Troubleshooting

Import Error

If you get an import error, make sure pipeframe is installed:

pip list | grep pipeframe

Version Conflicts

If you have dependency conflicts, try creating a fresh virtual environment:

python -m venv fresh_env
source fresh_env/bin/activate
pip install pipeframe

Windows-Specific Issues

On Windows, if you encounter path issues, try:

python -m pip install pipeframe

Next Steps

• Quick Start Guide - Learn the basics
• Examples - See PipeFrame in action
• API Reference - Explore all functions