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. A Rust toolchain via rustup. This repository pins channel 1.88.0 in rust-toolchain.toml, which rustup installs automatically. That is the version the project builds with, not a verified minimum supported version (MSRV).
2. Python 3.12 or newer

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 the package with all development dependencies ([dev] includes
# pytest, pytest-timeout, pytest-cov, ruff, pre-commit, maturin, and more)
pip install -e '.[dev]'

# Build in development mode
maturin develop

# Build release version
maturin build --release

# Install development dependencies
uv pip install -e '.[dev]'

# Build in development mode
maturin develop

# Build release version
maturin build --release

Running Tests

The repo's pytest configuration sets --timeout=60, which requires pytest-timeout; it ships in the [dev] extra, so installing with .[dev] is the supported setup.

pipuv

# Run test suite
pytest tests/ -v

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

# 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)