Installation Guide

From PyPI (Recommended)

pipuv

# Basic installation
pip install logxide

# With Sentry integration
pip install logxide[sentry]

# Basic installation
uv add logxide

# With Sentry integration
uv add logxide[sentry]

Development Setup

For development or building from source:

Prerequisites

1. Install maturin to build the Python package:

pipuv

python -m venv .venv
source .venv/bin/activate
pip install maturin

uv venv
source .venv/bin/activate
uv pip install maturin

Building from Source

# Clone the repository
git clone https://github.com/Indosaram/logxide
cd logxide

pipuv

# Install development dependencies
pip install maturin pytest pytest-cov

# Build in development mode
maturin develop

# Build release version
maturin build --release

# Install development dependencies
uv pip install maturin pytest pytest-cov

# Build in development mode
maturin develop

# Build release version
maturin build --release

Running Tests

pipuv

# Install test dependencies
pip install pytest pytest-cov pytest-xdist

# Run test suite
pytest tests/ -v

# Generate coverage report
pytest tests/ --cov=logxide --cov-report=html

# Install test dependencies
uv pip install pytest pytest-cov pytest-xdist

# Run test suite
pytest tests/ -v

# Generate coverage report
pytest tests/ --cov=logxide --cov-report=html

Compatibility

• Python: 3.12+ (3.14 supported)
• Platforms: macOS, Linux, Windows
• Dependencies: None (Rust compiled into native extension)