Compressed RTF

Warnings

• gotcha This library implements the specific Microsoft Rich Text Format (RTF) Compression Algorithm (LZFu) outlined in MS-OXRTFCP. It is not a general-purpose compression library and should not be confused with standard Python compression modules like `zlib` or `gzip`.
  Fix: Ensure that the RTF data you are processing conforms to the LZFu compression scheme used by Microsoft products. For general compression, consider Python's built-in `zlib` or `gzip` modules.
• gotcha Version 1.0.7 resolved a circular import issue in `setup.py` (Pull Request #19) that could affect packaging and installation in certain environments. While not a direct API breaking change, users on older versions (<=1.0.6) might encounter installation or build issues.
  Fix: Upgrade to version 1.0.7 or later to benefit from packaging stability fixes: `pip install --upgrade compressed-rtf`.

Install

• pip install compressed-rtf Install latest version

Imports

• compress

  from compressed_rtf import compress

  Used to compress RTF byte data.
• decompress

  from compressed_rtf import decompress

  Used to decompress RTF byte data.

Quickstart

Demonstrates how to compress and decompress RTF byte data using the `compress` and `decompress` functions.

from compressed_rtf import compress, decompress

# Example RTF data (must be bytes)
rtf_data = b'{\rtf1\ansi\ansicpg1252\deff0\nouicompat\deflang1033{\fonttbl{\f0\fnil\fcharset0 Calibri;}{\f1\fnil\fcharset2 Symbol;}}
{\pard\sa200\sl276\slmult1\f0\fs22\lang9 This is some \b compressed\b0  RTF data.\par}
}
'

# Compress the data
compressed_bytes = compress(rtf_data)
print(f"Original size: {len(rtf_data)} bytes")
print(f"Compressed size: {len(compressed_bytes)} bytes")

# Decompress the data
decompressed_bytes = decompress(compressed_bytes)

# Verify decompression
assert decompressed_bytes == rtf_data
print("Decompression successful!")
print(f"Decompressed content: {decompressed_bytes.decode('ascii', errors='ignore')[:50]}...")