Install & Compatibility
Where this runs
tested against v3.22 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.910 runs
installs and imports cleanly · install 0.0s · import 0.000s · 38.1MB
glibcpy 3.10–3.910 runs
installs and imports cleanly · install 3.9s · import 0.000s · 39MB
36MB installed
● package 36MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
AcquireBinary
✓ import acquire
✗ from acquire import AcquireBinary
This quickstart demonstrates how to use `acquire` to perform a disk image collection. It initializes the `AcquireBinary` and then uses `DiskCollection` to gather artifacts from a specified image path to an output directory. Note that the example `image_path` is a placeholder and must be replaced with a valid forensic image for the code to run successfully. Live collection (commented out) is also possible but often requires elevated privileges.
import os
from acquire import AcquireBinary, DiskCollection
# --- Configuration ---
# IMPORTANT: Replace '/path/to/your/image.e01' with an actual path to a forensic image file.
# If you don't have one, this example for DiskCollection will fail.
# For a real run, ensure this path exists and is accessible.
image_path = os.environ.get('ACQUIRE_IMAGE_PATH', '/tmp/example_image.e01')
output_dir = os.environ.get('ACQUIRE_OUTPUT_DIR', './acquired_artifacts')
# Ensure the output directory exists
os.makedirs(output_dir, exist_ok=True)
try:
# Initialize AcquireBinary. The 'acquire' C++ executable should be in PATH
# or installed alongside the Python package via pip.
acq_binary = AcquireBinary()
# For disk image acquisition
collection = DiskCollection(
binary=acq_binary,
source_path=image_path,
output_path=output_dir,
collection_id="my-disk-collection",
case_id="my-case"
)
print(f"Starting collection from disk image: {image_path} to {output_dir}")
collection.start()
print("Disk image acquisition complete.")
# For live acquisition, use LiveCollection:
# from acquire import LiveCollection
# live_collection = LiveCollection(binary=acq_binary, output_path=output_dir)
# live_collection.start() # Note: Live collection often requires elevated privileges.
except Exception as e:
print(f"An error occurred: {e}")
print("Please ensure:")
print("1. The 'acquire' C++ binary is installed and in your system's PATH.")
print("2. For DiskCollection, ACQUIRE_IMAGE_PATH points to a valid and accessible image file.")
print("3. The output directory has write permissions.")
Upgrade
Version history
3.22latest on PyPI · released Feb 25, 2026
Audit
Dependencies
pythonrequiredRequires Python 3.10 or newer.
acquire (C++ binary)requiredThe Python library is a wrapper around the core C++ 'acquire' executable, which is typically installed alongside the Python package. The binary must be discoverable in the system's PATH or explicitly provided.