Skip to content

Installation Guide

Prerequisites

  • Python 3.12 or higher
  • pip or uv package manager
  • Python 3.12 or higher (from python.org or Microsoft Store)
  • Git for Windows (for development installation)
  • Optional: uv package manager
# Install Python 3.12+ (Ubuntu/Debian example)
sudo apt update
sudo apt install python3 python3-pip git

# Install uv (optional)
curl -LsSf https://astral.sh/uv/install.sh | sh

# Using Homebrew
brew install python
brew install git

# Install uv (optional)
curl -LsSf https://astral.sh/uv/install.sh | sh

Standard Installation

The easiest way to install FatPy is from PyPI:

pip install fatpy

This installs the latest stable release with all dependencies.

Development Installation

For contributing or customizing FatPy:

  1. Clone the repository: 

    git clone https://github.com/vybornak2/fatpy.git
cd fatpy

  2. Setup development environment:

# Create and activate virtual environment
uv venv
.venv\Scripts\activate  # On Unix: source .venv/bin/activate

# Install dependencies
uv sync

# Install in development mode
uv pip install -e .

# Setup pre-commit hooks
pre-commit install

The uv package manager is significantly faster than pip and provides better dependency resolution.

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

# Install dependencies
pip install -r requirements.txt
pip install -r requirements-dev.txt

# Install in development mode
pip install -e .

# Setup pre-commit hooks
pre-commit install

The standard pip approach works on all systems with Python installed.

Verifying Installation

Run a simple test to verify the installation:

# Import the library in Python
python -c "import fatpy; print(fatpy.__version__)"

# Run the test suite
pytest -xvs

For more information, see the Contributing Guide.