ubi-reader

library0.8.13pypypiunverified

A Python library to extract files from UBI (Unsorted Block Images) and UBIFS (UBI File System) images. Supports UBI headers, volumes, and UBIFS nodes. Latest version 0.8.13 (requires Python >=3.10). Released about once every few months.

data devops

pip install ubi-reader

package ↗

INSTALL

IMPORT

SIG · UBI-READER

ubi-reader

datapythonv0.8.13

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

UBI

✓ from ubireader import UBI

✗ from ubireader import UBI

Load a UBI image and extract UBIFS volume contents to a directory.

from ubireader import UBI from ubireader.ubifs import extract_files from ubireader.ubifs.output import extract_common with open('image.ubi', 'rb') as f: ubi = UBI(f) for volume in ubi.volumes: if volume.type == 'UBIFS': extract_files(volume, 'output_dir')

ubireader --version

Debug

Known issues

gotchaThe library does not handle UBI images with encryption or compression other than LZO (if supported by construct). Ensure image is raw or LZO compressed.

fix

Pre-decompress the image if using other algorithms.

affects: all

gotchaextract_files expects a volume object, not the whole UBI object. Common mistake: passing the UBI object directly.

fix

Iterate over ubi.volumes and pass each volume of type 'UBIFS' to extract_files.

affects: all

deprecatedThe old API ubireader.UBI.extract_all() is deprecated in favor of per-volume extraction.

fix

Use extract_files from ubireader.ubifs for UBIFS volumes.

affects: <0.8.0

gotchaThe library only reads UBI images, not UBIFS images directly. To handle a standalone UBIFS image, you must wrap it in a minimal UBI structure or use an alternative.

fix

Use ubireader.ubifs only for UBIFS volumes inside UBI images.

affects: all

Upgrade

Version history

0.8.13latest on PyPI · released Feb 20, 2026

Audit

Dependencies

constructrequiredBinary data parsing library used for UBI/UBIFS structures.

Agent activity

24 hits · last 30 days

node

OpenAI (training)

Resources

packagehttps://pypi.org/project/ubi-reader/ ↗