Skip to content

Latest commit

 

History

History
41 lines (33 loc) · 1.32 KB

README.md

File metadata and controls

41 lines (33 loc) · 1.32 KB
Raw

apple-compress

Python bindings for Apple's libcompression.

Based on bindings from Asahi Linux.

Requirements

  • Python 3.8 or higher
  • An *OS system

Usage

Library

Read the API usage.

CLI

Usage: acompress [OPTIONS]

  A Python CLI tool for compression using Apple's libcompression.

Options:
  --version              Show the version and exit.
  -i, --input FILENAME   Input file.  [required]
  -o, --output FILENAME  Output file.  [required]
  -c, --compress         Compress the data.
  -d, --decompress       Decompress the data.
  -l, --lzfse            LZFSE compress the data.
  -b, --lzfse-iboot      LZFSE compress the data (iBoot compatible).
  -z, --zlib             zlib compress the data.
  -v, --verbose          Increase verbosity.
  -h, --help             Show this message and exit.

Installation

  • Install from PyPI:
    • python3 -m pip install apple-compress
  • Local installation:
    • ./install.sh
    • Requires Poetry

Support

For any questions/issues you have, open an issue.