huntzip 0.1.0

huntZip

A lightweight Python module that provides a single, consistent API for compressing and extracting files across multiple archive formats. It automatically determines the appropriate compression method based on the file extension.

Supported Formats

Prerequisites

The script uses built-in Python modules for most formats. Support for .7z archives requires the py7zr package.

pip install py7zr

Usage

Compression (pack)

The pack function handles both single files and directories. It recursively processes directories while preserving the relative internal structure.

from archiver import pack

# Compress a directory to ZIP
pack(source_path="data/my_folder", archive_name="backup.zip")

# Compress a directory to 7z
pack(source_path="data/my_folder", archive_name="archive.7z")

# Compress a single file to TAR.GZ
pack(source_path="data/document.pdf", archive_name="document.tar.gz")

Extraction (unpack)

The unpack function automatically detects the archive format and extracts its contents to the target directory. If the destination directory does not exist, it will be created.

from archiver import unpack

# Extract to the current directory
unpack(archive_path="backup.zip")

# Extract to a specific directory
unpack(archive_path="archive.7z", extract_to="extracted_data")

# Extract a compressed TAR archive
unpack(archive_path="document.tar.gz", extract_to="output/docs")

Error Handling

• FileNotFoundError: Raised if the source path for archiving or the target archive for extraction does not exist.
• ValueError: Raised if the file extension is missing or not supported by the module.