Installation¶

From PyPI¶

pip install crxml

Pre-built wheels are published for Linux x86_64, macOS (arm64 + x86_64), and Windows x86_64. The wheel includes the compiled Rust extension so no Rust toolchain is required.

Verify the Rust extension¶

from crxml._crxml_core import CrxmlReader
print("Rust backend OK")

Building from source¶

If no pre-built wheel matches your platform, pip will build from source. This requires the Rust toolchain.

Prerequisites¶

• Python ≥ 3.10
• Rust (stable)

The Rust core depends on rypipe-core via a git dependency on the sibling rypipe repository, so rypipe must be checked out next to crxml (i.e. ../rypipe relative to the crxml root) for pip install . or maturin develop to succeed.

Build the Rust core¶

pip install maturin
maturin build --release   # builds the crate in src/crxml_core/

Or use maturin develop during development:

maturin develop --release

Supported platforms¶