getarcx 0.1.0

Python bindings for the ARCX archive format — fast selective extraction

arcx

Python bindings for the ARCX archive format. Native Rust speed via PyO3.

Install

pip install arcx

Build from source

Requires Rust toolchain and maturin:

pip install maturin
maturin develop --release

Usage

Pack a directory

import arcx

arcx.pack("my_project/", "my_project.arcx")

Get a single file

data = arcx.get("archive.arcx", "src/main.rs")
print(len(data), "bytes")

List files

files = arcx.list("archive.arcx")
for f in files:
    print(f["path"], f["size"], f["sha256"])

Extract all files

arcx.extract("archive.arcx", "output_dir/")

Archive info

info = arcx.info("archive.arcx")
print(f"{info['files']} files, {info['blocks']} blocks, ratio={info['ratio']:.1%}")

Archive class (context manager)

For multiple operations on the same archive, use the Archive class to keep the manifest cached in memory:

with arcx.Archive("archive.arcx") as ar:
    data = ar.get("src/main.rs")
    files = ar.list()
    ar.extract("output/")
    info = ar.info()

API Reference

Functions

Function	Description
arcx.pack(input_dir, output)	Pack a directory into an .arcx archive
arcx.get(archive, file_path) -> bytes	Extract a single file as bytes
arcx.list(archive) -> list[dict]	List files (each dict has path, size, sha256)
arcx.extract(archive, output_dir)	Extract all files to a directory
arcx.info(archive) -> dict	Archive metadata (files, blocks, chunks, ratio, etc.)

Archive class

Method	Description
Archive(path)	Open an archive (use as context manager)
.get(file_path) -> bytes	Extract a single file
.list() -> list[dict]	List all files
.extract(output_dir)	Extract all files
.info() -> dict	Archive metadata

License

MIT