safelz4 0.0.1.dev0

safe LZ4 data compress library.

Rust binding into python of the lz4 library lz4_flex The Fastest LZ4 implementation in Rust.

Installation

Pip

You can install safelz4 via the pip manager:

pip install safelz4

From source

For the sources, you need Rust

# Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
# Make sure it's up to date and using stable channel
rustup update
git clone https://github.com/LVivona/safelz4
cd safelz4
pip install setuptools_rust
# install
pip install -e .

Getting Started

Frame Format

from safelz4 import compress_file, open_frame

buffer = None
with open("dickens.txt", "r") as file:
    buffer = file.read(-1).encode("utf-8")

compress_file("dickens.lz4", buffer)

output = None
with open_frame("dickens.lz4") as f:
   output = f.decompress()

Block Format

from safelz4.block import compress_prepend_size, 

buffer = None
with open("dickens.txt", "r") as file:
    input_b = file.read(-1).encode("utf-8")
    buffer = compress_prepend_size(input_b)

output = decompress_size_prepended(buffer)

Overview