Install

OpenTFRaw ships as a Rust crate and a Python wheel.

Rust

Add the crate to your Cargo.toml:

[dependencies]
opentfraw = "0.1"

Or from the command line:

cargo add opentfraw

OpenTFRaw needs Rust 1.75 or newer. There are no native or system dependencies.

Install the wheel from PyPI:

pip install opentfraw

Pre-built wheels target Python 3.8+ via the stable ABI (abi3).

From source (requires a Rust toolchain and maturin):

git clone https://github.com/Sigilweaver/OpenTFRaw
cd OpenTFRaw/python
maturin develop --release

Rust:

cargo test

Python:

import opentfraw
print(opentfraw.__version__)

The validation corpus is not redistributed. It is pulled on demand from the PRIDE Archive:

python3 scripts/fetch_corpus.py

See CORPUS.md for the file list and provenance.